openapi: 3.2.0 info: title: Folio Authority Storage API version: v1.0 description: 'Operations tagged authority-storage across 2 of this provider''s published API definitions: folio-mod-entities-links-openapi.json, folio-mod-entities-links-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://localhost:8081 tags: - name: authority-storage paths: /authority-storage/authorities: get: operationId: retrieveAuthorities parameters: - description: Indicates if only deleted authority records should be retrieved in: query name: deleted required: false schema: default: false type: boolean - description: Indicates if only IDs of authority records should be retrieved in: query name: idOnly required: false schema: default: false type: boolean - description: Skip over a number of elements by specifying an offset value for the query. in: query name: offset required: false schema: default: 0 maximum: 2147483647 minimum: 0 type: integer - description: Limit the number of elements returned in the response. in: query name: limit required: false schema: default: 100 maximum: 2000 minimum: 1 type: integer - description: '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' in: query name: query required: false schema: default: cql.allRecords=1 type: string - description: Specifies accepting media-types for the response in: header name: Accept required: false schema: default: application/json items: description: identifies media-type type: string type: array responses: '200': content: application/json: example: examples/authorities.sample schema: $ref: '#/components/schemas/authorityFullDtoCollection' text/plain;charset=utf-8: example: examples/authorities_ids.sample schema: type: string description: Returns a list of authorities '400': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation errors. '500': content: application/json: schema: $ref: '#/components/schemas/errors' description: Internal server error. tags: - authority-storage summary: Retrieve authorities x-summary-source: derived post: operationId: createAuthority requestBody: content: application/json: schema: $ref: '#/components/schemas/authorityDto' responses: '201': content: application/json: schema: $ref: '#/components/schemas/authorityDto' description: Record successfully created '400': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation errors. '422': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation error for the request. '500': content: application/json: schema: $ref: '#/components/schemas/errors' description: Internal server error. tags: - authority-storage summary: Create authority x-summary-source: derived servers: - url: https://localhost:8081 /authority-storage/authorities/bulk: post: operationId: createAuthorityBulk requestBody: content: application/json: schema: $ref: '#/components/schemas/authorityBulkRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/authorityBulkResponse' description: Record successfully created '400': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation errors. '422': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation error for the request. '500': content: application/json: schema: $ref: '#/components/schemas/errors' description: Internal server error. tags: - authority-storage summary: Create authority bulk x-summary-source: derived servers: - url: https://localhost:8081 /authority-storage/authorities/{id}: delete: operationId: deleteAuthority parameters: - description: The UUID of a record in: path name: id required: true schema: format: uuid type: string responses: '204': description: Record successfully deleted '400': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation errors. '404': content: application/json: schema: $ref: '#/components/schemas/errors' description: Record was not found. '500': content: application/json: schema: $ref: '#/components/schemas/errors' description: Internal server error. tags: - authority-storage summary: Delete authority x-summary-source: derived get: operationId: getAuthority parameters: - description: The UUID of a record in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/authorityDto' description: Retrieved record '400': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation errors. '404': content: application/json: schema: $ref: '#/components/schemas/errors' description: Record was not found. '500': content: application/json: schema: $ref: '#/components/schemas/errors' description: Internal server error. tags: - authority-storage summary: Get authority x-summary-source: derived put: operationId: updateAuthority parameters: - description: The UUID of a record in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/authorityDto' responses: '204': description: Record successfully updated '400': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation errors. '404': content: application/json: schema: $ref: '#/components/schemas/errors' description: Record was not found. '422': content: application/json: schema: $ref: '#/components/schemas/errors' description: Validation error for the request. '500': content: application/json: schema: $ref: '#/components/schemas/errors' description: Internal server error. tags: - authority-storage summary: Update authority x-summary-source: derived servers: - url: https://localhost:8081 components: schemas: relatedHeading: description: An authority related heading for BroaderTerm/NarrowerTerm/LaterHeading/EarlierHeading example: headingRef: headingRef headingType: headingType properties: headingRef: description: HeadingRef value type: string headingType: description: Heading type type: string required: - headingRef - headingType type: object authorityIdDto: description: An authority ID record properties: id: description: Authority UUID format: uuid type: string type: object authorityFullDtoCollection: oneOf: - $ref: '#/components/schemas/authorityDtoCollection' - $ref: '#/components/schemas/authorityIdDtoCollection' title: authorityFullDtoCollection authorityDtoIdentifier: description: Identifier associated with the authority example: value: value identifierTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 identifierType: identifierType properties: value: description: Resource identifier value type: string x-fqm-value-getter: (SELECT array_agg(elems.value->>'value') FROM jsonb_array_elements(:sourceAlias.identifiers) AS elems) x-fqm-filter-value-getter: (SELECT array_agg(lower(elems.value->>'value')) FROM jsonb_array_elements(:sourceAlias.identifiers) AS elems) identifierTypeId: description: Resource identifier type (e.g. Control number, LCCN, Other standard identifier, System control number) format: uuid type: string x-fqm-visibility: hidden x-fqm-value-getter: (SELECT array_agg(elems.value->>'identifierTypeId') FROM jsonb_array_elements(:sourceAlias.identifiers) AS elems) identifierType: description: Resource identifier type. Used only for FQM queries readOnly: true type: string x-fqm-value-function: :value x-fqm-value-getter: (SELECT array_agg(elems.value->>'identifierTypeId') FROM jsonb_array_elements(:sourceAlias.identifiers) AS elems) x-fqm-filter-value-getter: (SELECT array_agg(elems.value->>'identifierTypeId') FROM jsonb_array_elements(:sourceAlias.identifiers) AS elems) x-fqm-source: entityTypeId: e1d77962-f469-5a9c-a0e0-30987c1bae99 columnName: name required: - identifierTypeId - value type: object authorityDtoNote: description: Authority note example: noteTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 noteType: noteType note: note staffOnly: true properties: noteTypeId: description: Note type id format: uuid type: string x-fqm-visibility: hidden x-fqm-value-getter: (SELECT array_agg(elems.value->>'noteTypeId') FROM jsonb_array_elements(:sourceAlias.notes) AS elems) noteType: description: Note type. Used only for FQM queries readOnly: true type: string x-fqm-value-function: :value x-fqm-value-getter: (SELECT array_agg(elems.value->>'noteTypeId') FROM jsonb_array_elements(:sourceAlias.notes) AS elems) x-fqm-filter-value-getter: (SELECT array_agg(elems.value->>'noteTypeId') FROM jsonb_array_elements(:sourceAlias.notes) AS elems) x-fqm-source: entityTypeId: 369af782-637c-5ab7-af1f-f66a3e45acad columnName: name note: description: Text content of the note type: string x-fqm-value-getter: (SELECT array_agg(elems.value->>'note') FROM jsonb_array_elements(:sourceAlias.notes) AS elems) x-fqm-filter-value-getter: (SELECT array_agg(lower(elems.value->>'note')) FROM jsonb_array_elements(:sourceAlias.notes) AS elems) staffOnly: description: Whether the note is visible to staff only type: boolean x-fqm-visibility: hidden x-fqm-value-getter: (SELECT array_agg(elems.value->>'staffOnly') FROM jsonb_array_elements(:sourceAlias.notes) AS elems) x-fqm-filter-value-getter: (SELECT array_agg(lower(elems.value->>'staffOnly')) FROM jsonb_array_elements(:sourceAlias.notes) AS elems) required: - note - noteTypeId type: object authorityDto: description: An authority record example: id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 _version: 0 source: source personalName: personalName sftPersonalName: - sftPersonalName - sftPersonalName saftPersonalName: - saftPersonalName - saftPersonalName personalNameTitle: personalNameTitle sftPersonalNameTitle: - sftPersonalNameTitle - sftPersonalNameTitle saftPersonalNameTitle: - saftPersonalNameTitle - saftPersonalNameTitle corporateName: corporateName sftCorporateName: - sftCorporateName - sftCorporateName saftCorporateName: - saftCorporateName - saftCorporateName corporateNameTitle: corporateNameTitle sftCorporateNameTitle: - sftCorporateNameTitle - sftCorporateNameTitle saftCorporateNameTitle: - saftCorporateNameTitle - saftCorporateNameTitle meetingName: meetingName sftMeetingName: - sftMeetingName - sftMeetingName saftMeetingName: - saftMeetingName - saftMeetingName meetingNameTitle: meetingNameTitle sftMeetingNameTitle: - sftMeetingNameTitle - sftMeetingNameTitle saftMeetingNameTitle: - saftMeetingNameTitle - saftMeetingNameTitle uniformTitle: uniformTitle sftUniformTitle: - sftUniformTitle - sftUniformTitle saftUniformTitle: - saftUniformTitle - saftUniformTitle namedEvent: namedEvent sftNamedEvent: - sftNamedEvent - sftNamedEvent saftNamedEvent: - saftNamedEvent - saftNamedEvent topicalTerm: topicalTerm sftTopicalTerm: - sftTopicalTerm - sftTopicalTerm saftTopicalTerm: - saftTopicalTerm - saftTopicalTerm subjectHeadings: subjectHeadings geographicName: geographicName sftGeographicName: - sftGeographicName - sftGeographicName saftGeographicName: - saftGeographicName - saftGeographicName genreTerm: genreTerm sftGenreTerm: - sftGenreTerm - sftGenreTerm saftGenreTerm: - saftGenreTerm - saftGenreTerm chronTerm: chronTerm sftChronTerm: - sftChronTerm - sftChronTerm saftChronTerm: - saftChronTerm - saftChronTerm mediumPerfTerm: mediumPerfTerm sftMediumPerfTerm: - sftMediumPerfTerm - sftMediumPerfTerm saftMediumPerfTerm: - saftMediumPerfTerm - saftMediumPerfTerm generalSubdivision: generalSubdivision sftGeneralSubdivision: - sftGeneralSubdivision - sftGeneralSubdivision saftGeneralSubdivision: - saftGeneralSubdivision - saftGeneralSubdivision geographicSubdivision: geographicSubdivision sftGeographicSubdivision: - sftGeographicSubdivision - sftGeographicSubdivision saftGeographicSubdivision: - saftGeographicSubdivision - saftGeographicSubdivision chronSubdivision: chronSubdivision sftChronSubdivision: - sftChronSubdivision - sftChronSubdivision saftChronSubdivision: - saftChronSubdivision - saftChronSubdivision formSubdivision: formSubdivision sftFormSubdivision: - sftFormSubdivision - sftFormSubdivision saftFormSubdivision: - saftFormSubdivision - saftFormSubdivision saftBroaderTerm: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftNarrowerTerm: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftEarlierHeading: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftLaterHeading: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftPersonalNameTrunc: - saftPersonalNameTrunc - saftPersonalNameTrunc saftPersonalNameTitleTrunc: - saftPersonalNameTitleTrunc - saftPersonalNameTitleTrunc saftCorporateNameTrunc: - saftCorporateNameTrunc - saftCorporateNameTrunc saftCorporateNameTitleTrunc: - saftCorporateNameTitleTrunc - saftCorporateNameTitleTrunc saftMeetingNameTrunc: - saftMeetingNameTrunc - saftMeetingNameTrunc saftMeetingNameTitleTrunc: - saftMeetingNameTitleTrunc - saftMeetingNameTitleTrunc saftUniformTitleTrunc: - saftUniformTitleTrunc - saftUniformTitleTrunc saftTopicalTermTrunc: - saftTopicalTermTrunc - saftTopicalTermTrunc saftGenreTermTrunc: - saftGenreTermTrunc - saftGenreTermTrunc saftGeographicNameTrunc: - saftGeographicNameTrunc - saftGeographicNameTrunc saftNamedEventTrunc: - saftNamedEventTrunc - saftNamedEventTrunc saftChronTermTrunc: - saftChronTermTrunc - saftChronTermTrunc saftMediumPerfTermTrunc: - saftMediumPerfTermTrunc - saftMediumPerfTermTrunc saftGeneralSubdivisionTrunc: - saftGeneralSubdivisionTrunc - saftGeneralSubdivisionTrunc saftGeographicSubdivisionTrunc: - saftGeographicSubdivisionTrunc - saftGeographicSubdivisionTrunc saftChronSubdivisionTrunc: - saftChronSubdivisionTrunc - saftChronSubdivisionTrunc saftFormSubdivisionTrunc: - saftFormSubdivisionTrunc - saftFormSubdivisionTrunc identifiers: - value: value identifierTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 identifierType: identifierType - value: value identifierTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 identifierType: identifierType notes: - noteTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 noteType: noteType note: note staffOnly: true - noteTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 noteType: noteType note: note staffOnly: true sourceFileId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 naturalId: naturalId metadata: createdDate: '2000-01-23T04:56:07.000+00:00' createdByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedDate: '2000-01-23T04:56:07.000+00:00' updatedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: id: description: Authority UUID format: uuid type: string _version: description: Record version for optimistic locking type: integer source: 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) type: string personalName: description: Heading personal name type: string sftPersonalName: description: See from tracing personal name items: type: string type: array saftPersonalName: description: See also from tracing personal name items: type: string type: array personalNameTitle: description: Heading personal name title type: string sftPersonalNameTitle: description: See from tracing personal name title items: type: string type: array saftPersonalNameTitle: description: See also from tracing personal name title items: type: string type: array corporateName: description: Heading corporate name type: string sftCorporateName: description: See from tracing corporate name items: type: string type: array saftCorporateName: description: See also from tracing corporate name items: type: string type: array corporateNameTitle: description: Heading corporate name title type: string sftCorporateNameTitle: description: See from tracing corporate name title items: type: string type: array saftCorporateNameTitle: description: See also from tracing corporate name title items: type: string type: array meetingName: description: Heading meeting name type: string sftMeetingName: description: See from tracing meeting name items: type: string type: array saftMeetingName: description: See also from tracing meeting name items: type: string type: array meetingNameTitle: description: Heading meeting name title type: string sftMeetingNameTitle: description: See from tracing meeting name title items: type: string type: array saftMeetingNameTitle: description: See also from tracing meeting name title items: type: string type: array uniformTitle: description: Heading uniform title type: string sftUniformTitle: description: See from tracing uniform title items: type: string type: array saftUniformTitle: description: See also from tracing uniform title items: type: string type: array namedEvent: description: Heading named event type: string sftNamedEvent: description: See from tracing named event items: type: string type: array saftNamedEvent: description: See also from tracing named event items: type: string type: array topicalTerm: description: Heading topical term type: string sftTopicalTerm: description: See from tracing topical term items: type: string type: array saftTopicalTerm: description: See also from tracing topical term items: type: string type: array subjectHeadings: description: Children's subject headings type: string geographicName: description: Heading geographic name type: string sftGeographicName: description: See from tracing geographic name items: type: string type: array saftGeographicName: description: See also from tracing geographic name items: type: string type: array genreTerm: description: Heading genre/form term type: string sftGenreTerm: description: See from tracing genre/form term items: type: string type: array saftGenreTerm: description: See also from tracing genre/form term items: type: string type: array chronTerm: description: Heading chronological term type: string sftChronTerm: description: See from tracing chronological term items: type: string type: array saftChronTerm: description: See also from tracing chronological term items: type: string type: array mediumPerfTerm: description: Heading medium of performance term type: string sftMediumPerfTerm: description: See from tracing medium of performance term items: type: string type: array saftMediumPerfTerm: description: See also from tracing medium of performance term items: type: string type: array generalSubdivision: description: Heading general subdivision term type: string sftGeneralSubdivision: description: See from tracing general subdivision term items: type: string type: array saftGeneralSubdivision: description: See also from tracing general subdivision term items: type: string type: array geographicSubdivision: description: Heading geographic subdivision term type: string sftGeographicSubdivision: description: See from tracing geographic subdivision term items: type: string type: array saftGeographicSubdivision: description: See also from tracing geographic subdivision term items: type: string type: array chronSubdivision: description: Heading chronological subdivision term type: string sftChronSubdivision: description: See from tracing chronological subdivision term items: type: string type: array saftChronSubdivision: description: See also from tracing chronological subdivision term items: type: string type: array formSubdivision: description: Heading form subdivision term type: string sftFormSubdivision: description: See from tracing form subdivision term items: type: string type: array saftFormSubdivision: description: See also from tracing form subdivision term items: type: string type: array saftBroaderTerm: description: See also from tracing term that represents broader, more general concepts related to the authority record items: $ref: '#/components/schemas/relatedHeading' type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftNarrowerTerm: description: See also from tracing term that that represents narrower, more specific concepts derived from the authority record items: $ref: '#/components/schemas/relatedHeading' type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftEarlierHeading: description: 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. items: $ref: '#/components/schemas/relatedHeading' type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftLaterHeading: description: 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. items: $ref: '#/components/schemas/relatedHeading' type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftPersonalNameTrunc: description: See also from tracing personal name items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftPersonalNameTitleTrunc: description: See also from tracing personal name title items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftCorporateNameTrunc: description: See also from tracing corporate name items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftCorporateNameTitleTrunc: description: See also from tracing corporate name title items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftMeetingNameTrunc: description: See also from tracing meeting name items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftMeetingNameTitleTrunc: description: See also from tracing meeting name title items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftUniformTitleTrunc: description: See also from tracing uniform title items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftTopicalTermTrunc: description: See also from tracing topical term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftGenreTermTrunc: description: See also from tracing genre/form term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftGeographicNameTrunc: description: See also from tracing geographic name items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftNamedEventTrunc: description: See also from tracing named event items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftChronTermTrunc: description: See also from tracing chronological term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftMediumPerfTermTrunc: description: See also from tracing medium of performance term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftGeneralSubdivisionTrunc: description: See also from tracing general subdivision term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftGeographicSubdivisionTrunc: description: See also from tracing geographic subdivision term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftChronSubdivisionTrunc: description: See also from tracing chronological subdivision term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' saftFormSubdivisionTrunc: description: See also from tracing form subdivision term items: type: string type: array x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY)' identifiers: description: An extensible set of name-value pairs of identifiers associated with the resource items: $ref: '#/components/schemas/authorityDtoIdentifier' type: array notes: description: Notes (e.g. nonpublic general note) items: $ref: '#/components/schemas/authorityDtoNote' type: array sourceFileId: description: Authority source file id; UUID format: uuid type: string naturalId: description: Authority Natural ID type: string metadata: $ref: '#/components/schemas/metadata' required: - naturalId - source type: object error_parameters_inner: properties: key: description: Parameter key type: string value: description: Parameter value type: string type: object error: description: Error object properties: message: description: Error message type: string type: description: Error type type: string code: description: Error code type: string parameters: description: Error parameters items: $ref: '#/components/schemas/error_parameters_inner' type: array type: object authorityIdDtoCollection: description: A collection of authority ID records properties: authorities: description: List of authority records items: $ref: '#/components/schemas/authorityIdDto' type: array totalRecords: description: Total amount of records type: integer required: - authorities - totalRecords type: object errors: description: Errors response example: Error: value: errors: - message: may not be null type: 1 code: -1 parameters: - key: moduleTo value: null properties: errors: description: List of errors items: $ref: '#/components/schemas/error' type: array type: object authorityBulkRequest: description: Bulk authorities create request properties: recordsFileName: description: File name of authority records type: string required: - recordsFileName type: object authorityBulkResponse: description: Bulk authorities create response example: errorRecordsFileName: errorRecordsFileName errorsFileName: errorsFileName errorsNumber: 0 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 type: object authorityDtoCollection: description: A collection of authority records example: authorities: - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 _version: 0 source: source personalName: personalName sftPersonalName: - sftPersonalName - sftPersonalName saftPersonalName: - saftPersonalName - saftPersonalName personalNameTitle: personalNameTitle sftPersonalNameTitle: - sftPersonalNameTitle - sftPersonalNameTitle saftPersonalNameTitle: - saftPersonalNameTitle - saftPersonalNameTitle corporateName: corporateName sftCorporateName: - sftCorporateName - sftCorporateName saftCorporateName: - saftCorporateName - saftCorporateName corporateNameTitle: corporateNameTitle sftCorporateNameTitle: - sftCorporateNameTitle - sftCorporateNameTitle saftCorporateNameTitle: - saftCorporateNameTitle - saftCorporateNameTitle meetingName: meetingName sftMeetingName: - sftMeetingName - sftMeetingName saftMeetingName: - saftMeetingName - saftMeetingName meetingNameTitle: meetingNameTitle sftMeetingNameTitle: - sftMeetingNameTitle - sftMeetingNameTitle saftMeetingNameTitle: - saftMeetingNameTitle - saftMeetingNameTitle uniformTitle: uniformTitle sftUniformTitle: - sftUniformTitle - sftUniformTitle saftUniformTitle: - saftUniformTitle - saftUniformTitle namedEvent: namedEvent sftNamedEvent: - sftNamedEvent - sftNamedEvent saftNamedEvent: - saftNamedEvent - saftNamedEvent topicalTerm: topicalTerm sftTopicalTerm: - sftTopicalTerm - sftTopicalTerm saftTopicalTerm: - saftTopicalTerm - saftTopicalTerm subjectHeadings: subjectHeadings geographicName: geographicName sftGeographicName: - sftGeographicName - sftGeographicName saftGeographicName: - saftGeographicName - saftGeographicName genreTerm: genreTerm sftGenreTerm: - sftGenreTerm - sftGenreTerm saftGenreTerm: - saftGenreTerm - saftGenreTerm chronTerm: chronTerm sftChronTerm: - sftChronTerm - sftChronTerm saftChronTerm: - saftChronTerm - saftChronTerm mediumPerfTerm: mediumPerfTerm sftMediumPerfTerm: - sftMediumPerfTerm - sftMediumPerfTerm saftMediumPerfTerm: - saftMediumPerfTerm - saftMediumPerfTerm generalSubdivision: generalSubdivision sftGeneralSubdivision: - sftGeneralSubdivision - sftGeneralSubdivision saftGeneralSubdivision: - saftGeneralSubdivision - saftGeneralSubdivision geographicSubdivision: geographicSubdivision sftGeographicSubdivision: - sftGeographicSubdivision - sftGeographicSubdivision saftGeographicSubdivision: - saftGeographicSubdivision - saftGeographicSubdivision chronSubdivision: chronSubdivision sftChronSubdivision: - sftChronSubdivision - sftChronSubdivision saftChronSubdivision: - saftChronSubdivision - saftChronSubdivision formSubdivision: formSubdivision sftFormSubdivision: - sftFormSubdivision - sftFormSubdivision saftFormSubdivision: - saftFormSubdivision - saftFormSubdivision saftBroaderTerm: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftNarrowerTerm: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftEarlierHeading: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftLaterHeading: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftPersonalNameTrunc: - saftPersonalNameTrunc - saftPersonalNameTrunc saftPersonalNameTitleTrunc: - saftPersonalNameTitleTrunc - saftPersonalNameTitleTrunc saftCorporateNameTrunc: - saftCorporateNameTrunc - saftCorporateNameTrunc saftCorporateNameTitleTrunc: - saftCorporateNameTitleTrunc - saftCorporateNameTitleTrunc saftMeetingNameTrunc: - saftMeetingNameTrunc - saftMeetingNameTrunc saftMeetingNameTitleTrunc: - saftMeetingNameTitleTrunc - saftMeetingNameTitleTrunc saftUniformTitleTrunc: - saftUniformTitleTrunc - saftUniformTitleTrunc saftTopicalTermTrunc: - saftTopicalTermTrunc - saftTopicalTermTrunc saftGenreTermTrunc: - saftGenreTermTrunc - saftGenreTermTrunc saftGeographicNameTrunc: - saftGeographicNameTrunc - saftGeographicNameTrunc saftNamedEventTrunc: - saftNamedEventTrunc - saftNamedEventTrunc saftChronTermTrunc: - saftChronTermTrunc - saftChronTermTrunc saftMediumPerfTermTrunc: - saftMediumPerfTermTrunc - saftMediumPerfTermTrunc saftGeneralSubdivisionTrunc: - saftGeneralSubdivisionTrunc - saftGeneralSubdivisionTrunc saftGeographicSubdivisionTrunc: - saftGeographicSubdivisionTrunc - saftGeographicSubdivisionTrunc saftChronSubdivisionTrunc: - saftChronSubdivisionTrunc - saftChronSubdivisionTrunc saftFormSubdivisionTrunc: - saftFormSubdivisionTrunc - saftFormSubdivisionTrunc identifiers: - value: value identifierTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 identifierType: identifierType - value: value identifierTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 identifierType: identifierType notes: - noteTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 noteType: noteType note: note staffOnly: true - noteTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 noteType: noteType note: note staffOnly: true sourceFileId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 naturalId: naturalId metadata: createdDate: '2000-01-23T04:56:07.000+00:00' createdByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedDate: '2000-01-23T04:56:07.000+00:00' updatedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 _version: 0 source: source personalName: personalName sftPersonalName: - sftPersonalName - sftPersonalName saftPersonalName: - saftPersonalName - saftPersonalName personalNameTitle: personalNameTitle sftPersonalNameTitle: - sftPersonalNameTitle - sftPersonalNameTitle saftPersonalNameTitle: - saftPersonalNameTitle - saftPersonalNameTitle corporateName: corporateName sftCorporateName: - sftCorporateName - sftCorporateName saftCorporateName: - saftCorporateName - saftCorporateName corporateNameTitle: corporateNameTitle sftCorporateNameTitle: - sftCorporateNameTitle - sftCorporateNameTitle saftCorporateNameTitle: - saftCorporateNameTitle - saftCorporateNameTitle meetingName: meetingName sftMeetingName: - sftMeetingName - sftMeetingName saftMeetingName: - saftMeetingName - saftMeetingName meetingNameTitle: meetingNameTitle sftMeetingNameTitle: - sftMeetingNameTitle - sftMeetingNameTitle saftMeetingNameTitle: - saftMeetingNameTitle - saftMeetingNameTitle uniformTitle: uniformTitle sftUniformTitle: - sftUniformTitle - sftUniformTitle saftUniformTitle: - saftUniformTitle - saftUniformTitle namedEvent: namedEvent sftNamedEvent: - sftNamedEvent - sftNamedEvent saftNamedEvent: - saftNamedEvent - saftNamedEvent topicalTerm: topicalTerm sftTopicalTerm: - sftTopicalTerm - sftTopicalTerm saftTopicalTerm: - saftTopicalTerm - saftTopicalTerm subjectHeadings: subjectHeadings geographicName: geographicName sftGeographicName: - sftGeographicName - sftGeographicName saftGeographicName: - saftGeographicName - saftGeographicName genreTerm: genreTerm sftGenreTerm: - sftGenreTerm - sftGenreTerm saftGenreTerm: - saftGenreTerm - saftGenreTerm chronTerm: chronTerm sftChronTerm: - sftChronTerm - sftChronTerm saftChronTerm: - saftChronTerm - saftChronTerm mediumPerfTerm: mediumPerfTerm sftMediumPerfTerm: - sftMediumPerfTerm - sftMediumPerfTerm saftMediumPerfTerm: - saftMediumPerfTerm - saftMediumPerfTerm generalSubdivision: generalSubdivision sftGeneralSubdivision: - sftGeneralSubdivision - sftGeneralSubdivision saftGeneralSubdivision: - saftGeneralSubdivision - saftGeneralSubdivision geographicSubdivision: geographicSubdivision sftGeographicSubdivision: - sftGeographicSubdivision - sftGeographicSubdivision saftGeographicSubdivision: - saftGeographicSubdivision - saftGeographicSubdivision chronSubdivision: chronSubdivision sftChronSubdivision: - sftChronSubdivision - sftChronSubdivision saftChronSubdivision: - saftChronSubdivision - saftChronSubdivision formSubdivision: formSubdivision sftFormSubdivision: - sftFormSubdivision - sftFormSubdivision saftFormSubdivision: - saftFormSubdivision - saftFormSubdivision saftBroaderTerm: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftNarrowerTerm: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftEarlierHeading: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftLaterHeading: - headingRef: headingRef headingType: headingType - headingRef: headingRef headingType: headingType saftPersonalNameTrunc: - saftPersonalNameTrunc - saftPersonalNameTrunc saftPersonalNameTitleTrunc: - saftPersonalNameTitleTrunc - saftPersonalNameTitleTrunc saftCorporateNameTrunc: - saftCorporateNameTrunc - saftCorporateNameTrunc saftCorporateNameTitleTrunc: - saftCorporateNameTitleTrunc - saftCorporateNameTitleTrunc saftMeetingNameTrunc: - saftMeetingNameTrunc - saftMeetingNameTrunc saftMeetingNameTitleTrunc: - saftMeetingNameTitleTrunc - saftMeetingNameTitleTrunc saftUniformTitleTrunc: - saftUniformTitleTrunc - saftUniformTitleTrunc saftTopicalTermTrunc: - saftTopicalTermTrunc - saftTopicalTermTrunc saftGenreTermTrunc: - saftGenreTermTrunc - saftGenreTermTrunc saftGeographicNameTrunc: - saftGeographicNameTrunc - saftGeographicNameTrunc saftNamedEventTrunc: - saftNamedEventTrunc - saftNamedEventTrunc saftChronTermTrunc: - saftChronTermTrunc - saftChronTermTrunc saftMediumPerfTermTrunc: - saftMediumPerfTermTrunc - saftMediumPerfTermTrunc saftGeneralSubdivisionTrunc: - saftGeneralSubdivisionTrunc - saftGeneralSubdivisionTrunc saftGeographicSubdivisionTrunc: - saftGeographicSubdivisionTrunc - saftGeographicSubdivisionTrunc saftChronSubdivisionTrunc: - saftChronSubdivisionTrunc - saftChronSubdivisionTrunc saftFormSubdivisionTrunc: - saftFormSubdivisionTrunc - saftFormSubdivisionTrunc identifiers: - value: value identifierTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 identifierType: identifierType - value: value identifierTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 identifierType: identifierType notes: - noteTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 noteType: noteType note: note staffOnly: true - noteTypeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 noteType: noteType note: note staffOnly: true sourceFileId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 naturalId: naturalId metadata: createdDate: '2000-01-23T04:56:07.000+00:00' createdByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedDate: '2000-01-23T04:56:07.000+00:00' updatedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 totalRecords: 6 properties: authorities: description: List of authority records items: $ref: '#/components/schemas/authorityDto' type: array totalRecords: description: Total amount of records type: integer required: - authorities - totalRecords type: object metadata: description: Creater, updater, creation date, last updated date example: createdDate: '2000-01-23T04:56:07.000+00:00' createdByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedDate: '2000-01-23T04:56:07.000+00:00' updatedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: createdDate: description: Date and time when the record was created format: date-time type: string x-fqm-value-getter: :sourceAlias.created_date x-fqm-value-function: (:value)::timestamp createdByUserId: description: ID of the user who created the record (when available) format: uuid type: string x-fqm-value-getter: :sourceAlias.created_by_user_id updatedDate: description: Date and time when the record was last updated format: date-time type: string x-fqm-value-getter: :sourceAlias.updated_date x-fqm-value-function: (:value)::timestamp updatedByUserId: description: ID of the user who last updated the record (when available) format: uuid type: string x-fqm-value-getter: :sourceAlias.updated_by_user_id type: object x-refined-from: - folio-mod-entities-links-openapi.json - folio-mod-entities-links-openapi.yml