foliolib.folio.api.sourceRecordManager.MappingRulesProvider

class foliolib.folio.api.sourceRecordManager.MappingRulesProvider(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Mapping rules Provider API

API for accessing mapping rules

Parameters

• tenant (str) – Tenant id

• okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

get_mappingRule(recordType)	GET /mapping-rules/{recordType}
modify_mappingRule(recordType, mappingRule)	PUT /mapping-rules/{recordType}
modify_restore(recordType)	PUT /mapping-rules/{recordType}/restore

get_mappingRule(recordType: str)

GET /mapping-rules/{recordType}

Parameters

recordType (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

string

modify_mappingRule(recordType: str, mappingRule: dict)

PUT /mapping-rules/{recordType}

Parameters

• recordType (str) –

• mappingRule (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

string

modify_restore(recordType: str)

PUT /mapping-rules/{recordType}/restore

Parameters

recordType (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

string