foliolib.folio.api.dataImportConverterStorage.DataImportConverterStorage

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

Bases: foliolib.folio.FolioApi

Data Import Converter Storage API

API for managing data import profiles

Parameters

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

Methods

`delete_actionProfile`(actionProfilesId)	Delete actionProfile item with given {actionProfileId}
`delete_jobProfile`(jobProfilesId)	Delete jobProfile item with given {jobProfileId}
`delete_mappingProfile`(mappingProfilesId)	Delete mappingProfile item with given {mappingProfileId}
`delete_matchProfile`(matchProfilesId)	Delete matchProfile item with given {matchProfileId}
`delete_profileAssociation`(profileAssociationsId)	Delete profileAssociation item with given {profileAssociationId}
`get_actionProfile`(actionProfilesId)	Retrieve actionProfile item with given {actionProfileId}
`get_actionProfiles`(**kwargs)	Retrieve a list of actionProfile items.
`get_details_by_profileAssociation`(...)	`GET /data-import-profiles/profileAssociations/{profileAssociationsId}/details`
`get_entityTypes`()	Get a list of entity types
`get_jobProfile`(jobProfilesId)	Retrieve jobProfile item with given {jobProfileId}
`get_jobProfileSnapshot`(jobProfileSnapshotsId)	Method to get Job Profile Snapshot by id
`get_jobProfiles`(**kwargs)	Retrieve a list of jobProfile items.
`get_mappingProfile`(mappingProfilesId)	Retrieve mappingProfile item with given {mappingProfileId}
`get_mappingProfiles`(**kwargs)	Retrieve a list of mappingProfile items.
`get_masters_by_profileAssociation`(...)	`GET /data-import-profiles/profileAssociations/{profileAssociationsId}/masters`
`get_matchProfile`(matchProfilesId)	Retrieve matchProfile item with given {matchProfileId}
`get_matchProfiles`(**kwargs)	Retrieve a list of matchProfile items.
`get_profileAssociation`(profileAssociationsId)	Retrieve profileAssociation item with given {profileAssociationId}
`get_profileAssociations`()	Retrieve a list of profileAssociation items.
`get_profileSnapshot`(profileId, **kwargs)	Get a profile snapshot structure for specified profile id and type.
`modify_actionProfile`(actionProfilesId, ...)	Update actionProfile item with given {actionProfileId}
`modify_jobProfile`(jobProfilesId, jobProfile)	Update jobProfile item with given {jobProfileId}
`modify_mappingProfile`(mappingProfilesId, ...)	Update mappingProfile item with given {mappingProfileId}
`modify_matchProfile`(matchProfilesId, ...)	Update matchProfile item with given {matchProfileId}
`modify_profileAssociation`(...)	Update profileAssociation item with given {profileAssociationId}
`set_actionProfile`(actionProfile)	Create a new actionProfile item.
`set_jobProfile`(jobProfile)	Create a new jobProfile item.
`set_jobProfileSnapshot`(jobProfileSnapshotsId)	Method to create Job Profile Snapshot by Job Profile id
`set_mappingProfile`(mappingProfile)	Create a new mappingProfile item.
`set_matchProfile`(matchProfile)	Create a new matchProfile item.
`set_profileAssociation`(profileAssociation)	Create a new profileAssociation item.

delete_actionProfile(actionProfilesId: str)

Delete actionProfile item with given {actionProfileId}

DELETE /data-import-profiles/actionProfiles/{actionProfilesId}

Parameters

actionProfilesId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestConflict – Conflict

delete_jobProfile(jobProfilesId: str)

Delete jobProfile item with given {jobProfileId}

DELETE /data-import-profiles/jobProfiles/{jobProfilesId}

Parameters

jobProfilesId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestConflict – Conflict

delete_mappingProfile(mappingProfilesId: str)

Delete mappingProfile item with given {mappingProfileId}

DELETE /data-import-profiles/mappingProfiles/{mappingProfilesId}

Parameters

mappingProfilesId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestConflict – Conflict

delete_matchProfile(matchProfilesId: str)

Delete matchProfile item with given {matchProfileId}

DELETE /data-import-profiles/matchProfiles/{matchProfilesId}

Parameters

matchProfilesId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestConflict – Conflict

delete_profileAssociation(profileAssociationsId: str)

Delete profileAssociation item with given {profileAssociationId}

DELETE /data-import-profiles/profileAssociations/{profileAssociationsId}

Parameters

profileAssociationsId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestConflict – Conflict

get_actionProfile(actionProfilesId: str)

Retrieve actionProfile item with given {actionProfileId}

GET /data-import-profiles/actionProfiles/{actionProfilesId}

Parameters

actionProfilesId (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": "Action Profile schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "name": {
      "description": "Action Profile name",
      "type": "string"
    },
    "description": {
      "description": "Action Profile description",
      "type": "string"
    },
    "tags": {
      "description": "Set of tags assigned to the current Action Profile",
      "type": "object",
      "$ref": "../../raml-util/schemas/tags.schema"
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON-MATCH"
      ]
    },
    "action": {
      "description": "Action type. CREATE allowed for all record types. UPDATE allowed for all record types except Orders, Invoices. DELETE allowed for all records types. MODIFY allowed for MARC records only",
      "type": "string",
      "enum": [
        "CREATE",
        "UPDATE",
        "DELETE",
        "MODIFY"
      ]
    },
    "folioRecord": {
      "description": "Record type",
      "type": "string",
      "enum": [
        "INSTANCE",
        "HOLDINGS",
        "AUTHORITY",
        "ITEM",
        "ORDER",
        "INVOICE",
        "MARC_BIBLIOGRAPHIC",
        "MARC_HOLDINGS",
        "MARC_AUTHORITY"
      ]
    },
    "deleted": {
      "description": "Flag indicates that the Action Profile marked as deleted",
      "type": "boolean",
      "default": false
    },
    "userInfo": {
      "description": "First name, last name and username of the user, who updated the Action Profile",
      "type": "object",
      "$ref": "../common/userInfo.json"
    },
    "parentProfiles": {
      "description": "Associated parent profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "childProfiles": {
      "description": "Associated children profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "hidden": {
      "description": "Flag indicates that the Action Profile will be hidden on UI",
      "type": "boolean",
      "default": false
    },
    "remove9Subfields": {
      "description": "Flag indicates that 9 subfield should be removed from all linkable MARC bib fields for Action Profile",
      "type": "boolean",
      "default": false
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "action",
    "folioRecord"
  ]
}

get_actionProfiles(**kwargs)

Retrieve a list of actionProfile items.

GET /data-import-profiles/actionProfiles

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

with valid searchable fields: for example userInfo.lastName=Doe

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- userInfo.lastName=Doe
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of Action Profiles",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "actionProfiles": {
      "description": "List of Action Profiles",
      "type": "array",
      "id": "actionProfileList",
      "items": {
        "type": "object",
        "$ref": "actionProfile.json"
      }
    },
    "totalRecords": {
      "description": "Total number of Action Profiles",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "actionProfiles",
    "totalRecords"
  ]
}

get_details_by_profileAssociation(profileAssociationsId: str, **kwargs)

GET /data-import-profiles/profileAssociations/{profileAssociationsId}/details

Parameters

profileAssociationsId (str) –
**kwargs (properties) – Keyword Arguments

Keyword Arguments

masterType (str) –
It needs to identify master profile type for an id

Example
- JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE
detailType (str) –
It filters returned type of details. For example you need to get only MATCH_PROFILEs for a JOB_PROFILE but the JOB_PROFILE has ACTION_PROFILEs too. So use it as filter for a return type

Example
- ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

with valid searchable fields: for example userInfo.lastName=Doe

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- userInfo.lastName=Doe
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "This schema describes Job Profile snapshot entity",
  "javaType": "org.folio.rest.jaxrs.model.ProfileSnapshotWrapper",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Snapshot wrapper unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profileId": {
      "description": "Profile unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "contentType": {
      "description": "Type of the content",
      "type": "string",
      "$ref": "profileSnapshotType.json"
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON_MATCH"
      ]
    },
    "content": {
      "description": "Profile content (plain Object)"
    },
    "order": {
      "description": "The execution order of the 'detail' profile. Job, Action and Matching profiles have an execution order, but this field is always 0 for Mapping profiles because of o2o relationship",
      "type": "integer",
      "default": 0
    },
    "childSnapshotWrappers": {
      "description": "Set of children profile snapshots",
      "type": "array",
      "items": {
        "$ref": "profileSnapshotWrapper.json"
      }
    }
  },
  "required": [
    "contentType",
    "content"
  ],
  "excludedFromEqualsAndHashCode": [
    "content"
  ]
}

get_entityTypes()

Get a list of entity types

GET /data-import-profiles/entityTypes

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of entity types",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "entityTypes": {
      "description": "Set of entity types",
      "type": "array",
      "id": "entityTypeList",
      "items": {
        "type": "string"
      }
    },
    "totalRecords": {
      "description": "Total number of entity types",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "entityTypes",
    "totalRecords"
  ]
}

get_jobProfile(jobProfilesId: str)

Retrieve jobProfile item with given {jobProfileId}

GET /data-import-profiles/jobProfiles/{jobProfilesId}

Parameters

jobProfilesId (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": "Job Profile schema",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "name": {
      "description": "Job Profile name",
      "type": "string"
    },
    "description": {
      "description": "Job Profile description",
      "type": "string"
    },
    "dataType": {
      "description": "Data type",
      "type": "string",
      "$ref": "../common/dataType.json"
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON-MATCH"
      ]
    },
    "tags": {
      "description": "Set of tags assigned to the current Job Profile",
      "type": "object",
      "$ref": "../../raml-util/schemas/tags.schema"
    },
    "deleted": {
      "description": "Flag indicates that the Job Profile marked as deleted",
      "type": "boolean",
      "default": false
    },
    "userInfo": {
      "description": "First name, last name and username of the user, who updated the Job Profile",
      "type": "object",
      "$ref": "../common/userInfo.json"
    },
    "parentProfiles": {
      "description": "Associated parent profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "childProfiles": {
      "description": "Associated children profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "hidden": {
      "description": "Flag indicates that the Job Profile will be hidden on UI",
      "type": "boolean",
      "default": false
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "dataType"
  ]
}

get_jobProfileSnapshot(jobProfileSnapshotsId: str)

Method to get Job Profile Snapshot by id

GET /data-import-profiles/jobProfileSnapshots/{jobProfileSnapshotsId}

Parameters: jobProfileSnapshotsId (str) –
Returns: See Schema below
Return type: dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "This schema describes Job Profile snapshot entity",
  "javaType": "org.folio.rest.jaxrs.model.ProfileSnapshotWrapper",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Snapshot wrapper unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profileId": {
      "description": "Profile unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "contentType": {
      "description": "Type of the content",
      "type": "string",
      "$ref": "profileSnapshotType.json"
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON_MATCH"
      ]
    },
    "content": {
      "description": "Profile content (plain Object)"
    },
    "order": {
      "description": "The execution order of the 'detail' profile. Job, Action and Matching profiles have an execution order, but this field is always 0 for Mapping profiles because of o2o relationship",
      "type": "integer",
      "default": 0
    },
    "childSnapshotWrappers": {
      "description": "Set of children profile snapshots",
      "type": "array",
      "items": {
        "$ref": "profileSnapshotWrapper.json"
      }
    }
  },
  "required": [
    "contentType",
    "content"
  ],
  "excludedFromEqualsAndHashCode": [
    "content"
  ]
}

get_jobProfiles(**kwargs)

Retrieve a list of jobProfile items.

GET /data-import-profiles/jobProfiles

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

with valid searchable fields: for example userInfo.lastName=Doe

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- userInfo.lastName=Doe
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of Job Profiles",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "jobProfiles": {
      "description": "List of Job Profiles",
      "type": "array",
      "id": "jobProfileList",
      "items": {
        "type": "object",
        "$ref": "jobProfile.json"
      }
    },
    "totalRecords": {
      "description": "Total number of Job Profiles",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "jobProfiles",
    "totalRecords"
  ]
}

get_mappingProfile(mappingProfilesId: str)

Retrieve mappingProfile item with given {mappingProfileId}

GET /data-import-profiles/mappingProfiles/{mappingProfilesId}

Parameters

mappingProfilesId (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 Profile schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "name": {
      "description": "Mapping Profile name",
      "type": "string"
    },
    "description": {
      "description": "Mapping Profile description",
      "type": "string"
    },
    "tags": {
      "description": "Set of tags assigned to the current Mapping Profile",
      "type": "object",
      "$ref": "../../raml-util/schemas/tags.schema"
    },
    "incomingRecordType": {
      "description": "Incoming record type",
      "type": "string",
      "$ref": "./entityType.json"
    },
    "existingRecordType": {
      "description": "FOLIO record type to mapping",
      "type": "string",
      "$ref": "./entityType.json"
    },
    "deleted": {
      "description": "Flag indicates that the Mapping Profile marked as deleted",
      "type": "boolean",
      "default": false
    },
    "userInfo": {
      "description": "First name, last name and username of the user, who updated the Mapping Profile",
      "type": "object",
      "$ref": "../common/userInfo.json"
    },
    "marcFieldProtectionSettings": {
      "description": "MARC field protection settings",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.MarcFieldProtectionSetting>",
      "items": {
        "type": "object",
        "$ref": "marc-field-protection/marcFieldProtectionSetting.json"
      }
    },
    "parentProfiles": {
      "description": "Associated parent profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "childProfiles": {
      "description": "Associated children profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "mappingDetails": {
      "description": "Mapping details with mapping rules",
      "$ref": "mapping-profile-detail/mappingDetail.json"
    },
    "hidden": {
      "description": "Flag indicates that the Mapping Profile will be hidden on UI",
      "type": "boolean",
      "default": false
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "incomingRecordType"
  ]
}

get_mappingProfiles(**kwargs)

Retrieve a list of mappingProfile items.

GET /data-import-profiles/mappingProfiles

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

with valid searchable fields: for example userInfo.lastName=Doe

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- userInfo.lastName=Doe
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of Mapping Profiles",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mappingProfiles": {
      "description": "List of Mapping Profiles",
      "type": "array",
      "id": "mappingProfileList",
      "items": {
        "type": "object",
        "$ref": "mappingProfile.json"
      }
    },
    "totalRecords": {
      "description": "Total number of Mapping Profiles",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "mappingProfiles",
    "totalRecords"
  ]
}

get_masters_by_profileAssociation(profileAssociationsId: str, **kwargs)

GET /data-import-profiles/profileAssociations/{profileAssociationsId}/masters

Parameters

profileAssociationsId (str) –
**kwargs (properties) – Keyword Arguments

Keyword Arguments

detailType (str) –
Type of detail profile

Example
- JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE
masterType (str) –
It filters returned type of masters. For example you need to get only JOB_PROFILEs for a MATCH_PROFILE but the MATCH_PROFILE has ACTION_PROFILEs too. So use it as filter for a return type

Example
- JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

with valid searchable fields: for example userInfo.lastName=Doe

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- userInfo.lastName=Doe
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "This schema describes Job Profile snapshot entity",
  "javaType": "org.folio.rest.jaxrs.model.ProfileSnapshotWrapper",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Snapshot wrapper unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profileId": {
      "description": "Profile unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "contentType": {
      "description": "Type of the content",
      "type": "string",
      "$ref": "profileSnapshotType.json"
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON_MATCH"
      ]
    },
    "content": {
      "description": "Profile content (plain Object)"
    },
    "order": {
      "description": "The execution order of the 'detail' profile. Job, Action and Matching profiles have an execution order, but this field is always 0 for Mapping profiles because of o2o relationship",
      "type": "integer",
      "default": 0
    },
    "childSnapshotWrappers": {
      "description": "Set of children profile snapshots",
      "type": "array",
      "items": {
        "$ref": "profileSnapshotWrapper.json"
      }
    }
  },
  "required": [
    "contentType",
    "content"
  ],
  "excludedFromEqualsAndHashCode": [
    "content"
  ]
}

get_matchProfile(matchProfilesId: str)

Retrieve matchProfile item with given {matchProfileId}

GET /data-import-profiles/matchProfiles/{matchProfilesId}

Parameters

matchProfilesId (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": "Match Profile schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "name": {
      "description": "Match Profile name",
      "type": "string"
    },
    "description": {
      "description": "Match Profile description",
      "type": "string"
    },
    "tags": {
      "description": "Set of tags assigned to the current Match Profile",
      "type": "object",
      "$ref": "../../raml-util/schemas/tags.schema"
    },
    "incomingRecordType": {
      "description": "Incoming record type",
      "type": "string",
      "$ref": "entityType.json"
    },
    "existingRecordType": {
      "description": "Existing record type to match",
      "type": "string",
      "$ref": "entityType.json"
    },
    "matchDetails": {
      "description": "Match profile details list",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "match-profile-detail/matchDetail.json"
      }
    },
    "deleted": {
      "description": "Flag indicates that the Match Profile marked as deleted",
      "type": "boolean",
      "default": false
    },
    "userInfo": {
      "description": "First name, last name and username of the user, who updated the Match Profile",
      "type": "object",
      "$ref": "../common/userInfo.json"
    },
    "parentProfiles": {
      "description": "Associated parent profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "childProfiles": {
      "description": "Associated children profiles. Not required field that uses only for batch update/create",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileSnapshotWrapper>",
      "items": {
        "type": "object",
        "$ref": "./profileSnapshotWrapper.json"
      }
    },
    "hidden": {
      "description": "Flag indicates that the Match Profile will be hidden on UI",
      "type": "boolean",
      "default": false
    },
    "metadata": {
      "description": "Metadata provided by the server",
      "type": "object",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name",
    "incomingRecordType",
    "existingRecordType"
  ]
}

get_matchProfiles(**kwargs)

Retrieve a list of matchProfile items.

GET /data-import-profiles/matchProfiles

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

with valid searchable fields: for example userInfo.lastName=Doe

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- userInfo.lastName=Doe
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of Match Profiles",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "matchProfiles": {
      "description": "List of Match Profiles",
      "type": "array",
      "id": "matchProfileList",
      "items": {
        "type": "object",
        "$ref": "matchProfile.json"
      }
    },
    "totalRecords": {
      "description": "Total number of Match Profiles",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "matchProfiles",
    "totalRecords"
  ]
}

get_profileAssociation(profileAssociationsId: str)

Retrieve profileAssociation item with given {profileAssociationId}

GET /data-import-profiles/profileAssociations/{profileAssociationsId}

Parameters

profileAssociationsId (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": "This schema represents m2m association between profiles. One kind of 'master' profiles can be associated to another kind of 'detail' profiles",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "masterProfileId": {
      "description": "Unique identifier of the 'master' profile",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "detailProfileId": {
      "description": "Unique identifier of the 'detail' profile",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "order": {
      "description": "The execution order of the 'detail' profile. Job, Action and Matching profiles have an execution order, but this field is always 0 for Mapping profiles because of o2o relationship",
      "type": "integer",
      "default": 0
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON_MATCH"
      ]
    },
    "triggered": {
      "description": "Boolean flag identifies if the 'detail' profile has triggered by the 'master' profile",
      "type": "boolean",
      "default": false
    },
    "masterProfileType": {
      "description": "Type of master profile",
      "type": "string",
      "enum": [
        "ACTION_PROFILE",
        "MAPPING_PROFILE",
        "MATCH_PROFILE",
        "JOB_PROFILE"
      ]
    },
    "detailProfileType": {
      "description": "Type of master profile",
      "type": "string",
      "enum": [
        "ACTION_PROFILE",
        "MAPPING_PROFILE",
        "MATCH_PROFILE",
        "JOB_PROFILE"
      ]
    },
    "jobProfileId": {
      "description": "Unique identifier of the job profile, it is used to distinguish associations when building a snapshot tree for particular job profile",
      "$ref": "../../raml-util/schemas/uuid.schema"
    }
  },
  "required": [
    "masterProfileId",
    "detailProfileId",
    "order"
  ]
}

get_profileAssociations()

Retrieve a list of profileAssociation items.

GET /data-import-profiles/profileAssociations

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of Profile associations",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "profileAssociations": {
      "description": "List of Profile associations",
      "type": "array",
      "id": "profileAssociationList",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "totalRecords": {
      "description": "Total number of Profile associations",
      "type": "integer"
    }
  },
  "excludedFromEqualsAndHashCode": [
    "totalRecords"
  ],
  "required": [
    "profileAssociations",
    "totalRecords"
  ]
}

get_profileSnapshot(profileId: str, **kwargs)

Get a profile snapshot structure for specified profile id and type. Acceptable profileType values are JOB_PROFILE, ACTION_PROFILE, MATCH_PROFILE, MAPPING_PROFILE.

GET /data-import-profiles/profileSnapshots/{profileId}

Parameters

profileId (str) –
**kwargs (properties) – Keyword Arguments

Keyword Arguments

profileType (str) –
Indicates profile type

Example
- JOB_PROFILE
jobProfileId (str) – Indicates job profile id, should be specified when {profileType} parameter has value JOB_PROFILE or MATCH_PROFILE

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "This schema describes Job Profile snapshot entity",
  "javaType": "org.folio.rest.jaxrs.model.ProfileSnapshotWrapper",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Snapshot wrapper unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profileId": {
      "description": "Profile unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "contentType": {
      "description": "Type of the content",
      "type": "string",
      "$ref": "profileSnapshotType.json"
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON_MATCH"
      ]
    },
    "content": {
      "description": "Profile content (plain Object)"
    },
    "order": {
      "description": "The execution order of the 'detail' profile. Job, Action and Matching profiles have an execution order, but this field is always 0 for Mapping profiles because of o2o relationship",
      "type": "integer",
      "default": 0
    },
    "childSnapshotWrappers": {
      "description": "Set of children profile snapshots",
      "type": "array",
      "items": {
        "$ref": "profileSnapshotWrapper.json"
      }
    }
  },
  "required": [
    "contentType",
    "content"
  ],
  "excludedFromEqualsAndHashCode": [
    "content"
  ]
}

modify_actionProfile(actionProfilesId: str, actionProfile: dict)

Update actionProfile item with given {actionProfileId}

PUT /data-import-profiles/actionProfiles/{actionProfilesId}

Parameters

actionProfilesId (str) –
actionProfile (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Action Profile object",
      "javaType": "org.folio.rest.jaxrs.model.ActionProfile"
    },
    "addedRelations": {
      "description": "Action profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Action profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

modify_jobProfile(jobProfilesId: str, jobProfile: dict)

Update jobProfile item with given {jobProfileId}

PUT /data-import-profiles/jobProfiles/{jobProfilesId}

Parameters

jobProfilesId (str) –
jobProfile (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Job Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Job Profile object",
      "javaType": "org.folio.rest.jaxrs.model.JobProfile"
    },
    "addedRelations": {
      "description": "Job profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Job profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

modify_mappingProfile(mappingProfilesId: str, mappingProfile: dict)

Update mappingProfile item with given {mappingProfileId}

PUT /data-import-profiles/mappingProfiles/{mappingProfilesId}

Parameters

mappingProfilesId (str) –
mappingProfile (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Mapping Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Mapping Profile object",
      "javaType": "org.folio.rest.jaxrs.model.MappingProfile"
    },
    "addedRelations": {
      "description": "Mapping profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Mapping profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

modify_matchProfile(matchProfilesId: str, matchProfile: dict)

Update matchProfile item with given {matchProfileId}

PUT /data-import-profiles/matchProfiles/{matchProfilesId}

Parameters

matchProfilesId (str) –
matchProfile (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Match Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Match Profile object",
      "javaType": "org.folio.rest.jaxrs.model.MatchProfile"
    },
    "addedRelations": {
      "description": "Match profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Match profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

modify_profileAssociation(profileAssociationsId: str, profileAssociation: dict)

Update profileAssociation item with given {profileAssociationId}

PUT /data-import-profiles/profileAssociations/{profileAssociationsId}

Parameters

profileAssociationsId (str) –
profileAssociation (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Action Profile object",
      "javaType": "org.folio.rest.jaxrs.model.ActionProfile"
    },
    "addedRelations": {
      "description": "Action profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Action profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

set_actionProfile(actionProfile: dict)

Create a new actionProfile item.

POST /data-import-profiles/actionProfiles

Parameters

actionProfile (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created actionProfile item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Action Profile object",
      "javaType": "org.folio.rest.jaxrs.model.ActionProfile"
    },
    "addedRelations": {
      "description": "Action profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Action profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

set_jobProfile(jobProfile: dict)

Create a new jobProfile item.

POST /data-import-profiles/jobProfiles

Parameters

jobProfile (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created jobProfile item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Job Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Job Profile object",
      "javaType": "org.folio.rest.jaxrs.model.JobProfile"
    },
    "addedRelations": {
      "description": "Job profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Job profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

set_jobProfileSnapshot(jobProfileSnapshotsId: str)

Method to create Job Profile Snapshot by Job Profile id

POST /data-import-profiles/jobProfileSnapshots/{jobProfileSnapshotsId}

Parameters

jobProfileSnapshotsId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "This schema describes Job Profile snapshot entity",
  "javaType": "org.folio.rest.jaxrs.model.ProfileSnapshotWrapper",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Snapshot wrapper unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profileId": {
      "description": "Profile unique identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "contentType": {
      "description": "Type of the content",
      "type": "string",
      "$ref": "profileSnapshotType.json"
    },
    "reactTo": {
      "description": "Non-match also used when there is no match profile in the job",
      "type": "string",
      "enum": [
        "MATCH",
        "NON_MATCH"
      ]
    },
    "content": {
      "description": "Profile content (plain Object)"
    },
    "order": {
      "description": "The execution order of the 'detail' profile. Job, Action and Matching profiles have an execution order, but this field is always 0 for Mapping profiles because of o2o relationship",
      "type": "integer",
      "default": 0
    },
    "childSnapshotWrappers": {
      "description": "Set of children profile snapshots",
      "type": "array",
      "items": {
        "$ref": "profileSnapshotWrapper.json"
      }
    }
  },
  "required": [
    "contentType",
    "content"
  ],
  "excludedFromEqualsAndHashCode": [
    "content"
  ]
}

set_mappingProfile(mappingProfile: dict)

Create a new mappingProfile item.

POST /data-import-profiles/mappingProfiles

Parameters

mappingProfile (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created mappingProfile item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Mapping Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Mapping Profile object",
      "javaType": "org.folio.rest.jaxrs.model.MappingProfile"
    },
    "addedRelations": {
      "description": "Mapping profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Mapping profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

set_matchProfile(matchProfile: dict)

Create a new matchProfile item.

POST /data-import-profiles/matchProfiles

Parameters

matchProfile (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created matchProfile item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Match Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Match Profile object",
      "javaType": "org.folio.rest.jaxrs.model.MatchProfile"
    },
    "addedRelations": {
      "description": "Match profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Match profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}

set_profileAssociation(profileAssociation: dict)

Create a new profileAssociation item.

POST /data-import-profiles/profileAssociations

Parameters

profileAssociation (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created profileAssociation item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action Profile Update/Create schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Profile identifier",
      "$ref": "../../raml-util/schemas/uuid.schema"
    },
    "profile": {
      "description": "Action Profile object",
      "javaType": "org.folio.rest.jaxrs.model.ActionProfile"
    },
    "addedRelations": {
      "description": "Action profile added relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    },
    "deletedRelations": {
      "description": "Action profile deleted relations",
      "javaType": "java.util.List<org.folio.rest.jaxrs.model.ProfileAssociation>",
      "items": {
        "type": "object",
        "$ref": "profileAssociation.json"
      }
    }
  },
  "required": [
    "profile"
  ]
}