API docs by Redocly

Entities Links API (v1.0)

Entity Links API

countLinksByAuthorityIds

Retrieve number of links by authority IDs

Request Body schema: application/json
required
ids
required
Array of strings <uuid> (uuid) [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "links": [
    ]
}

linking-rules

getInstanceAuthorityLinkingRules

Retrieve instance-authority linking rules

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getInstanceAuthorityLinkingRuleById

Retrieve instance-authority linking rule by ID

path Parameters
ruleId
required
integer

ID of the instance-authority linking rule

Responses

Response samples

Content type
application/json
{
  • "autoLinkingEnabled": true,
  • "bibField": "bibField",
  • "subfieldModifications": [
    ],
  • "authoritySubfields": [
    ],
  • "id": 0,
  • "validation": {
    },
  • "authorityField": "authorityField"
}

patchInstanceAuthorityLinkingRuleById

Partially update instance-authority linking rule by ID

path Parameters
ruleId
required
integer

ID of the instance-authority linking rule

Request Body schema: application/json
required
id
integer
autoLinkingEnabled
boolean
authoritySubfields
Array of strings (charString) unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "autoLinkingEnabled": true,
  • "authoritySubfields": [
    ]
}

Response samples

Content type
application/json
{
  • "autoLinkingEnabled": true,
  • "bibField": "bibField",
  • "subfieldModifications": [
    ],
  • "authoritySubfields": [
    ],
  • "id": 0,
  • "validation": {
    },
  • "authorityField": "authorityField"
}

authority-storage

retrieveAuthorities

query Parameters
deleted
boolean
Default: false

Indicates if only deleted authority records should be retrieved

idOnly
boolean
Default: false

Indicates if only IDs of authority records should be retrieved

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 2000 ]
Default: 100

Limit the number of elements returned in the response.

query
string
Default: "cql.allRecords=1"

A query expressed as a CQL string (see 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

header Parameters
Accept
Array of strings
Default: application/json

Specifies accepting media-types for the response

Responses

Response samples

Content type
"examples/authorities.sample"

createAuthority

Request Body schema: application/json
id
string <uuid>

Authority UUID

_version
integer

Record version for optimistic locking

source
required
string

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
string

Heading personal name

sftPersonalName
Array of strings

See from tracing personal name

saftPersonalName
Array of strings

See also from tracing personal name

personalNameTitle
string

Heading personal name title

sftPersonalNameTitle
Array of strings

See from tracing personal name title

saftPersonalNameTitle
Array of strings

See also from tracing personal name title

corporateName
string

Heading corporate name

sftCorporateName
Array of strings

See from tracing corporate name

saftCorporateName
Array of strings

See also from tracing corporate name

corporateNameTitle
string

Heading corporate name title

sftCorporateNameTitle
Array of strings

See from tracing corporate name title

saftCorporateNameTitle
Array of strings

See also from tracing corporate name title

meetingName
string

Heading meeting name

sftMeetingName
Array of strings

See from tracing meeting name

saftMeetingName
Array of strings

See also from tracing meeting name

meetingNameTitle
string

Heading meeting name title

sftMeetingNameTitle
Array of strings

See from tracing meeting name title

saftMeetingNameTitle
Array of strings

See also from tracing meeting name title

uniformTitle
string

Heading uniform title

sftUniformTitle
Array of strings

See from tracing uniform title

saftUniformTitle
Array of strings

See also from tracing uniform title

namedEvent
string

Heading named event

sftNamedEvent
Array of strings

See from tracing named event

saftNamedEvent
Array of strings

See also from tracing named event

topicalTerm
string

Heading topical term

sftTopicalTerm
Array of strings

See from tracing topical term

saftTopicalTerm
Array of strings

See also from tracing topical term

subjectHeadings
string

Children's subject headings

geographicName
string

Heading geographic name

sftGeographicName
Array of strings

See from tracing geographic name

saftGeographicName
Array of strings

See also from tracing geographic name

genreTerm
string

Heading genre/form term

sftGenreTerm
Array of strings

See from tracing genre/form term

saftGenreTerm
Array of strings

See also from tracing genre/form term

chronTerm
string

Heading chronological term

sftChronTerm
Array of strings

See from tracing chronological term

saftChronTerm
Array of strings

See also from tracing chronological term

mediumPerfTerm
string

Heading medium of performance term

sftMediumPerfTerm
Array of strings

See from tracing medium of performance term

saftMediumPerfTerm
Array of strings

See also from tracing medium of performance term

generalSubdivision
string

Heading general subdivision term

sftGeneralSubdivision
Array of strings

See from tracing general subdivision term

saftGeneralSubdivision
Array of strings

See also from tracing general subdivision term

geographicSubdivision
string

Heading geographic subdivision term

sftGeographicSubdivision
Array of strings

See from tracing geographic subdivision term

saftGeographicSubdivision
Array of strings

See also from tracing geographic subdivision term

chronSubdivision
string

Heading chronological subdivision term

sftChronSubdivision
Array of strings

See from tracing chronological subdivision term

saftChronSubdivision
Array of strings

See also from tracing chronological subdivision term

formSubdivision
string

Heading form subdivision term

sftFormSubdivision
Array of strings

See from tracing form subdivision term

saftFormSubdivision
Array of strings

See also from tracing form subdivision term

Array of objects (relatedHeading)

See also from tracing term that represents broader, more general concepts related to the authority record

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

Array of objects (relatedHeading)

See also from tracing term that that represents narrower, more specific concepts derived from the authority record

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

Array of objects (relatedHeading)

See also from tracing heading that was previously used to represent the concept or entity described by the authority record. This field is used to track the evolution of terms or headings over time, facilitating the linking of historical and current data.

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

Array of objects (relatedHeading)

See also from tracing heading that replaced the current heading used in the authority record. This field helps in maintaining the continuity of catalog records by linking past headings to their more current versions.

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

saftPersonalNameTrunc
Array of strings

See also from tracing personal name

saftPersonalNameTitleTrunc
Array of strings

See also from tracing personal name title

saftCorporateNameTrunc
Array of strings

See also from tracing corporate name

saftCorporateNameTitleTrunc
Array of strings

See also from tracing corporate name title

saftMeetingNameTrunc
Array of strings

See also from tracing meeting name

saftMeetingNameTitleTrunc
Array of strings

See also from tracing meeting name title

saftUniformTitleTrunc
Array of strings

See also from tracing uniform title

saftTopicalTermTrunc
Array of strings

See also from tracing topical term

saftGenreTermTrunc
Array of strings

See also from tracing genre/form term

saftGeographicNameTrunc
Array of strings

See also from tracing geographic name

saftNamedEventTrunc
Array of strings

See also from tracing named event

saftChronTermTrunc
Array of strings

See also from tracing chronological term

saftMediumPerfTermTrunc
Array of strings

See also from tracing medium of performance term

saftGeneralSubdivisionTrunc
Array of strings

See also from tracing general subdivision term

saftGeographicSubdivisionTrunc
Array of strings

See also from tracing geographic subdivision term

saftChronSubdivisionTrunc
Array of strings

See also from tracing chronological subdivision term

saftFormSubdivisionTrunc
Array of strings

See also from tracing form subdivision term

Array of objects (authorityDtoIdentifier)

An extensible set of name-value pairs of identifiers associated with the resource

Array
value
required
string

Resource identifier value

identifierTypeId
required
string <uuid>

Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)

Array of objects (authorityDtoNote)

Notes (e.g. nonpublic general note)

Array
noteTypeId
required
string <uuid>

ID of the type of note

note
required
string

Text content of the note

staffOnly
boolean
sourceFileId
string <uuid>

Authority source file id; UUID

naturalId
required
string

Authority Natural ID

object (metadata)

Creater, updater, creation date, last updated date

createdDate
string <date-time>

Date and time when the record was created

createdByUserId
string <uuid>

ID of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string <uuid>

ID of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "genreTerm": "genreTerm",
  • "notes": [
    ],
  • "naturalId": "naturalId",
  • "meetingNameTitle": "meetingNameTitle",
  • "saftChronTerm": [
    ],
  • "saftChronSubdivision": [
    ],
  • "sftGeographicName": [
    ],
  • "saftUniformTitleTrunc": [
    ],
  • "source": "source",
  • "mediumPerfTerm": "mediumPerfTerm",
  • "corporateName": "corporateName",
  • "generalSubdivision": "generalSubdivision",
  • "saftMeetingNameTrunc": [
    ],
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "chronSubdivision": "chronSubdivision",
  • "saftNamedEventTrunc": [
    ],
  • "_version": 0,
  • "sftCorporateName": [
    ],
  • "sftChronSubdivision": [
    ],
  • "saftMeetingName": [
    ],
  • "sftPersonalName": [
    ],
  • "saftEarlierHeading": [
    ],
  • "saftCorporateNameTitleTrunc": [
    ],
  • "saftGeneralSubdivisionTrunc": [
    ],
  • "saftGeographicSubdivision": [
    ],
  • "saftFormSubdivision": [
    ],
  • "saftCorporateNameTitle": [
    ],
  • "formSubdivision": "formSubdivision",
  • "sftMeetingName": [
    ],
  • "saftMediumPerfTermTrunc": [
    ],
  • "sftNamedEvent": [
    ],
  • "meetingName": "meetingName",
  • "namedEvent": "namedEvent",
  • "sftGenreTerm": [
    ],
  • "saftNamedEvent": [
    ],
  • "saftChronTermTrunc": [
    ],
  • "saftGenreTerm": [
    ],
  • "saftUniformTitle": [
    ],
  • "sftUniformTitle": [
    ],
  • "sftTopicalTerm": [
    ],
  • "geographicName": "geographicName",
  • "saftPersonalNameTitleTrunc": [
    ],
  • "saftCorporateName": [
    ],
  • "topicalTerm": "topicalTerm",
  • "sftMediumPerfTerm": [
    ],
  • "sftMeetingNameTitle": [
    ],
  • "saftTopicalTerm": [
    ],
  • "chronTerm": "chronTerm",
  • "saftGeneralSubdivision": [
    ],
  • "saftBroaderTerm": [
    ],
  • "sftFormSubdivision": [
    ],
  • "saftPersonalNameTitle": [
    ],
  • "subjectHeadings": "subjectHeadings",
  • "uniformTitle": "uniformTitle",
  • "saftFormSubdivisionTrunc": [
    ],
  • "sftGeneralSubdivision": [
    ],
  • "saftNarrowerTerm": [
    ],
  • "saftGeographicNameTrunc": [
    ],
  • "saftPersonalName": [
    ],
  • "sftPersonalNameTitle": [
    ],
  • "identifiers": [
    ],
  • "sftChronTerm": [
    ],
  • "sourceFileId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "saftLaterHeading": [
    ],
  • "saftGenreTermTrunc": [
    ],
  • "saftPersonalNameTrunc": [
    ],
  • "saftMeetingNameTitleTrunc": [
    ],
  • "sftCorporateNameTitle": [
    ],
  • "sftGeographicSubdivision": [
    ],
  • "personalNameTitle": "personalNameTitle",
  • "saftCorporateNameTrunc": [
    ],
  • "saftGeographicSubdivisionTrunc": [
    ],
  • "corporateNameTitle": "corporateNameTitle",
  • "saftMediumPerfTerm": [
    ],
  • "saftMeetingNameTitle": [
    ],
  • "geographicSubdivision": "geographicSubdivision",
  • "personalName": "personalName",
  • "saftGeographicName": [
    ],
  • "saftTopicalTermTrunc": [
    ],
  • "saftChronSubdivisionTrunc": [
    ]
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "genreTerm": "genreTerm",
  • "notes": [
    ],
  • "naturalId": "naturalId",
  • "meetingNameTitle": "meetingNameTitle",
  • "saftChronTerm": [
    ],
  • "saftChronSubdivision": [
    ],
  • "sftGeographicName": [
    ],
  • "saftUniformTitleTrunc": [
    ],
  • "source": "source",
  • "mediumPerfTerm": "mediumPerfTerm",
  • "corporateName": "corporateName",
  • "generalSubdivision": "generalSubdivision",
  • "saftMeetingNameTrunc": [
    ],
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "chronSubdivision": "chronSubdivision",
  • "saftNamedEventTrunc": [
    ],
  • "_version": 0,
  • "sftCorporateName": [
    ],
  • "sftChronSubdivision": [
    ],
  • "saftMeetingName": [
    ],
  • "sftPersonalName": [
    ],
  • "saftEarlierHeading": [
    ],
  • "saftCorporateNameTitleTrunc": [
    ],
  • "saftGeneralSubdivisionTrunc": [
    ],
  • "saftGeographicSubdivision": [
    ],
  • "saftFormSubdivision": [
    ],
  • "saftCorporateNameTitle": [
    ],
  • "formSubdivision": "formSubdivision",
  • "sftMeetingName": [
    ],
  • "saftMediumPerfTermTrunc": [
    ],
  • "sftNamedEvent": [
    ],
  • "meetingName": "meetingName",
  • "namedEvent": "namedEvent",
  • "sftGenreTerm": [
    ],
  • "saftNamedEvent": [
    ],
  • "saftChronTermTrunc": [
    ],
  • "saftGenreTerm": [
    ],
  • "saftUniformTitle": [
    ],
  • "sftUniformTitle": [
    ],
  • "sftTopicalTerm": [
    ],
  • "geographicName": "geographicName",
  • "saftPersonalNameTitleTrunc": [
    ],
  • "saftCorporateName": [
    ],
  • "topicalTerm": "topicalTerm",
  • "sftMediumPerfTerm": [
    ],
  • "sftMeetingNameTitle": [
    ],
  • "saftTopicalTerm": [
    ],
  • "chronTerm": "chronTerm",
  • "saftGeneralSubdivision": [
    ],
  • "saftBroaderTerm": [
    ],
  • "sftFormSubdivision": [
    ],
  • "saftPersonalNameTitle": [
    ],
  • "subjectHeadings": "subjectHeadings",
  • "uniformTitle": "uniformTitle",
  • "saftFormSubdivisionTrunc": [
    ],
  • "sftGeneralSubdivision": [
    ],
  • "saftNarrowerTerm": [
    ],
  • "saftGeographicNameTrunc": [
    ],
  • "saftPersonalName": [
    ],
  • "sftPersonalNameTitle": [
    ],
  • "identifiers": [
    ],
  • "sftChronTerm": [
    ],
  • "sourceFileId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "saftLaterHeading": [
    ],
  • "saftGenreTermTrunc": [
    ],
  • "saftPersonalNameTrunc": [
    ],
  • "saftMeetingNameTitleTrunc": [
    ],
  • "sftCorporateNameTitle": [
    ],
  • "sftGeographicSubdivision": [
    ],
  • "personalNameTitle": "personalNameTitle",
  • "saftCorporateNameTrunc": [
    ],
  • "saftGeographicSubdivisionTrunc": [
    ],
  • "corporateNameTitle": "corporateNameTitle",
  • "saftMediumPerfTerm": [
    ],
  • "saftMeetingNameTitle": [
    ],
  • "geographicSubdivision": "geographicSubdivision",
  • "personalName": "personalName",
  • "saftGeographicName": [
    ],
  • "saftTopicalTermTrunc": [
    ],
  • "saftChronSubdivisionTrunc": [
    ]
}

createAuthorityBulk

Request Body schema: application/json
recordsFileName
required
string

File name of authority records

Responses

Request samples

Content type
application/json
{
  • "recordsFileName": "string"
}

Response samples

Content type
application/json
{
  • "errorsFileName": "errorsFileName",
  • "errorsNumber": 0,
  • "errorRecordsFileName": "errorRecordsFileName"
}

deleteAuthority

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "Error": {
    }
}

getAuthority

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "genreTerm": "genreTerm",
  • "notes": [
    ],
  • "naturalId": "naturalId",
  • "meetingNameTitle": "meetingNameTitle",
  • "saftChronTerm": [
    ],
  • "saftChronSubdivision": [
    ],
  • "sftGeographicName": [
    ],
  • "saftUniformTitleTrunc": [
    ],
  • "source": "source",
  • "mediumPerfTerm": "mediumPerfTerm",
  • "corporateName": "corporateName",
  • "generalSubdivision": "generalSubdivision",
  • "saftMeetingNameTrunc": [
    ],
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "chronSubdivision": "chronSubdivision",
  • "saftNamedEventTrunc": [
    ],
  • "_version": 0,
  • "sftCorporateName": [
    ],
  • "sftChronSubdivision": [
    ],
  • "saftMeetingName": [
    ],
  • "sftPersonalName": [
    ],
  • "saftEarlierHeading": [
    ],
  • "saftCorporateNameTitleTrunc": [
    ],
  • "saftGeneralSubdivisionTrunc": [
    ],
  • "saftGeographicSubdivision": [
    ],
  • "saftFormSubdivision": [
    ],
  • "saftCorporateNameTitle": [
    ],
  • "formSubdivision": "formSubdivision",
  • "sftMeetingName": [
    ],
  • "saftMediumPerfTermTrunc": [
    ],
  • "sftNamedEvent": [
    ],
  • "meetingName": "meetingName",
  • "namedEvent": "namedEvent",
  • "sftGenreTerm": [
    ],
  • "saftNamedEvent": [
    ],
  • "saftChronTermTrunc": [
    ],
  • "saftGenreTerm": [
    ],
  • "saftUniformTitle": [
    ],
  • "sftUniformTitle": [
    ],
  • "sftTopicalTerm": [
    ],
  • "geographicName": "geographicName",
  • "saftPersonalNameTitleTrunc": [
    ],
  • "saftCorporateName": [
    ],
  • "topicalTerm": "topicalTerm",
  • "sftMediumPerfTerm": [
    ],
  • "sftMeetingNameTitle": [
    ],
  • "saftTopicalTerm": [
    ],
  • "chronTerm": "chronTerm",
  • "saftGeneralSubdivision": [
    ],
  • "saftBroaderTerm": [
    ],
  • "sftFormSubdivision": [
    ],
  • "saftPersonalNameTitle": [
    ],
  • "subjectHeadings": "subjectHeadings",
  • "uniformTitle": "uniformTitle",
  • "saftFormSubdivisionTrunc": [
    ],
  • "sftGeneralSubdivision": [
    ],
  • "saftNarrowerTerm": [
    ],
  • "saftGeographicNameTrunc": [
    ],
  • "saftPersonalName": [
    ],
  • "sftPersonalNameTitle": [
    ],
  • "identifiers": [
    ],
  • "sftChronTerm": [
    ],
  • "sourceFileId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "saftLaterHeading": [
    ],
  • "saftGenreTermTrunc": [
    ],
  • "saftPersonalNameTrunc": [
    ],
  • "saftMeetingNameTitleTrunc": [
    ],
  • "sftCorporateNameTitle": [
    ],
  • "sftGeographicSubdivision": [
    ],
  • "personalNameTitle": "personalNameTitle",
  • "saftCorporateNameTrunc": [
    ],
  • "saftGeographicSubdivisionTrunc": [
    ],
  • "corporateNameTitle": "corporateNameTitle",
  • "saftMediumPerfTerm": [
    ],
  • "saftMeetingNameTitle": [
    ],
  • "geographicSubdivision": "geographicSubdivision",
  • "personalName": "personalName",
  • "saftGeographicName": [
    ],
  • "saftTopicalTermTrunc": [
    ],
  • "saftChronSubdivisionTrunc": [
    ]
}

updateAuthority

path Parameters
id
required
string <uuid>

The UUID of a record

Request Body schema: application/json
id
string <uuid>

Authority UUID

_version
integer

Record version for optimistic locking

source
required
string

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
string

Heading personal name

sftPersonalName
Array of strings

See from tracing personal name

saftPersonalName
Array of strings

See also from tracing personal name

personalNameTitle
string

Heading personal name title

sftPersonalNameTitle
Array of strings

See from tracing personal name title

saftPersonalNameTitle
Array of strings

See also from tracing personal name title

corporateName
string

Heading corporate name

sftCorporateName
Array of strings

See from tracing corporate name

saftCorporateName
Array of strings

See also from tracing corporate name

corporateNameTitle
string

Heading corporate name title

sftCorporateNameTitle
Array of strings

See from tracing corporate name title

saftCorporateNameTitle
Array of strings

See also from tracing corporate name title

meetingName
string

Heading meeting name

sftMeetingName
Array of strings

See from tracing meeting name

saftMeetingName
Array of strings

See also from tracing meeting name

meetingNameTitle
string

Heading meeting name title

sftMeetingNameTitle
Array of strings

See from tracing meeting name title

saftMeetingNameTitle
Array of strings

See also from tracing meeting name title

uniformTitle
string

Heading uniform title

sftUniformTitle
Array of strings

See from tracing uniform title

saftUniformTitle
Array of strings

See also from tracing uniform title

namedEvent
string

Heading named event

sftNamedEvent
Array of strings

See from tracing named event

saftNamedEvent
Array of strings

See also from tracing named event

topicalTerm
string

Heading topical term

sftTopicalTerm
Array of strings

See from tracing topical term

saftTopicalTerm
Array of strings

See also from tracing topical term

subjectHeadings
string

Children's subject headings

geographicName
string

Heading geographic name

sftGeographicName
Array of strings

See from tracing geographic name

saftGeographicName
Array of strings

See also from tracing geographic name

genreTerm
string

Heading genre/form term

sftGenreTerm
Array of strings

See from tracing genre/form term

saftGenreTerm
Array of strings

See also from tracing genre/form term

chronTerm
string

Heading chronological term

sftChronTerm
Array of strings

See from tracing chronological term

saftChronTerm
Array of strings

See also from tracing chronological term

mediumPerfTerm
string

Heading medium of performance term

sftMediumPerfTerm
Array of strings

See from tracing medium of performance term

saftMediumPerfTerm
Array of strings

See also from tracing medium of performance term

generalSubdivision
string

Heading general subdivision term

sftGeneralSubdivision
Array of strings

See from tracing general subdivision term

saftGeneralSubdivision
Array of strings

See also from tracing general subdivision term

geographicSubdivision
string

Heading geographic subdivision term

sftGeographicSubdivision
Array of strings

See from tracing geographic subdivision term

saftGeographicSubdivision
Array of strings

See also from tracing geographic subdivision term

chronSubdivision
string

Heading chronological subdivision term

sftChronSubdivision
Array of strings

See from tracing chronological subdivision term

saftChronSubdivision
Array of strings

See also from tracing chronological subdivision term

formSubdivision
string

Heading form subdivision term

sftFormSubdivision
Array of strings

See from tracing form subdivision term

saftFormSubdivision
Array of strings

See also from tracing form subdivision term

Array of objects (relatedHeading)

See also from tracing term that represents broader, more general concepts related to the authority record

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

Array of objects (relatedHeading)

See also from tracing term that that represents narrower, more specific concepts derived from the authority record

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

Array of objects (relatedHeading)

See also from tracing heading that was previously used to represent the concept or entity described by the authority record. This field is used to track the evolution of terms or headings over time, facilitating the linking of historical and current data.

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

Array of objects (relatedHeading)

See also from tracing heading that replaced the current heading used in the authority record. This field helps in maintaining the continuity of catalog records by linking past headings to their more current versions.

Array
headingRef
required
string

HeadingRef value

headingType
required
string

Heading type

saftPersonalNameTrunc
Array of strings

See also from tracing personal name

saftPersonalNameTitleTrunc
Array of strings

See also from tracing personal name title

saftCorporateNameTrunc
Array of strings

See also from tracing corporate name

saftCorporateNameTitleTrunc
Array of strings

See also from tracing corporate name title

saftMeetingNameTrunc
Array of strings

See also from tracing meeting name

saftMeetingNameTitleTrunc
Array of strings

See also from tracing meeting name title

saftUniformTitleTrunc
Array of strings

See also from tracing uniform title

saftTopicalTermTrunc
Array of strings

See also from tracing topical term

saftGenreTermTrunc
Array of strings

See also from tracing genre/form term

saftGeographicNameTrunc
Array of strings

See also from tracing geographic name

saftNamedEventTrunc
Array of strings

See also from tracing named event

saftChronTermTrunc
Array of strings

See also from tracing chronological term

saftMediumPerfTermTrunc
Array of strings

See also from tracing medium of performance term

saftGeneralSubdivisionTrunc
Array of strings

See also from tracing general subdivision term

saftGeographicSubdivisionTrunc
Array of strings

See also from tracing geographic subdivision term

saftChronSubdivisionTrunc
Array of strings

See also from tracing chronological subdivision term

saftFormSubdivisionTrunc
Array of strings

See also from tracing form subdivision term

Array of objects (authorityDtoIdentifier)

An extensible set of name-value pairs of identifiers associated with the resource

Array
value
required
string

Resource identifier value

identifierTypeId
required
string <uuid>

Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number)

Array of objects (authorityDtoNote)

Notes (e.g. nonpublic general note)

Array
noteTypeId
required
string <uuid>

ID of the type of note

note
required
string

Text content of the note

staffOnly
boolean
sourceFileId
string <uuid>

Authority source file id; UUID

naturalId
required
string

Authority Natural ID

object (metadata)

Creater, updater, creation date, last updated date

createdDate
string <date-time>

Date and time when the record was created

createdByUserId
string <uuid>

ID of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string <uuid>

ID of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "genreTerm": "genreTerm",
  • "notes": [
    ],
  • "naturalId": "naturalId",
  • "meetingNameTitle": "meetingNameTitle",
  • "saftChronTerm": [
    ],
  • "saftChronSubdivision": [
    ],
  • "sftGeographicName": [
    ],
  • "saftUniformTitleTrunc": [
    ],
  • "source": "source",
  • "mediumPerfTerm": "mediumPerfTerm",
  • "corporateName": "corporateName",
  • "generalSubdivision": "generalSubdivision",
  • "saftMeetingNameTrunc": [
    ],
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "chronSubdivision": "chronSubdivision",
  • "saftNamedEventTrunc": [
    ],
  • "_version": 0,
  • "sftCorporateName": [
    ],
  • "sftChronSubdivision": [
    ],
  • "saftMeetingName": [
    ],
  • "sftPersonalName": [
    ],
  • "saftEarlierHeading": [
    ],
  • "saftCorporateNameTitleTrunc": [
    ],
  • "saftGeneralSubdivisionTrunc": [
    ],
  • "saftGeographicSubdivision": [
    ],
  • "saftFormSubdivision": [
    ],
  • "saftCorporateNameTitle": [
    ],
  • "formSubdivision": "formSubdivision",
  • "sftMeetingName": [
    ],
  • "saftMediumPerfTermTrunc": [
    ],
  • "sftNamedEvent": [
    ],
  • "meetingName": "meetingName",
  • "namedEvent": "namedEvent",
  • "sftGenreTerm": [
    ],
  • "saftNamedEvent": [
    ],
  • "saftChronTermTrunc": [
    ],
  • "saftGenreTerm": [
    ],
  • "saftUniformTitle": [
    ],
  • "sftUniformTitle": [
    ],
  • "sftTopicalTerm": [
    ],
  • "geographicName": "geographicName",
  • "saftPersonalNameTitleTrunc": [
    ],
  • "saftCorporateName": [
    ],
  • "topicalTerm": "topicalTerm",
  • "sftMediumPerfTerm": [
    ],
  • "sftMeetingNameTitle": [
    ],
  • "saftTopicalTerm": [
    ],
  • "chronTerm": "chronTerm",
  • "saftGeneralSubdivision": [
    ],
  • "saftBroaderTerm": [
    ],
  • "sftFormSubdivision": [
    ],
  • "saftPersonalNameTitle": [
    ],
  • "subjectHeadings": "subjectHeadings",
  • "uniformTitle": "uniformTitle",
  • "saftFormSubdivisionTrunc": [
    ],
  • "sftGeneralSubdivision": [
    ],
  • "saftNarrowerTerm": [
    ],
  • "saftGeographicNameTrunc": [
    ],
  • "saftPersonalName": [
    ],
  • "sftPersonalNameTitle": [
    ],
  • "identifiers": [
    ],
  • "sftChronTerm": [
    ],
  • "sourceFileId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "saftLaterHeading": [
    ],
  • "saftGenreTermTrunc": [
    ],
  • "saftPersonalNameTrunc": [
    ],
  • "saftMeetingNameTitleTrunc": [
    ],
  • "sftCorporateNameTitle": [
    ],
  • "sftGeographicSubdivision": [
    ],
  • "personalNameTitle": "personalNameTitle",
  • "saftCorporateNameTrunc": [
    ],
  • "saftGeographicSubdivisionTrunc": [
    ],
  • "corporateNameTitle": "corporateNameTitle",
  • "saftMediumPerfTerm": [
    ],
  • "saftMeetingNameTitle": [
    ],
  • "geographicSubdivision": "geographicSubdivision",
  • "personalName": "personalName",
  • "saftGeographicName": [
    ],
  • "saftTopicalTermTrunc": [
    ],
  • "saftChronSubdivisionTrunc": [
    ]
}

Response samples

Content type
application/json
{
  • "Error": {
    }
}

authority-storage-reindex

getReindexJobs

query Parameters
query
string
Default: "cql.allRecords=1"

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.

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 2000 ]
Default: 100

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
"examples/authorities.sample"

submitReindexJob

Responses

Response samples

Content type
application/json
{
  • "jobStatus": "In progress",
  • "resourceName": "Authority",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "published": 0,
  • "submittedDate": "2000-01-23T04:56:07.000+00:00"
}

deleteReindexJob

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "Error": {
    }
}

getReindexJob

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "jobStatus": "In progress",
  • "resourceName": "Authority",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "published": 0,
  • "submittedDate": "2000-01-23T04:56:07.000+00:00"
}

authority-note-type

retrieveAuthorityNoteTypes

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 2000 ]
Default: 100

Limit the number of elements returned in the response.

query
string
Default: "cql.allRecords=1"

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.

Responses

Response samples

Content type
application/json
"examples/authorities.sample"

createAuthorityNoteType

Request Body schema: application/json
id
string <uuid>

Unique ID of the Authority note type; a UUID

name
required
string

Name of the Authority note type

source
required
string

label indicating where the Authority note type entry originates from, i.e. 'folio' or 'local'

object (metadata)

Creater, updater, creation date, last updated date

createdDate
string <date-time>

Date and time when the record was created

createdByUserId
string <uuid>

ID of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string <uuid>

ID of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "name": "name",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "source": "source"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "name": "name",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "source": "source"
}

deleteAuthorityNoteType

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "Error": {
    }
}

getAuthorityNoteType

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "name": "name",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "source": "source"
}

updateAuthorityNoteType

path Parameters
id
required
string <uuid>

The UUID of a record

Request Body schema: application/json
id
string <uuid>

Unique ID of the Authority note type; a UUID

name
required
string

Name of the Authority note type

source
required
string

label indicating where the Authority note type entry originates from, i.e. 'folio' or 'local'

object (metadata)

Creater, updater, creation date, last updated date

createdDate
string <date-time>

Date and time when the record was created

createdByUserId
string <uuid>

ID of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string <uuid>

ID of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "name": "name",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "source": "source"
}

Response samples

Content type
application/json
{
  • "Error": {
    }
}

authority-source-file

retrieveAuthoritySourceFiles

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 2000 ]
Default: 100

Limit the number of elements returned in the response.

query
string
Default: "cql.allRecords=1"

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.

Responses

Response samples

Content type
application/json
"examples/authorities.sample"

createAuthoritySourceFile

Request Body schema: application/json
id
string <uuid>

Unique ID of the Authority source file; a UUID

name
required
string

Authority source file name

code
required
string [ 1 .. 25 ] characters

Label identifying prefix, i.e. 'n', 'D', 'fst'

type
string

Type of authority records stored in source file

baseUrl
string <url>

Base URL of the source file origin

selectable
boolean
Default: true
object (authoritySourceFilePostDto_hridManagement)

Identifies HRID management properties

startNumber
integer >= 0
Default: 1

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "code": "string",
  • "type": "string",
  • "baseUrl": "string",
  • "selectable": true,
  • "hridManagement": {
    }
}

Response samples

Content type
application/json
{
  • "codes": [
    ],
  • "baseUrl": "http://example.com/aeiou",
  • "metadata": {
    },
  • "hridManagement": {
    },
  • "selectable": true,
  • "name": "name",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "source": "folio",
  • "type": "type",
  • "_version": 6
}

deleteAuthoritySourceFile

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "Error": {
    }
}

getAuthoritySourceFile

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "codes": [
    ],
  • "baseUrl": "http://example.com/aeiou",
  • "metadata": {
    },
  • "hridManagement": {
    },
  • "selectable": true,
  • "name": "name",
  • "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "source": "folio",
  • "type": "type",
  • "_version": 6
}

patchAuthoritySourceFile

path Parameters
id
required
string <uuid>

The UUID of a record

Request Body schema: application/json
name
string

Authority source file name

code
string [ 1 .. 25 ] characters

identifying prefix, i.e. 'n', 'D', 'fst'

type
string

Type of authority records stored in source file

baseUrl
string <url>

Base URL of the source file origin

selectable
boolean
object (authoritySourceFilePatchDto_hridManagement)

Identifies HRID management properties

startNumber
integer >= 0

Start number for HRID generation

_version
required
integer

Record version for optimistic locking

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "type": "string",
  • "baseUrl": "string",
  • "selectable": true,
  • "hridManagement": {
    },
  • "_version": 0
}

Response samples

Content type
application/json
{
  • "Error": {
    }
}

newAuthoritySourceFileNextHrid

path Parameters
id
required
string <uuid>

The UUID of a record

Responses

Response samples

Content type
application/json
{
  • "HridResponse": {
    }
}