Authority Storage version v1.1
http://localhost
Authority Storage API
Storage for authorities in the inventory
/authority-storage
Collection of authority items.
get
Retrieve a list of authority items.
post
Create a new authority item.
delete
get /authority-storage/authorities
Retrieve a list of authority items.
Query Parameters
- offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
10 - query: (string)
A query expressed as a CQL string (see 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.
using CQL
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode personalName="root" - lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns a list of authority items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of authority records",
"type": "object",
"properties": {
"authorities": {
"description": "List of authority records",
"id": "authorities",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An authority record",
"properties": {
"id": {
"type": "string",
"description": "Authority UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"_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)",
"enum": [
"MARC",
"FOLIO"
],
"readonly": true
},
"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": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"required": [
"value",
"identifierTypeId"
]
}
},
"notes": {
"type": "array",
"description": "Notes (e.g. nonpublic general note)",
"items": {
"type": "object",
"properties": {
"noteTypeId": {
"description": "ID of the type of note",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
}
},
"required": [
"note",
"noteTypeId"
]
}
},
"sourceFileId": {
"type": "string",
"description": "Authority source file id; UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"naturalId": {
"type": "string",
"description": "Authority Natural ID"
},
"metadata": {
"type": "object",
"description": "Creater, updater, creation date, last updated date",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}
},
"totalRecords": {
"type": "integer"
},
"resultInfo": {
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "resultInfo.schema",
"description": "Faceting of result sets",
"type": "object",
"properties": {
"totalRecords": {
"type": "integer",
"description": "Estimated or exact total number of records"
},
"totalRecordsEstimated": {
"type": "boolean",
"description": "True if totalRecords is an estimation, false if it is the exact number"
},
"totalRecordsRounded": {
"type": "integer",
"description": "The rounded value of totalRecords if totalRecords is an estimation"
},
"responseTime": {
"type": "number",
"description": "Response time"
},
"facets": {
"type": "array",
"description": "Array of facets",
"items": {
"type": "object",
"description": "A facet",
"properties": {
"facetValues": {
"type": "array",
"description": "Array of facet values",
"items": {
"type": "object",
"description": "A facet value",
"properties": {
"count": {
"type": "integer",
"description": "Count of facet values"
},
"value": {
"description": "Value Object"
}
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"description": "Type of facet"
}
},
"additionalProperties": false
}
},
"diagnostics": {
"type": "array",
"description": "Array of diagnostic information",
"items": {
"type": "object",
"description": "Diagnostic information",
"properties": {
"source": {
"type": "string",
"description": "Source reporting the diagnostic information"
},
"code": {
"type": "string",
"description": "Diagnostic Code"
},
"message": {
"type": "string",
"description": "Diagnostic Message"
},
"module": {
"type": "string",
"description": "Module reporting diagnostic information"
},
"recordCount": {
"type": "integer",
"description": "Record Count for diagnostics"
},
"query": {
"type": "string",
"description": "CQL Query associated with results"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"authorities",
"totalRecords"
],
"additionalProperties": false
}Example:
{
"authorities": [
{
"id": "5f671674-229a-48e9-804e-d2814cddd321",
"_version": 0,
"personalName": "Twain, Mark, 1835-1910",
"sftPersonalName": [
"Tuėĭn, Mark, 1835-1910",
"Tuwayn, Mārk, 1835-1910",
"Tʻu-wen, Ma-kʻo, 1835-1910",
"Твен, Марк, 1835-1910"
],
"saftPersonalName": [
"nnn, Clemens, Samuel Langhorne, 1835-1910",
"nnn, Snodgrass, Quintus Curtius, 1835-1910"
],
"corporateName": "International Business Machines Corporation",
"sftCorporateName": [
"Oklahoma. Council on Juvenile Delinquency",
"Oklahoma. Oklahoma Council on Juvenile Delinquency"
],
"saftCorporateName": [
"Oklahoma Council on Juvenile Delinquency Planning",
"Oklahoma Council on Juvenile Justice"
],
"meetingName": "Olympic Winter Games (21st : 2010 : Vancouver, B.C.)",
"sftMeetingName": [
"Vancouver Winter Games (2010 : Vancouver, B.C.)"
],
"saftMeetingName": [
],
"uniformTitle": "Monograph (Institute of Applied Social and Economic Research)",
"sftUniformTitle": [
"Monographs (Institute of Applied Social and Economic Research)",
"Monograph series (Institute of Applied Social and Economic Research)",
"IASER monograph"
],
"saftUniformTitle": [
"Continues (work): New Guinea research bulletin",
"Continued by (work): Monograph (National Research Institute (Papua New Guinea))"
],
"topicalTerm": "Optical disks",
"sftTopicalTerm": [
"Discs, Optical",
"Optical discs",
"Laser discs",
"Laser disks",
"Laserdiscs",
"Laserdisks"
],
"saftTopicalTerm": [
"Optical storage devices"
],
"subjectHeadings": "z",
"geographicName": "Great Lakes",
"sftGeographicName": [
"Great Lakes",
"Lakes Great",
"Regions of the United States"
],
"saftGeographicName": [
"Superior, Michigan, Huron, Erie, and Ontario"
],
"genreTerm": "Panoramas",
"sftGenreTerm": [
"Panoramic views"
],
"saftGenreTerm": [
],
"identifiers": [
{
"identifierTypeId": "11bf5f7c-30e1-4308-8170-1fbb5b817cf2",
"value": "955335"
},
{
"identifierTypeId": "a6b2e7a4-d8fc-46b4-ac86-7bee3557f9c6",
"value": "79021164"
},
{
"identifierTypeId": "e32dd8fe-6582-4161-a56c-9dfe4415517e",
"value": "0000000121491740"
},
{
"identifierTypeId": "bc3e4c14-2412-49d4-9132-386f3aab243e",
"value": "(OCoLC)oca00254964"
}
],
"notes": [
{
"noteTypeId": "d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value": "Machine-derived non-Latin script reference project."
},
{
"noteTypeId": "d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value": "Non-Latin script references not evaluated."
},
{
"noteTypeId": "d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value": "Pseudonym not established: Jean François Alden"
}
],
"metadata": {
"createdDate": "2020-10-09T16:47:22.072+0000",
"updatedDate": "2020-10-09T16:47:49.703+0000",
"createdByUserId": "39720b69-3141-5eb8-95c8-d3bf17eb99d2",
"updatedByUserId": "39720b69-3141-5eb8-95c8-d3bf17eb99d2"
}
}
],
"totalRecords": 1
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
unable to list authorities -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list authorities -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /authority-storage/authorities
Create a new authority item.
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An authority record",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Authority UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"_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)",
"enum": [
"MARC",
"FOLIO"
],
"readonly": true
},
"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": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"required": [
"value",
"identifierTypeId"
]
}
},
"notes": {
"type": "array",
"description": "Notes (e.g. nonpublic general note)",
"items": {
"type": "object",
"properties": {
"noteTypeId": {
"description": "ID of the type of note",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
}
},
"required": [
"note",
"noteTypeId"
]
}
},
"sourceFileId": {
"type": "string",
"description": "Authority source file id; UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"naturalId": {
"type": "string",
"description": "Authority Natural ID"
},
"metadata": {
"type": "object",
"description": "Creater, updater, creation date, last updated date",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}Example:
{
"id":"5f671674-229a-48e9-804e-d2814cddd321",
"_version": 0,
"personalName":"Twain, Mark, 1835-1910",
"sftPersonalName":[
"Tuėĭn, Mark, 1835-1910",
"Tuwayn, Mārk, 1835-1910",
"Tʻu-wen, Ma-kʻo, 1835-1910",
"Твен, Марк, 1835-1910"
],
"saftPersonalName":[
"nnn, Clemens, Samuel Langhorne, 1835-1910",
"nnn, Snodgrass, Quintus Curtius, 1835-1910"
],
"corporateName":"International Business Machines Corporation",
"sftCorporateName":[
"Oklahoma. Council on Juvenile Delinquency",
"Oklahoma. Oklahoma Council on Juvenile Delinquency"
],
"saftCorporateName":[
"Oklahoma Council on Juvenile Delinquency Planning",
"Oklahoma Council on Juvenile Justice"
],
"meetingName":"Olympic Winter Games (21st : 2010 : Vancouver, B.C.)",
"sftMeetingName":[
"Vancouver Winter Games (2010 : Vancouver, B.C.)"
],
"saftMeetingName":[
],
"uniformTitle":"Monograph (Institute of Applied Social and Economic Research)",
"sftUniformTitle":[
"Monographs (Institute of Applied Social and Economic Research)",
"Monograph series (Institute of Applied Social and Economic Research)",
"IASER monograph"
],
"saftUniformTitle":[
"Continues (work): New Guinea research bulletin",
"Continued by (work): Monograph (National Research Institute (Papua New Guinea))"
],
"topicalTerm":"Optical disks",
"sftTopicalTerm":[
"Discs, Optical",
"Optical discs",
"Laser discs",
"Laser disks",
"Laserdiscs",
"Laserdisks"
],
"saftTopicalTerm":[
"Optical storage devices"
],
"subjectHeadings":"z",
"geographicName":"Great Lakes",
"sftGeographicName":[
"Great Lakes",
"Lakes Great",
"Regions of the United States"
],
"saftGeographicName":[
"Superior, Michigan, Huron, Erie, and Ontario"
],
"genreTerm":"Panoramas",
"sftGenreTerm":[
"Panoramic views"
],
"saftGenreTerm":[
],
"identifiers":[
{
"identifierTypeId":"11bf5f7c-30e1-4308-8170-1fbb5b817cf2",
"value":"955335"
},
{
"identifierTypeId":"a6b2e7a4-d8fc-46b4-ac86-7bee3557f9c6",
"value":"79021164"
},
{
"identifierTypeId":"e32dd8fe-6582-4161-a56c-9dfe4415517e",
"value":"0000000121491740"
},
{
"identifierTypeId":"bc3e4c14-2412-49d4-9132-386f3aab243e",
"value":"(OCoLC)oca00254964"
}
],
"notes":[
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Machine-derived non-Latin script reference project."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Non-Latin script references not evaluated."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Pseudonym not established: Jean François Alden"
}
],
"metadata":{
"createdDate":"2020-10-09T16:47:22.072+0000",
"updatedDate":"2020-10-09T16:47:49.703+0000",
"createdByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2",
"updatedByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2"
}
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created authority item
Body
Media type: application/json
Type: any
Example:
{
"id":"5f671674-229a-48e9-804e-d2814cddd321",
"_version": 0,
"personalName":"Twain, Mark, 1835-1910",
"sftPersonalName":[
"Tuėĭn, Mark, 1835-1910",
"Tuwayn, Mārk, 1835-1910",
"Tʻu-wen, Ma-kʻo, 1835-1910",
"Твен, Марк, 1835-1910"
],
"saftPersonalName":[
"nnn, Clemens, Samuel Langhorne, 1835-1910",
"nnn, Snodgrass, Quintus Curtius, 1835-1910"
],
"corporateName":"International Business Machines Corporation",
"sftCorporateName":[
"Oklahoma. Council on Juvenile Delinquency",
"Oklahoma. Oklahoma Council on Juvenile Delinquency"
],
"saftCorporateName":[
"Oklahoma Council on Juvenile Delinquency Planning",
"Oklahoma Council on Juvenile Justice"
],
"meetingName":"Olympic Winter Games (21st : 2010 : Vancouver, B.C.)",
"sftMeetingName":[
"Vancouver Winter Games (2010 : Vancouver, B.C.)"
],
"saftMeetingName":[
],
"uniformTitle":"Monograph (Institute of Applied Social and Economic Research)",
"sftUniformTitle":[
"Monographs (Institute of Applied Social and Economic Research)",
"Monograph series (Institute of Applied Social and Economic Research)",
"IASER monograph"
],
"saftUniformTitle":[
"Continues (work): New Guinea research bulletin",
"Continued by (work): Monograph (National Research Institute (Papua New Guinea))"
],
"topicalTerm":"Optical disks",
"sftTopicalTerm":[
"Discs, Optical",
"Optical discs",
"Laser discs",
"Laser disks",
"Laserdiscs",
"Laserdisks"
],
"saftTopicalTerm":[
"Optical storage devices"
],
"subjectHeadings":"z",
"geographicName":"Great Lakes",
"sftGeographicName":[
"Great Lakes",
"Lakes Great",
"Regions of the United States"
],
"saftGeographicName":[
"Superior, Michigan, Huron, Erie, and Ontario"
],
"genreTerm":"Panoramas",
"sftGenreTerm":[
"Panoramic views"
],
"saftGenreTerm":[
],
"identifiers":[
{
"identifierTypeId":"11bf5f7c-30e1-4308-8170-1fbb5b817cf2",
"value":"955335"
},
{
"identifierTypeId":"a6b2e7a4-d8fc-46b4-ac86-7bee3557f9c6",
"value":"79021164"
},
{
"identifierTypeId":"e32dd8fe-6582-4161-a56c-9dfe4415517e",
"value":"0000000121491740"
},
{
"identifierTypeId":"bc3e4c14-2412-49d4-9132-386f3aab243e",
"value":"(OCoLC)oca00254964"
}
],
"notes":[
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Machine-derived non-Latin script reference project."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Non-Latin script references not evaluated."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Pseudonym not established: Jean François Alden"
}
],
"metadata":{
"createdDate":"2020-10-09T16:47:22.072+0000",
"updatedDate":"2020-10-09T16:47:49.703+0000",
"createdByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2",
"updatedByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2"
}
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to add authority -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create authorities -- unauthorizedHTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratordelete /authority-storage/authorities
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Entity representing a authority
get
Retrieve authority Authority with given {authorityId}
delete
Delete authority Authority with given {authorityId}
put
Update authority Authority with given {authorityId}
get /authority-storage/authorities/{authorityId}
Retrieve authority Authority with given {authorityId}
URI Parameters
- authorityId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns Authority with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An authority record",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Authority UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"_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)",
"enum": [
"MARC",
"FOLIO"
],
"readonly": true
},
"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": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"required": [
"value",
"identifierTypeId"
]
}
},
"notes": {
"type": "array",
"description": "Notes (e.g. nonpublic general note)",
"items": {
"type": "object",
"properties": {
"noteTypeId": {
"description": "ID of the type of note",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
}
},
"required": [
"note",
"noteTypeId"
]
}
},
"sourceFileId": {
"type": "string",
"description": "Authority source file id; UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"naturalId": {
"type": "string",
"description": "Authority Natural ID"
},
"metadata": {
"type": "object",
"description": "Creater, updater, creation date, last updated date",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}Example:
{
"id":"5f671674-229a-48e9-804e-d2814cddd321",
"_version": 0,
"personalName":"Twain, Mark, 1835-1910",
"sftPersonalName":[
"Tuėĭn, Mark, 1835-1910",
"Tuwayn, Mārk, 1835-1910",
"Tʻu-wen, Ma-kʻo, 1835-1910",
"Твен, Марк, 1835-1910"
],
"saftPersonalName":[
"nnn, Clemens, Samuel Langhorne, 1835-1910",
"nnn, Snodgrass, Quintus Curtius, 1835-1910"
],
"corporateName":"International Business Machines Corporation",
"sftCorporateName":[
"Oklahoma. Council on Juvenile Delinquency",
"Oklahoma. Oklahoma Council on Juvenile Delinquency"
],
"saftCorporateName":[
"Oklahoma Council on Juvenile Delinquency Planning",
"Oklahoma Council on Juvenile Justice"
],
"meetingName":"Olympic Winter Games (21st : 2010 : Vancouver, B.C.)",
"sftMeetingName":[
"Vancouver Winter Games (2010 : Vancouver, B.C.)"
],
"saftMeetingName":[
],
"uniformTitle":"Monograph (Institute of Applied Social and Economic Research)",
"sftUniformTitle":[
"Monographs (Institute of Applied Social and Economic Research)",
"Monograph series (Institute of Applied Social and Economic Research)",
"IASER monograph"
],
"saftUniformTitle":[
"Continues (work): New Guinea research bulletin",
"Continued by (work): Monograph (National Research Institute (Papua New Guinea))"
],
"topicalTerm":"Optical disks",
"sftTopicalTerm":[
"Discs, Optical",
"Optical discs",
"Laser discs",
"Laser disks",
"Laserdiscs",
"Laserdisks"
],
"saftTopicalTerm":[
"Optical storage devices"
],
"subjectHeadings":"z",
"geographicName":"Great Lakes",
"sftGeographicName":[
"Great Lakes",
"Lakes Great",
"Regions of the United States"
],
"saftGeographicName":[
"Superior, Michigan, Huron, Erie, and Ontario"
],
"genreTerm":"Panoramas",
"sftGenreTerm":[
"Panoramic views"
],
"saftGenreTerm":[
],
"identifiers":[
{
"identifierTypeId":"11bf5f7c-30e1-4308-8170-1fbb5b817cf2",
"value":"955335"
},
{
"identifierTypeId":"a6b2e7a4-d8fc-46b4-ac86-7bee3557f9c6",
"value":"79021164"
},
{
"identifierTypeId":"e32dd8fe-6582-4161-a56c-9dfe4415517e",
"value":"0000000121491740"
},
{
"identifierTypeId":"bc3e4c14-2412-49d4-9132-386f3aab243e",
"value":"(OCoLC)oca00254964"
}
],
"notes":[
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Machine-derived non-Latin script reference project."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Non-Latin script references not evaluated."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Pseudonym not established: Jean François Alden"
}
],
"metadata":{
"createdDate":"2020-10-09T16:47:22.072+0000",
"updatedDate":"2020-10-09T16:47:49.703+0000",
"createdByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2",
"updatedByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2"
}
}
HTTP status code 404
Authority with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"authority not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /authority-storage/authorities/{authorityId}
Delete authority Authority with given {authorityId}
URI Parameters
- authorityId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Authority deleted successfully
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to delete authority -- constraint violation"
HTTP status code 404
Authority with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"authority not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorput /authority-storage/authorities/{authorityId}
Update authority Authority with given {authorityId}
URI Parameters
- authorityId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An authority record",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Authority UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"_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)",
"enum": [
"MARC",
"FOLIO"
],
"readonly": true
},
"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": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"required": [
"value",
"identifierTypeId"
]
}
},
"notes": {
"type": "array",
"description": "Notes (e.g. nonpublic general note)",
"items": {
"type": "object",
"properties": {
"noteTypeId": {
"description": "ID of the type of note",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
}
},
"required": [
"note",
"noteTypeId"
]
}
},
"sourceFileId": {
"type": "string",
"description": "Authority source file id; UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"naturalId": {
"type": "string",
"description": "Authority Natural ID"
},
"metadata": {
"type": "object",
"description": "Creater, updater, creation date, last updated date",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"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",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}Example:
{
"id":"5f671674-229a-48e9-804e-d2814cddd321",
"_version": 0,
"personalName":"Twain, Mark, 1835-1910",
"sftPersonalName":[
"Tuėĭn, Mark, 1835-1910",
"Tuwayn, Mārk, 1835-1910",
"Tʻu-wen, Ma-kʻo, 1835-1910",
"Твен, Марк, 1835-1910"
],
"saftPersonalName":[
"nnn, Clemens, Samuel Langhorne, 1835-1910",
"nnn, Snodgrass, Quintus Curtius, 1835-1910"
],
"corporateName":"International Business Machines Corporation",
"sftCorporateName":[
"Oklahoma. Council on Juvenile Delinquency",
"Oklahoma. Oklahoma Council on Juvenile Delinquency"
],
"saftCorporateName":[
"Oklahoma Council on Juvenile Delinquency Planning",
"Oklahoma Council on Juvenile Justice"
],
"meetingName":"Olympic Winter Games (21st : 2010 : Vancouver, B.C.)",
"sftMeetingName":[
"Vancouver Winter Games (2010 : Vancouver, B.C.)"
],
"saftMeetingName":[
],
"uniformTitle":"Monograph (Institute of Applied Social and Economic Research)",
"sftUniformTitle":[
"Monographs (Institute of Applied Social and Economic Research)",
"Monograph series (Institute of Applied Social and Economic Research)",
"IASER monograph"
],
"saftUniformTitle":[
"Continues (work): New Guinea research bulletin",
"Continued by (work): Monograph (National Research Institute (Papua New Guinea))"
],
"topicalTerm":"Optical disks",
"sftTopicalTerm":[
"Discs, Optical",
"Optical discs",
"Laser discs",
"Laser disks",
"Laserdiscs",
"Laserdisks"
],
"saftTopicalTerm":[
"Optical storage devices"
],
"subjectHeadings":"z",
"geographicName":"Great Lakes",
"sftGeographicName":[
"Great Lakes",
"Lakes Great",
"Regions of the United States"
],
"saftGeographicName":[
"Superior, Michigan, Huron, Erie, and Ontario"
],
"genreTerm":"Panoramas",
"sftGenreTerm":[
"Panoramic views"
],
"saftGenreTerm":[
],
"identifiers":[
{
"identifierTypeId":"11bf5f7c-30e1-4308-8170-1fbb5b817cf2",
"value":"955335"
},
{
"identifierTypeId":"a6b2e7a4-d8fc-46b4-ac86-7bee3557f9c6",
"value":"79021164"
},
{
"identifierTypeId":"e32dd8fe-6582-4161-a56c-9dfe4415517e",
"value":"0000000121491740"
},
{
"identifierTypeId":"bc3e4c14-2412-49d4-9132-386f3aab243e",
"value":"(OCoLC)oca00254964"
}
],
"notes":[
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Machine-derived non-Latin script reference project."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Non-Latin script references not evaluated."
},
{
"noteTypeId":"d95deec9-6bf5-47c2-b784-96e1ce6ed975",
"value":"Pseudonym not established: Jean François Alden"
}
],
"metadata":{
"createdDate":"2020-10-09T16:47:22.072+0000",
"updatedDate":"2020-10-09T16:47:49.703+0000",
"createdByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2",
"updatedByUserId":"39720b69-3141-5eb8-95c8-d3bf17eb99d2"
}
}
HTTP status code 204
Authority successfully updated
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to update authority -- malformed JSON at 13:4"
HTTP status code 404
Authority with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"authority not found"
HTTP status code 409
Optimistic locking version conflict
Body
Media type: text/plain
Type: any
Example:
version conflictHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administrator