foliolib.folio.api.entitiesLinks.Entitieslinks
- class foliolib.folio.api.entitiesLinks.Entitieslinks(tenant: str)
Bases:
foliolib.folio.FolioApiEntities Links API
Entity Links API
Base class of the Folio API
- Parameters
tenant (str) – Tenant id
Methods
countlinksbyauthorityids(uuidCollection)Retrieve number of links by authority IDs
createauthority(authorityDto)POST /authority-storage/authoritiescreateauthoritybulk(authorityBulkRequest)POST /authority-storage/authorities/bulkcreateauthoritynotetype(authorityNoteTypeDto)POST /authority-note-typesPOST /authority-source-filesdeleteauthority(id_)DELETE /authority-storage/authorities/{id}DELETE /authority-note-types/{id}DELETE /authority-source-files/{id}deletereindexjob(id_)DELETE /authority-storage/reindex/{id}getauthority(id_)GET /authority-storage/authorities/{id}getauthoritylinksstats(**kwargs)Retrieve authority updates (related to links) statistics
getauthoritynotetype(id_)GET /authority-note-types/{id}GET /authority-source-files/{id}Retrieve instance-authority linking rule by ID
Retrieve instance-authority linking rules
getinstancelinks(instanceId)Get links collection related to Instance
getlinkedbibupdatestats(**kwargs)Retrieve linked bib update statistics
getreindexjob(id_)GET /authority-storage/reindex/{id}getreindexjobs(**kwargs)GET /authority-storage/reindexPOST /authority-source-files/{id}/hridretrieveauthorities(**kwargs)GET /authority-storage/authoritiesretrieveauthoritynotetypes(**kwargs)GET /authority-note-typesretrieveauthoritysourcefiles(**kwargs)GET /authority-source-filesPOST /authority-storage/reindexRetrieve links suggestions for marc records
updateauthority(authorityDto, id_)PUT /authority-storage/authorities/{id}PUT /authority-note-types/{id}updateinstancelinks(instanceId, ...)Update links collection related to Instance
- countlinksbyauthorityids(uuidCollection)
Retrieve number of links by authority IDs
POST /links/authorities/bulk/count- Parameters
uuidCollection (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "type": "object", "title": "Collection of UUIDs", "description": "Collection of UUIDs", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "ids" ] }
{ "type": "object", "title": "Collection of links count map for authorities", "description": "Collection of links count map for authorities", "properties": { "links": { "type": "array", "items": { "type": "object", "title": "Total links count map for one authority", "description": "Total links count map for one authority", "properties": { "id": { "type": "string", "format": "uuid" }, "totalLinks": { "type": "integer", "description": "Number of titles linked to the authority" } } } } }, "required": [ "links" ] }
- createauthority(authorityDto)
POST /authority-storage/authorities- Parameters
authorityDto (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An authority record", "type": "object", "properties": { "id": { "description": "Authority UUID", "type": "string", "format": "uuid" }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "source": { "type": "string", "description": "The metadata source of the underlying record to the authority record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in data-import)" }, "personalName": { "type": "string", "description": "Heading personal name" }, "sftPersonalName": { "type": "array", "description": "See from tracing personal name", "items": { "type": "string" } }, "saftPersonalName": { "type": "array", "description": "See also from tracing personal name", "items": { "type": "string" } }, "personalNameTitle": { "type": "string", "description": "Heading personal name title" }, "sftPersonalNameTitle": { "type": "array", "description": "See from tracing personal name title", "items": { "type": "string" } }, "saftPersonalNameTitle": { "type": "array", "description": "See also from tracing personal name title", "items": { "type": "string" } }, "corporateName": { "type": "string", "description": "Heading corporate name" }, "sftCorporateName": { "type": "array", "description": "See from tracing corporate name", "items": { "type": "string" } }, "saftCorporateName": { "type": "array", "description": "See also from tracing corporate name", "items": { "type": "string" } }, "corporateNameTitle": { "type": "string", "description": "Heading corporate name title" }, "sftCorporateNameTitle": { "type": "array", "description": "See from tracing corporate name title", "items": { "type": "string" } }, "saftCorporateNameTitle": { "type": "array", "description": "See also from tracing corporate name title", "items": { "type": "string" } }, "meetingName": { "type": "string", "description": "Heading meeting name" }, "sftMeetingName": { "type": "array", "description": "See from tracing meeting name", "items": { "type": "string" } }, "saftMeetingName": { "type": "array", "description": "See also from tracing meeting name", "items": { "type": "string" } }, "meetingNameTitle": { "type": "string", "description": "Heading meeting name title" }, "sftMeetingNameTitle": { "type": "array", "description": "See from tracing meeting name title", "items": { "type": "string" } }, "saftMeetingNameTitle": { "type": "array", "description": "See also from tracing meeting name title", "items": { "type": "string" } }, "uniformTitle": { "type": "string", "description": "Heading uniform title" }, "sftUniformTitle": { "type": "array", "description": "See from tracing uniform title", "items": { "type": "string" } }, "saftUniformTitle": { "type": "array", "description": "See also from tracing uniform title", "items": { "type": "string" } }, "topicalTerm": { "type": "string", "description": "Heading topical term" }, "sftTopicalTerm": { "type": "array", "description": "See from tracing topical term", "items": { "type": "string" } }, "saftTopicalTerm": { "type": "array", "description": "See also from tracing topical term", "items": { "type": "string" } }, "subjectHeadings": { "type": "string", "description": "Children's subject headings" }, "geographicName": { "type": "string", "description": "Heading geographic name" }, "sftGeographicName": { "type": "array", "description": "See from tracing geographic name", "items": { "type": "string" } }, "saftGeographicName": { "type": "array", "description": "See also from tracing geographic name", "items": { "type": "string" } }, "genreTerm": { "type": "string", "description": "Heading genre/form term" }, "sftGenreTerm": { "type": "array", "description": "See from tracing genre/form term", "items": { "type": "string" } }, "saftGenreTerm": { "type": "array", "description": "See also from tracing genre/form term", "items": { "type": "string" } }, "identifiers": { "type": "array", "description": "An extensible set of name-value pairs of identifiers associated with the resource", "items": { "description": "Identifier associated with the authority", "type": "object", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)", "type": "string", "format": "uuid" } }, "required": [ "value", "identifierTypeId" ] } }, "notes": { "type": "array", "description": "Notes (e.g. nonpublic general note)", "items": { "description": "Nonpublic general authority note", "type": "object", "properties": { "noteTypeId": { "description": "ID of the type of note", "type": "string", "format": "uuid" }, "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean" } }, "required": [ "note", "noteTypeId" ] } }, "sourceFileId": { "description": "Authority source file id; UUID", "type": "string", "format": "uuid" }, "naturalId": { "type": "string", "description": "Authority Natural ID" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "source", "naturalId" ] }
- createauthoritybulk(authorityBulkRequest)
POST /authority-storage/authorities/bulk- Parameters
authorityBulkRequest (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "Bulk authorities create request", "type": "object", "properties": { "recordsFileName": { "description": "File name of authority records", "type": "string" } }, "required": [ "recordsFileName" ] }
{ "description": "Bulk authorities create response", "type": "object", "properties": { "errorRecordsFileName": { "description": "File name of error authorities", "type": "string" }, "errorsFileName": { "description": "File name of error details", "type": "string" }, "errorsNumber": { "description": "Total number of errors", "type": "integer" } } }
- createauthoritynotetype(authorityNoteTypeDto)
POST /authority-note-types- Parameters
authorityNoteTypeDto (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An Authority note type", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority note type; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the Authority note type" }, "source": { "type": "string", "description": "label indicating where the Authority note type entry originates from, i.e. 'folio' or 'local'" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "name", "source" ] }
- createauthoritysourcefile(authoritySourceFilePostDto)
POST /authority-source-files- Parameters
authoritySourceFilePostDto (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An Authority source file", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority source file; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Authority source file name" }, "code": { "type": "string", "minLength": 1, "maxLength": 25, "description": "Label identifying prefix, i.e. 'n', 'D', 'fst'" }, "type": { "type": "string", "description": "Type of authority records stored in source file" }, "baseUrl": { "type": "string", "format": "url", "description": "Base URL of the source file origin" }, "selectable": { "type": "boolean", "default": true }, "hridManagement": { "description": "Identifies HRID management properties", "type": "object", "properties": { "startNumber": { "type": "integer", "minimum": 0, "default": 1 } } } }, "required": [ "name", "code" ] }
{ "description": "An Authority source file", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority source file; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Authority source file name" }, "codes": { "type": "array", "description": "List of identifying prefix", "items": { "type": "string", "description": "identifying prefix, i.e. 'n', 'D', 'fst'" } }, "type": { "type": "string", "description": "Type of authority records stored in source file" }, "baseUrl": { "type": "string", "format": "url", "description": "Base URL of the source file origin" }, "source": { "type": "string", "description": "label indicating where the authority source file entry originates from, i.e. 'folio' or 'local'", "enum": [ "folio", "local" ] }, "selectable": { "type": "boolean" }, "hridManagement": { "description": "Identifies HRID management properties", "type": "object", "properties": { "startNumber": { "type": "integer" } } }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "name", "codes", "source" ] }
- deleteauthority(id_)
DELETE /authority-storage/authorities/{id}- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
- deleteauthoritynotetype(id_)
DELETE /authority-note-types/{id}- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
- deleteauthoritysourcefile(id_)
DELETE /authority-source-files/{id}- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
- deletereindexjob(id_)
DELETE /authority-storage/reindex/{id}- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
- getauthority(id_)
GET /authority-storage/authorities/{id}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An authority record", "type": "object", "properties": { "id": { "description": "Authority UUID", "type": "string", "format": "uuid" }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "source": { "type": "string", "description": "The metadata source of the underlying record to the authority record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in data-import)" }, "personalName": { "type": "string", "description": "Heading personal name" }, "sftPersonalName": { "type": "array", "description": "See from tracing personal name", "items": { "type": "string" } }, "saftPersonalName": { "type": "array", "description": "See also from tracing personal name", "items": { "type": "string" } }, "personalNameTitle": { "type": "string", "description": "Heading personal name title" }, "sftPersonalNameTitle": { "type": "array", "description": "See from tracing personal name title", "items": { "type": "string" } }, "saftPersonalNameTitle": { "type": "array", "description": "See also from tracing personal name title", "items": { "type": "string" } }, "corporateName": { "type": "string", "description": "Heading corporate name" }, "sftCorporateName": { "type": "array", "description": "See from tracing corporate name", "items": { "type": "string" } }, "saftCorporateName": { "type": "array", "description": "See also from tracing corporate name", "items": { "type": "string" } }, "corporateNameTitle": { "type": "string", "description": "Heading corporate name title" }, "sftCorporateNameTitle": { "type": "array", "description": "See from tracing corporate name title", "items": { "type": "string" } }, "saftCorporateNameTitle": { "type": "array", "description": "See also from tracing corporate name title", "items": { "type": "string" } }, "meetingName": { "type": "string", "description": "Heading meeting name" }, "sftMeetingName": { "type": "array", "description": "See from tracing meeting name", "items": { "type": "string" } }, "saftMeetingName": { "type": "array", "description": "See also from tracing meeting name", "items": { "type": "string" } }, "meetingNameTitle": { "type": "string", "description": "Heading meeting name title" }, "sftMeetingNameTitle": { "type": "array", "description": "See from tracing meeting name title", "items": { "type": "string" } }, "saftMeetingNameTitle": { "type": "array", "description": "See also from tracing meeting name title", "items": { "type": "string" } }, "uniformTitle": { "type": "string", "description": "Heading uniform title" }, "sftUniformTitle": { "type": "array", "description": "See from tracing uniform title", "items": { "type": "string" } }, "saftUniformTitle": { "type": "array", "description": "See also from tracing uniform title", "items": { "type": "string" } }, "topicalTerm": { "type": "string", "description": "Heading topical term" }, "sftTopicalTerm": { "type": "array", "description": "See from tracing topical term", "items": { "type": "string" } }, "saftTopicalTerm": { "type": "array", "description": "See also from tracing topical term", "items": { "type": "string" } }, "subjectHeadings": { "type": "string", "description": "Children's subject headings" }, "geographicName": { "type": "string", "description": "Heading geographic name" }, "sftGeographicName": { "type": "array", "description": "See from tracing geographic name", "items": { "type": "string" } }, "saftGeographicName": { "type": "array", "description": "See also from tracing geographic name", "items": { "type": "string" } }, "genreTerm": { "type": "string", "description": "Heading genre/form term" }, "sftGenreTerm": { "type": "array", "description": "See from tracing genre/form term", "items": { "type": "string" } }, "saftGenreTerm": { "type": "array", "description": "See also from tracing genre/form term", "items": { "type": "string" } }, "identifiers": { "type": "array", "description": "An extensible set of name-value pairs of identifiers associated with the resource", "items": { "description": "Identifier associated with the authority", "type": "object", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)", "type": "string", "format": "uuid" } }, "required": [ "value", "identifierTypeId" ] } }, "notes": { "type": "array", "description": "Notes (e.g. nonpublic general note)", "items": { "description": "Nonpublic general authority note", "type": "object", "properties": { "noteTypeId": { "description": "ID of the type of note", "type": "string", "format": "uuid" }, "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean" } }, "required": [ "note", "noteTypeId" ] } }, "sourceFileId": { "description": "Authority source file id; UUID", "type": "string", "format": "uuid" }, "naturalId": { "type": "string", "description": "Authority Natural ID" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "source", "naturalId" ] }
- getauthoritylinksstats(**kwargs)
Retrieve authority updates (related to links) statistics
GET /links/stats/authority- Keyword Arguments
fromDate (str) – Start date to seek from (format: date-time)
toDate (str) – End date to seek from (format: date-time)
action (str) – Action to filter by
limit (int) – Max number of items in collection (minimum: 1, default: 100)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "Collection of authority updates statistics", "$ref": "#/components/schemas/authorityStatsDtoCollection" }
- getauthoritynotetype(id_)
GET /authority-note-types/{id}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An Authority note type", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority note type; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the Authority note type" }, "source": { "type": "string", "description": "label indicating where the Authority note type entry originates from, i.e. 'folio' or 'local'" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "name", "source" ] }
- getauthoritysourcefile(id_)
GET /authority-source-files/{id}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An Authority source file", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority source file; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Authority source file name" }, "codes": { "type": "array", "description": "List of identifying prefix", "items": { "type": "string", "description": "identifying prefix, i.e. 'n', 'D', 'fst'" } }, "type": { "type": "string", "description": "Type of authority records stored in source file" }, "baseUrl": { "type": "string", "format": "url", "description": "Base URL of the source file origin" }, "source": { "type": "string", "description": "label indicating where the authority source file entry originates from, i.e. 'folio' or 'local'", "enum": [ "folio", "local" ] }, "selectable": { "type": "boolean" }, "hridManagement": { "description": "Identifies HRID management properties", "type": "object", "properties": { "startNumber": { "type": "integer" } } }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "name", "codes", "source" ] }
- getinstanceauthoritylinkingrulebyid(ruleId)
Retrieve instance-authority linking rule by ID
GET /linking-rules/instance-authority/{ruleId}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
Schema
{ "type": "object", "title": "Field to filed linking rule", "description": "Field to filed linking rule", "properties": { "id": { "type": "integer" }, "bibField": { "type": "string" }, "authorityField": { "type": "string" }, "authoritySubfields": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1 } }, "subfieldModifications": { "type": "array", "items": { "type": "object", "title": "Subfield modification.", "description": "Subfield modification to link source and target subfields.", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 1 }, "target": { "type": "string", "minLength": 1, "maxLength": 1 } } } }, "validation": { "type": "object", "title": "Subfield validation.", "description": "Subfield validation before linking.", "properties": { "existence": { "type": "array", "description": "Specify if subfield should exist or not.", "items": { "type": "string", "additionalProperties": { "type": "boolean" } } } } }, "autoLinkingEnabled": { "type": "boolean" } } }
- getinstanceauthoritylinkingrules()
Retrieve instance-authority linking rules
GET /linking-rules/instance-authority- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "type": "array", "title": "Collection of linking rules", "description": "Collection of linking rules", "items": { "$ref": "#/components/schemas/linkingRuleDto" } }
- getinstancelinks(instanceId)
Get links collection related to Instance
GET /links/instances/{instanceId}- Parameters
instanceId (str) – UUID of the Instance that is related to the MARC record (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "type": "object", "title": "Collection of instance links", "description": "Collection of instance links", "properties": { "links": { "type": "array", "items": { "type": "object", "title": "Collection of instance links", "description": "Collection of instance links", "properties": { "id": { "type": "integer", "description": "Unique generated identifier for the link" }, "authorityId": { "type": "string", "format": "uuid" }, "authorityNaturalId": { "type": "string", "description": "Natural ID of the Authority record" }, "instanceId": { "type": "string", "format": "uuid" }, "linkingRuleId": { "type": "integer", "description": "ID of linking rule by which link should be created" }, "status": { "type": "string", "readOnly": true, "description": "Status of the link" }, "errorCause": { "type": "string", "readOnly": true, "description": "Link update error cause (if present)" } }, "required": [ "authorityId", "authorityNaturalId", "instanceId", "linkingRuleId", "status" ] } }, "totalRecords": { "type": "integer", "readOnly": true, "description": "Total amount of notes" } }, "required": [ "links" ] }
- getlinkedbibupdatestats(**kwargs)
Retrieve linked bib update statistics
GET /links/stats/instance- Keyword Arguments
fromDate (str) – Start date to seek from (format: date-time)
toDate (str) – End date to seek to (format: date-time)
status (str) – Status to filter by
limit (int) – Max number of items in collection (minimum: 1, default: 100)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "Collection of changes statistic", "type": "object", "properties": { "stats": { "description": "Changes statistic", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Linked bib statistics", "type": "object", "properties": { "instanceId": { "description": "Linked instance id, UUID", "type": "string", "format": "uuid" }, "instanceTitle": { "description": "Instance title", "type": "string" }, "bibRecordTag": { "description": "Bib record tag", "type": "string" }, "authorityNaturalId": { "description": "Linked authority natural id", "type": "string" }, "updatedAt": { "description": "Link last updated at", "type": "string", "format": "date-time" }, "errorCause": { "description": "Cause of error for updating linked bib", "type": "string" } } } }, "next": { "description": "Next response item date to seek by", "type": "string", "format": "date-time" } } }
- getreindexjob(id_)
GET /authority-storage/reindex/{id}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "Get job by id response", "type": "object", "properties": { "id": { "description": "Job id", "type": "string", "format": "uuid" }, "published": { "description": "Number of records that was published so far", "type": "integer" }, "jobStatus": { "description": "Overall job status", "type": "string", "enum": [ "In progress", "Id publishing failed", "Ids published", "Pending cancel", "Id publishing cancelled" ] }, "resourceName": { "description": "Reindex resource name", "type": "string", "enum": [ "Authority" ] }, "submittedDate": { "description": "Timestamp when the job has been submitted", "type": "string", "format": "date-time" } } }
- getreindexjobs(**kwargs)
GET /authority-storage/reindex- 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. (default: cql.allRecords=1)
offset (int) – Skip over a number of elements by specifying an offset value for the query. (minimum: 0, maximum: 2147483647, default: 0)
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 2000, default: 100)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "A collection of reindex jobs", "type": "object", "properties": { "reindexJobs": { "description": "List of reindex jobs", "id": "reindexJob", "type": "array", "items": { "description": "Get job by id response", "type": "object", "properties": { "id": { "description": "Job id", "type": "string", "format": "uuid" }, "published": { "description": "Number of records that was published so far", "type": "integer" }, "jobStatus": { "description": "Overall job status", "type": "string", "enum": [ "In progress", "Id publishing failed", "Ids published", "Pending cancel", "Id publishing cancelled" ] }, "resourceName": { "description": "Reindex resource name", "type": "string", "enum": [ "Authority" ] }, "submittedDate": { "description": "Timestamp when the job has been submitted", "type": "string", "format": "date-time" } } } }, "totalRecords": { "description": "Estimated or exact total number of records", "type": "integer" } }, "required": [ "reindexJobs", "totalRecords" ] }
- newauthoritysourcefilenexthrid(id_)
POST /authority-source-files/{id}/hrid- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Record was not found.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An Authority source file HRID response", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority source file", "type": "string", "format": "uuid" }, "hrid": { "type": "string", "description": "Next available Authority source file HRID" } } }
- retrieveauthorities(**kwargs)
GET /authority-storage/authorities- Keyword Arguments
deleted (bool) – Indicates if only deleted authority records should be retrieved (default: False)
idOnly (bool) – Indicates if only IDs of authority records should be retrieved (default: False)
offset (int) – Skip over a number of elements by specifying an offset value for the query. (minimum: 0, maximum: 2147483647, default: 0)
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 2000, default: 100)
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. Authorities can be queried using the following fields: headingType, authoritySourceFile.id, authoritySourceFile.name, createdDate, updatedDate. Example: headingType=personalName & authoritySourceFile.name=LC Genre/Form Terms & createdDate>2021-10-25T12:00:00.0 (default: cql.allRecords=1)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "A collection of authority records", "type": "object", "properties": { "authorities": { "description": "List of authority records", "type": "array", "items": { "description": "An authority record", "type": "object", "properties": { "id": { "description": "Authority UUID", "type": "string", "format": "uuid" }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "source": { "type": "string", "description": "The metadata source of the underlying record to the authority record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in data-import)" }, "personalName": { "type": "string", "description": "Heading personal name" }, "sftPersonalName": { "type": "array", "description": "See from tracing personal name", "items": { "type": "string" } }, "saftPersonalName": { "type": "array", "description": "See also from tracing personal name", "items": { "type": "string" } }, "personalNameTitle": { "type": "string", "description": "Heading personal name title" }, "sftPersonalNameTitle": { "type": "array", "description": "See from tracing personal name title", "items": { "type": "string" } }, "saftPersonalNameTitle": { "type": "array", "description": "See also from tracing personal name title", "items": { "type": "string" } }, "corporateName": { "type": "string", "description": "Heading corporate name" }, "sftCorporateName": { "type": "array", "description": "See from tracing corporate name", "items": { "type": "string" } }, "saftCorporateName": { "type": "array", "description": "See also from tracing corporate name", "items": { "type": "string" } }, "corporateNameTitle": { "type": "string", "description": "Heading corporate name title" }, "sftCorporateNameTitle": { "type": "array", "description": "See from tracing corporate name title", "items": { "type": "string" } }, "saftCorporateNameTitle": { "type": "array", "description": "See also from tracing corporate name title", "items": { "type": "string" } }, "meetingName": { "type": "string", "description": "Heading meeting name" }, "sftMeetingName": { "type": "array", "description": "See from tracing meeting name", "items": { "type": "string" } }, "saftMeetingName": { "type": "array", "description": "See also from tracing meeting name", "items": { "type": "string" } }, "meetingNameTitle": { "type": "string", "description": "Heading meeting name title" }, "sftMeetingNameTitle": { "type": "array", "description": "See from tracing meeting name title", "items": { "type": "string" } }, "saftMeetingNameTitle": { "type": "array", "description": "See also from tracing meeting name title", "items": { "type": "string" } }, "uniformTitle": { "type": "string", "description": "Heading uniform title" }, "sftUniformTitle": { "type": "array", "description": "See from tracing uniform title", "items": { "type": "string" } }, "saftUniformTitle": { "type": "array", "description": "See also from tracing uniform title", "items": { "type": "string" } }, "topicalTerm": { "type": "string", "description": "Heading topical term" }, "sftTopicalTerm": { "type": "array", "description": "See from tracing topical term", "items": { "type": "string" } }, "saftTopicalTerm": { "type": "array", "description": "See also from tracing topical term", "items": { "type": "string" } }, "subjectHeadings": { "type": "string", "description": "Children's subject headings" }, "geographicName": { "type": "string", "description": "Heading geographic name" }, "sftGeographicName": { "type": "array", "description": "See from tracing geographic name", "items": { "type": "string" } }, "saftGeographicName": { "type": "array", "description": "See also from tracing geographic name", "items": { "type": "string" } }, "genreTerm": { "type": "string", "description": "Heading genre/form term" }, "sftGenreTerm": { "type": "array", "description": "See from tracing genre/form term", "items": { "type": "string" } }, "saftGenreTerm": { "type": "array", "description": "See also from tracing genre/form term", "items": { "type": "string" } }, "identifiers": { "type": "array", "description": "An extensible set of name-value pairs of identifiers associated with the resource", "items": { "description": "Identifier associated with the authority", "type": "object", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)", "type": "string", "format": "uuid" } }, "required": [ "value", "identifierTypeId" ] } }, "notes": { "type": "array", "description": "Notes (e.g. nonpublic general note)", "items": { "description": "Nonpublic general authority note", "type": "object", "properties": { "noteTypeId": { "description": "ID of the type of note", "type": "string", "format": "uuid" }, "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean" } }, "required": [ "note", "noteTypeId" ] } }, "sourceFileId": { "description": "Authority source file id; UUID", "type": "string", "format": "uuid" }, "naturalId": { "type": "string", "description": "Authority Natural ID" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "source", "naturalId" ] } }, "totalRecords": { "description": "Total amount of records", "type": "integer" } }, "required": [ "authorities", "totalRecords" ] }
- retrieveauthoritynotetypes(**kwargs)
GET /authority-note-types- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query. (minimum: 0, maximum: 2147483647, default: 0)
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 2000, default: 100)
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. (default: cql.allRecords=1)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "A collection of authority note types", "type": "object", "properties": { "authorityNoteTypes": { "description": "List of authority note types", "type": "array", "items": { "description": "An Authority note type", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority note type; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the Authority note type" }, "source": { "type": "string", "description": "label indicating where the Authority note type entry originates from, i.e. 'folio' or 'local'" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "name", "source" ] } }, "totalRecords": { "description": "Total amount of records", "type": "integer" } }, "required": [ "authorityNoteTypes", "totalRecords" ] }
- retrieveauthoritysourcefiles(**kwargs)
GET /authority-source-files- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query. (minimum: 0, maximum: 2147483647, default: 0)
limit (int) – Limit the number of elements returned in the response. (minimum: 0, maximum: 2000, default: 100)
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. (default: cql.allRecords=1)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "A collection of authority source files", "type": "object", "properties": { "authoritySourceFiles": { "description": "List of authority source files", "type": "array", "items": { "description": "An Authority source file", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority source file; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Authority source file name" }, "codes": { "type": "array", "description": "List of identifying prefix", "items": { "type": "string", "description": "identifying prefix, i.e. 'n', 'D', 'fst'" } }, "type": { "type": "string", "description": "Type of authority records stored in source file" }, "baseUrl": { "type": "string", "format": "url", "description": "Base URL of the source file origin" }, "source": { "type": "string", "description": "label indicating where the authority source file entry originates from, i.e. 'folio' or 'local'", "enum": [ "folio", "local" ] }, "selectable": { "type": "boolean" }, "hridManagement": { "description": "Identifies HRID management properties", "type": "object", "properties": { "startNumber": { "type": "integer" } } }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "name", "codes", "source" ] } }, "totalRecords": { "description": "Total amount of records", "type": "integer" } }, "required": [ "authorityNoteTypes", "totalRecords" ] }
- submitreindexjob()
POST /authority-storage/reindex- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "Get job by id response", "type": "object", "properties": { "id": { "description": "Job id", "type": "string", "format": "uuid" }, "published": { "description": "Number of records that was published so far", "type": "integer" }, "jobStatus": { "description": "Overall job status", "type": "string", "enum": [ "In progress", "Id publishing failed", "Ids published", "Pending cancel", "Id publishing cancelled" ] }, "resourceName": { "description": "Reindex resource name", "type": "string", "enum": [ "Authority" ] }, "submittedDate": { "description": "Timestamp when the job has been submitted", "type": "string", "format": "date-time" } } }
- suggestlinksformarcrecord(parsedRecordContentCollection, **kwargs)
Retrieve links suggestions for marc records
POST /links-suggestions/marc- Parameters
parsedRecordContentCollection (dict) – See Schema below.
- Keyword Arguments
authoritySearchParameter (str) – Authority field to search by (description: Authority search parameter for link suggestions, enum: [‘ID’, ‘NATURAL_ID’], default: NATURAL_ID)
ignoreAutoLinkingEnabled (bool) – Indicates if we need to ignore autoLinkingEnabled flag when filtering the fields for suggestions (default: False)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Validation errors.
OkapiRequestFatalError – Internal server error.
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Collection of SRS records content", "type": "object", "properties": { "records": { "description": "List of records content", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Parsed record content, e.g. MARC record", "type": "object", "additionalProperties": false, "properties": { "fields": { "description": "List of fields", "type": "array", "items": { "description": "Map of marc fields", "title": "FieldContent", "type": "object", "maxProperties": 1, "additionalProperties": { "type": "object", "properties": { "ind1": { "description": "Identifier 1", "type": "string" }, "ind2": { "description": "Identifier 2", "type": "string" }, "subfields": { "description": "List of subfields", "type": "array", "items": { "type": "object", "description": "Map of subfields", "additionalProperties": { "type": "string" } } }, "linkDetails": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Collection of SRS records content", "type": "object", "properties": { "authorityId": { "description": "Authority ID", "type": "string", "format": "uuid" }, "authorityNaturalId": { "description": "Authority Natural ID", "type": "string" }, "status": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Link status", "enum": [ "ACTUAL", "ERROR", "NEW" ] }, "linkingRuleId": { "description": "Linking rule ID", "type": "integer" }, "errorCause": { "description": "Error status code", "type": "string" } } } } } } }, "leader": { "description": "Parsed record content, e.g. MARC record", "type": "string" } }, "required": [ "fields", "leader" ] } } } }
- updateauthority(authorityDto, id_)
PUT /authority-storage/authorities/{id}- Parameters
authorityDto (dict) – See Schema below.
- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An authority record", "type": "object", "properties": { "id": { "description": "Authority UUID", "type": "string", "format": "uuid" }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "source": { "type": "string", "description": "The metadata source of the underlying record to the authority record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in data-import)" }, "personalName": { "type": "string", "description": "Heading personal name" }, "sftPersonalName": { "type": "array", "description": "See from tracing personal name", "items": { "type": "string" } }, "saftPersonalName": { "type": "array", "description": "See also from tracing personal name", "items": { "type": "string" } }, "personalNameTitle": { "type": "string", "description": "Heading personal name title" }, "sftPersonalNameTitle": { "type": "array", "description": "See from tracing personal name title", "items": { "type": "string" } }, "saftPersonalNameTitle": { "type": "array", "description": "See also from tracing personal name title", "items": { "type": "string" } }, "corporateName": { "type": "string", "description": "Heading corporate name" }, "sftCorporateName": { "type": "array", "description": "See from tracing corporate name", "items": { "type": "string" } }, "saftCorporateName": { "type": "array", "description": "See also from tracing corporate name", "items": { "type": "string" } }, "corporateNameTitle": { "type": "string", "description": "Heading corporate name title" }, "sftCorporateNameTitle": { "type": "array", "description": "See from tracing corporate name title", "items": { "type": "string" } }, "saftCorporateNameTitle": { "type": "array", "description": "See also from tracing corporate name title", "items": { "type": "string" } }, "meetingName": { "type": "string", "description": "Heading meeting name" }, "sftMeetingName": { "type": "array", "description": "See from tracing meeting name", "items": { "type": "string" } }, "saftMeetingName": { "type": "array", "description": "See also from tracing meeting name", "items": { "type": "string" } }, "meetingNameTitle": { "type": "string", "description": "Heading meeting name title" }, "sftMeetingNameTitle": { "type": "array", "description": "See from tracing meeting name title", "items": { "type": "string" } }, "saftMeetingNameTitle": { "type": "array", "description": "See also from tracing meeting name title", "items": { "type": "string" } }, "uniformTitle": { "type": "string", "description": "Heading uniform title" }, "sftUniformTitle": { "type": "array", "description": "See from tracing uniform title", "items": { "type": "string" } }, "saftUniformTitle": { "type": "array", "description": "See also from tracing uniform title", "items": { "type": "string" } }, "topicalTerm": { "type": "string", "description": "Heading topical term" }, "sftTopicalTerm": { "type": "array", "description": "See from tracing topical term", "items": { "type": "string" } }, "saftTopicalTerm": { "type": "array", "description": "See also from tracing topical term", "items": { "type": "string" } }, "subjectHeadings": { "type": "string", "description": "Children's subject headings" }, "geographicName": { "type": "string", "description": "Heading geographic name" }, "sftGeographicName": { "type": "array", "description": "See from tracing geographic name", "items": { "type": "string" } }, "saftGeographicName": { "type": "array", "description": "See also from tracing geographic name", "items": { "type": "string" } }, "genreTerm": { "type": "string", "description": "Heading genre/form term" }, "sftGenreTerm": { "type": "array", "description": "See from tracing genre/form term", "items": { "type": "string" } }, "saftGenreTerm": { "type": "array", "description": "See also from tracing genre/form term", "items": { "type": "string" } }, "identifiers": { "type": "array", "description": "An extensible set of name-value pairs of identifiers associated with the resource", "items": { "description": "Identifier associated with the authority", "type": "object", "properties": { "value": { "type": "string", "description": "Resource identifier value" }, "identifierTypeId": { "description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)", "type": "string", "format": "uuid" } }, "required": [ "value", "identifierTypeId" ] } }, "notes": { "type": "array", "description": "Notes (e.g. nonpublic general note)", "items": { "description": "Nonpublic general authority note", "type": "object", "properties": { "noteTypeId": { "description": "ID of the type of note", "type": "string", "format": "uuid" }, "note": { "type": "string", "description": "Text content of the note" }, "staffOnly": { "type": "boolean" } }, "required": [ "note", "noteTypeId" ] } }, "sourceFileId": { "description": "Authority source file id; UUID", "type": "string", "format": "uuid" }, "naturalId": { "type": "string", "description": "Authority Natural ID" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "source", "naturalId" ] }
- updateauthoritynotetype(authorityNoteTypeDto, id_)
PUT /authority-note-types/{id}- Parameters
authorityNoteTypeDto (dict) – See Schema below.
- Raises
OkapiRequestError – Validation errors.
OkapiRequestNotFound – Record was not found.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "description": "An Authority note type", "type": "object", "properties": { "id": { "description": "Unique ID of the Authority note type; a UUID", "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the Authority note type" }, "source": { "type": "string", "description": "label indicating where the Authority note type entry originates from, i.e. 'folio' or 'local'" }, "metadata": { "description": "Creater, updater, creation date, last updated date", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "uuid" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "uuid" } } } }, "required": [ "name", "source" ] }
- updateinstancelinks(instanceId, instanceLinkDtoCollection)
Update links collection related to Instance
PUT /links/instances/{instanceId}- Parameters
instanceId (str) – UUID of the Instance that is related to the MARC record (format: uuid)
instanceLinkDtoCollection (dict) – See Schema below.
- Raises
OkapiRequestError – Validation errors.
OkapiRequestUnprocessableEntity – Validation error for the request.
OkapiRequestFatalError – Internal server error.
Schema
{ "type": "object", "title": "Collection of instance links", "description": "Collection of instance links", "properties": { "links": { "type": "array", "items": { "type": "object", "title": "Collection of instance links", "description": "Collection of instance links", "properties": { "id": { "type": "integer", "description": "Unique generated identifier for the link" }, "authorityId": { "type": "string", "format": "uuid" }, "authorityNaturalId": { "type": "string", "description": "Natural ID of the Authority record" }, "instanceId": { "type": "string", "format": "uuid" }, "linkingRuleId": { "type": "integer", "description": "ID of linking rule by which link should be created" }, "status": { "type": "string", "readOnly": true, "description": "Status of the link" }, "errorCause": { "type": "string", "readOnly": true, "description": "Link update error cause (if present)" } }, "required": [ "authorityId", "authorityNaturalId", "instanceId", "linkingRuleId", "status" ] } }, "totalRecords": { "type": "integer", "readOnly": true, "description": "Total amount of notes" } }, "required": [ "links" ] }