foliolib.folio.api.sourceRecordManager.MappingMetadataProvider

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

Bases: foliolib.folio.FolioApi

Mapping Metadata Provider API

API for accessing mapping rules and mapping parameters

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`get_mappingMetadatum`(recordType)	`GET /mapping-metadata/type/{recordType}`
`get_mappingMetadatum_for_jobExecution`(...)	`GET /mapping-metadata/{jobExecutionId}`

get_mappingMetadatum(recordType: str)

GET /mapping-metadata/type/{recordType}

Parameters

recordType (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Mapping Metadata DTO, contains Mapping rules and Mapping parameters",
  "type": "object",
  "properties": {
    "jobExecutionId": {
      "type": "string",
      "description": "UUID of the JobExecution"
    },
    "mappingRules": {
      "type": "string",
      "description": "Mapping rules in encoded json format"
    },
    "mappingParams": {
      "type": "string",
      "description": "Mapping parameters in encoded json format"
    }
  },
  "additionalProperties": false,
  "required": [
    "jobExecutionId",
    "mappingRules",
    "mappingParams"
  ]
}

get_mappingMetadatum_for_jobExecution(jobExecutionId: str)

GET /mapping-metadata/{jobExecutionId}

Parameters

jobExecutionId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Mapping Metadata DTO, contains Mapping rules and Mapping parameters",
  "type": "object",
  "properties": {
    "jobExecutionId": {
      "type": "string",
      "description": "UUID of the JobExecution"
    },
    "mappingRules": {
      "type": "string",
      "description": "Mapping rules in encoded json format"
    },
    "mappingParams": {
      "type": "string",
      "description": "Mapping parameters in encoded json format"
    }
  },
  "additionalProperties": false,
  "required": [
    "jobExecutionId",
    "mappingRules",
    "mappingParams"
  ]
}