Source:

Module: mod-inventory-storage

Interface: /instance-storage/instances

Attributes:

Property Name Property Type Property Description
id string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
_version integer Record version for optimistic locking
hrid string The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID
matchKey string A unique instance identifier matching a client-side bibliographic record identification scheme, in particular for a scenario where multiple separate catalogs with no shared record identifiers contribute to the same Instance in Inventory. A match key is typically generated from select, normalized pieces of metadata in bibliographic records
sourceUri string A remote URI uniquely identifying the source of the instance
source string The metadata source and its format of the underlying record to the instance record. (e.g. FOLIO if it’s a record created in Inventory; MARC if it’s a MARC record created in MARCcat or EPKB if it’s a record coming from eHoldings; CONSORTIUM-MARC or CONSORTIUM-FOLIO for sharing Instances).
title string The primary title (or label) associated with the resource
indexTitle string Title normalized for browsing and searching; based on the title with articles removed
alternativeTitles array List of alternative titles for the resource (e.g. original language version title of a movie)
alternativeTitles/alternativeTitleTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
alternativeTitles/alternativeTitle string An alternative title for the resource
alternativeTitles/authorityId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
editions array The edition statement, imprint and other publication source information
series array List of series titles associated with the resource (e.g. Harry Potter)
series/value string Series title value
series/authorityId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
identifiers array An extensible set of name-value pairs of identifiers associated with the resource
identifiers/value string Resource identifier value
identifiers/identifierTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
identifiers/identifierTypeObject object Information about identifier type, looked up from identifierTypeId
contributors array List of contributors
contributors/name string Personal name, corporate name, meeting name
contributors/contributorTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
contributors/contributorTypeText string Free text element for adding contributor type terms other that defined by the MARC code list for relators
contributors/contributorNameTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
contributors/authorityId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
contributors/contributorNameType object Dereferenced contributor-name type
contributors/primary boolean Whether this is the primary contributor
subjects array List of subject headings
subjects/value string Subject heading value
subjects/authorityId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
subjects/sourceId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
subjects/typeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
classifications array List of classifications
classifications/classificationNumber string Classification (e.g. classification scheme, classification schedule)
classifications/classificationTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
classifications/classificationType object Dereferenced classification schema
publication array List of publication items
publication/publisher string Name of publisher, distributor, etc.
publication/place string Place of publication, distribution, etc.
publication/dateOfPublication string Date (year YYYY) of publication, distribution, etc.
publication/role string The role of the publisher, distributor, etc.
publicationFrequency array List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)
publicationRange array The range of sequential designation/chronology of publication, or date range
electronicAccess array List of electronic access items
electronicAccess/uri string uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources
electronicAccess/linkText string The value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated
electronicAccess/materialsSpecification string Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)
electronicAccess/publicNote string URL public note to be displayed in the discovery
electronicAccess/relationshipId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
dates object Instance Dates
dates/dateTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
dates/date1 string Date 1
dates/date2 string Date 2
instanceTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
instanceFormatIds array UUIDs for the unique terms for the format whether it’s from the RDA carrier term list of locally defined
instanceFormats array List of dereferenced instance formats
physicalDescriptions array Physical description of the described resource, including its extent, dimensions, and such other physical details as a description of any accompanying materials and unit type and size
languages array The set of languages used by the resource
notes array Bibliographic notes (e.g. general notes, specialized notes)
notes/instanceNoteTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
notes/note string Text content of the note
notes/staffOnly boolean If true, determines that the note should not be visible for others than staff
administrativeNotes array Administrative notes
modeOfIssuanceId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
catalogedDate string Date or timestamp on an instance for when is was considered cataloged
previouslyHeld boolean Records the fact that the resource was previously held by the library for things like Hathi access, etc.
staffSuppress boolean Records the fact that the record should not be displayed for others than catalogers
discoverySuppress boolean Records the fact that the record should not be displayed in a discovery system
deleted boolean Indicates whether the record was marked for deletion
statisticalCodeIds array List of statistical code IDs
sourceRecordFormat string Format of the instance source record, if a source record exists (e.g. FOLIO if it’s a record created in Inventory, MARC if it’s a MARC record created in MARCcat or EPKB if it’s a record coming from eHoldings)
statusId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
statusUpdatedDate string Date [or timestamp] for when the instance status was updated
tags object List of simple tags that can be added to an object
tags/tagList array List of tags
metadata object Metadata about creation and changes to records, provided by the server (client should not provide)
metadata/createdDate string Date and time when the record was created
metadata/createdByUserId string ID of the user who created the record (when available)
metadata/createdByUsername string Username of the user who created the record (when available)
metadata/updatedDate string Date and time when the record was last updated
metadata/updatedByUserId string ID of the user who last updated the record (when available)
metadata/updatedByUsername string Username of the user who last updated the record (when available)
holdingsRecords2 array List of holdings records
natureOfContentTermIds array Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)