Inventory API (v2.0)

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of instance records",
  "type": "object",
  "properties": {
    "instances": {
      "description": "List of instance records",
      "id": "instances",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An instance record",
        "properties": {
          "id": {
            "type": "string",
            "description": "The system assigned unique ID of the instance record"
          },
          "_version": {
            "type": "integer",
            "description": "Record version for optimistic locking"
          },
          "hrid": {
            "type": "string",
            "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
          },
          "matchKey": {
            "type": "string",
            "description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
          },
          "sourceUri": {
            "type": "string",
            "description": "A remote URI uniquely identifying the source of the instance"
          },
          "source": {
            "type": "string",
            "description": "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)"
          },
          "parentInstances": {
            "description": "Array of parent instances",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the parent instance",
                  "type": "string"
                },
                "superInstanceId": {
                  "description": "Id of the super instance",
                  "type": "string"
                },
                "instanceRelationshipTypeId": {
                  "description": "Id of the relationship type",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "superInstanceId",
                "instanceRelationshipTypeId"
              ]
            }
          },
          "childInstances": {
            "description": "Child instances",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "subInstanceId": {
                  "description": "Id of sub Instance",
                  "type": "string"
                },
                "instanceRelationshipTypeId": {
                  "description": "Id of the relationship type",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "id",
                "subInstanceId",
                "instanceRelationshipTypeId"
              ]
            }
          },
          "title": {
            "type": "string",
            "description": "The primary title (or label) associated with the resource"
          },
          "indexTitle": {
            "type": "string",
            "description": "Title normalized for browsing and searching; based on the title with articles removed"
          },
          "alternativeTitles": {
            "type": "array",
            "description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
            "items": {
              "type": "object",
              "properties": {
                "alternativeTitleTypeId": {
                  "type": "string",
                  "description": "ID for an alternative title qualifier"
                },
                "alternativeTitle": {
                  "type": "string",
                  "description": "An alternative title for the resource"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls an alternative title",
                  "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}$"
                }
              }
            },
            "uniqueItems": true
          },
          "editions": {
            "type": "array",
            "description": "The edition statement, imprint and other publication source information",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "series": {
            "type": "array",
            "description": "List of series titles associated with the resource (e.g. Harry Potter)",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Series title value"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls an series title",
                  "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}$"
                }
              },
              "additionalProperties": false,
              "required": [
                "value"
              ]
            },
            "uniqueItems": true
          },
          "identifiers": {
            "type": "array",
            "description": "An extensible set of name-value pairs of identifiers associated with the resource",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Resource identifier value"
                },
                "identifierTypeId": {
                  "type": "string",
                  "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                }
              },
              "additionalProperties": false,
              "required": [
                "value",
                "identifierTypeId"
              ]
            }
          },
          "contributors": {
            "type": "array",
            "description": "List of contributors",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Personal name, corporate name, meeting name"
                },
                "contributorTypeId": {
                  "type": "string",
                  "description": "ID for the contributor type term defined as a referencetable in settings"
                },
                "contributorTypeText": {
                  "type": "string",
                  "description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
                },
                "contributorNameTypeId": {
                  "type": "string",
                  "description": "Contributor type terms defined by the MARC code list for relators"
                },
                "authorityId": {
                  "type": "string",
                  "description": "ID of authority record that controls the contributor",
                  "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}$"
                },
                "primary": {
                  "type": "boolean",
                  "description": "Whether this is the primary contributor"
                }
              },
              "additionalProperties": false,
              "required": [
                "name",
                "contributorNameTypeId"
              ]
            }
          },
          "subjects": {
            "type": "array",
            "description": "List of subject headings",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Subject heading value"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls a subject heading",
                  "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}$"
                },
                "sourceId": {
                  "type": "string",
                  "description": "UUID of subject source",
                  "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}$"
                },
                "typeId": {
                  "type": "string",
                  "description": "UUID of subject type",
                  "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}$"
                }
              },
              "additionalProperties": false,
              "required": [
                "value"
              ]
            },
            "uniqueItems": true
          },
          "classifications": {
            "type": "array",
            "description": "List of classifications",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "classificationNumber": {
                  "type": "string",
                  "description": "Classification (e.g. classification scheme, classification schedule)"
                },
                "classificationTypeId": {
                  "type": "string",
                  "description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
                }
              },
              "additionalProperties": false,
              "required": [
                "classificationNumber",
                "classificationTypeId"
              ]
            }
          },
          "publication": {
            "type": "array",
            "description": "List of publication items",
            "items": {
              "type": "object",
              "properties": {
                "publisher": {
                  "type": "string",
                  "description": "Name of publisher, distributor, etc."
                },
                "place": {
                  "type": "string",
                  "description": "Place of publication, distribution, etc."
                },
                "dateOfPublication": {
                  "type": "string",
                  "description": "Date (year YYYY) of publication, distribution, etc."
                },
                "role": {
                  "type": "string",
                  "description": "The role of the publisher, distributor, etc."
                }
              }
            }
          },
          "publicationFrequency": {
            "type": "array",
            "description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "publicationRange": {
            "type": "array",
            "description": "The range of sequential designation/chronology of publication, or date range",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "electronicAccess": {
            "type": "array",
            "description": "List of electronic access items",
            "items": {
              "type": "object",
              "properties": {
                "uri": {
                  "type": "string",
                  "description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
                },
                "linkText": {
                  "type": "string",
                  "description": "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"
                },
                "materialsSpecification": {
                  "type": "string",
                  "description": "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)"
                },
                "publicNote": {
                  "type": "string",
                  "description": "URL public note to be displayed in the discovery"
                },
                "relationshipId": {
                  "type": "string",
                  "description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
                }
              },
              "additionalProperties": false,
              "required": [
                "uri"
              ]
            }
          },
          "dates": {
            "type": "object",
            "description": "Instance Dates",
            "properties": {
              "dateTypeId": {
                "type": "string",
                "description": "Date type ID",
                "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}$"
              },
              "date1": {
                "type": "string",
                "description": "Date 1",
                "maxLength": 4
              },
              "date2": {
                "type": "string",
                "description": "Date 2",
                "maxLength": 4
              }
            }
          },
          "instanceTypeId": {
            "type": "string",
            "description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
          },
          "instanceFormatIds": {
            "type": "array",
            "description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
            "items": {
              "type": "string"
            }
          },
          "physicalDescriptions": {
            "type": "array",
            "description": "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",
            "items": {
              "type": "string"
            }
          },
          "languages": {
            "type": "array",
            "description": "The set of languages used by the resource",
            "minItems": 0,
            "items": {
              "type": "string"
            }
          },
          "notes": {
            "type": "array",
            "description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
            "items": {
              "type": "object",
              "properties": {
                "instanceNoteTypeId": {
                  "description": "ID of the type of note",
                  "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"
                },
                "staffOnly": {
                  "type": "boolean",
                  "description": "If true, determines that the note should not be visible for others than staff",
                  "default": false
                }
              }
            }
          },
          "administrativeNotes": {
            "type": "array",
            "description": "Administrative notes",
            "minItems": 0,
            "items": {
              "type": "string"
            }
          },
          "modeOfIssuanceId": {
            "type": "string",
            "description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph,  sequential monograph, serial; integrating Resource, other)"
          },
          "catalogedDate": {
            "type": "string",
            "description": "Date or timestamp on an instance for when is was considered cataloged"
          },
          "previouslyHeld": {
            "type": "boolean",
            "description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
          },
          "staffSuppress": {
            "type": "boolean",
            "description": "Records the fact that the record should not be displayed for others than catalogers"
          },
          "discoverySuppress": {
            "type": "boolean",
            "description": "Records the fact that the record should not be displayed in a discovery system"
          },
          "deleted": {
            "type": "boolean",
            "description": "Indicates whether the record was marked for deletion"
          },
          "statisticalCodeIds": {
            "type": "array",
            "description": "List of statistical code IDs",
            "items": {
              "type": "string"
            }
          },
          "sourceRecordFormat": {
            "description": "Format of the instance source record, if a source record exists",
            "type": "string",
            "enum": [
              "MARC-JSON"
            ],
            "readonly": true
          },
          "statusId": {
            "type": "string",
            "description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
          },
          "statusUpdatedDate": {
            "type": "string",
            "description": "Date [or timestamp] for when the instance status was updated"
          },
          "tags": {
            "description": "arbitrary tags associated with this instance",
            "id": "tags",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "tags",
            "properties": {
              "tagList": {
                "description": "List of tags",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "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"
            ]
          },
          "natureOfContentTermIds": {
            "type": "array",
            "description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
            "items": {
              "type": "string",
              "description": "Single UUID for the Instance nature of content",
              "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}$"
            }
          },
          "isBoundWith": {
            "description": "Indicates if this Instance is included in a bound-with",
            "type": "boolean",
            "default": false,
            "readonly": true
          },
          "precedingTitles": {
            "description": "Array of preceding titles",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the preceding title",
                  "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}$"
                },
                "precedingInstanceId": {
                  "description": "Id of the preceding instance id",
                  "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}$"
                },
                "title": {
                  "type": "string",
                  "description": "The primary title (or label) associated with the resource"
                },
                "hrid": {
                  "type": "string",
                  "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
                },
                "identifiers": {
                  "type": "array",
                  "description": "An extensible set of name-value pairs of identifiers associated with the resource",
                  "minItems": 0,
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "Resource identifier value"
                      },
                      "identifierTypeId": {
                        "type": "string",
                        "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "value",
                      "identifierTypeId"
                    ]
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "succeedingTitles": {
            "description": "Array of succeeding titles",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the succeeding title",
                  "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}$"
                },
                "succeedingInstanceId": {
                  "description": "Id of the succeeding instance id",
                  "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}$"
                },
                "title": {
                  "type": "string",
                  "description": "The primary title (or label) associated with the resource"
                },
                "hrid": {
                  "type": "string",
                  "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
                },
                "identifiers": {
                  "type": "array",
                  "description": "An extensible set of name-value pairs of identifiers associated with the resource",
                  "minItems": 0,
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "Resource identifier value"
                      },
                      "identifierTypeId": {
                        "type": "string",
                        "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "value",
                      "identifierTypeId"
                    ]
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "source",
          "title",
          "instanceTypeId"
        ]
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "instances",
    "totalRecords"
  ]
}

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Response schema for instances batch request",
  "type": "object",
  "properties": {
    "instances": {
      "id": "instancesList",
      "description": "List of Instances",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An instance record",
        "properties": {
          "id": {
            "type": "string",
            "description": "The system assigned unique ID of the instance record"
          },
          "_version": {
            "type": "integer",
            "description": "Record version for optimistic locking"
          },
          "hrid": {
            "type": "string",
            "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
          },
          "matchKey": {
            "type": "string",
            "description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
          },
          "sourceUri": {
            "type": "string",
            "description": "A remote URI uniquely identifying the source of the instance"
          },
          "source": {
            "type": "string",
            "description": "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)"
          },
          "parentInstances": {
            "description": "Array of parent instances",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the parent instance",
                  "type": "string"
                },
                "superInstanceId": {
                  "description": "Id of the super instance",
                  "type": "string"
                },
                "instanceRelationshipTypeId": {
                  "description": "Id of the relationship type",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "superInstanceId",
                "instanceRelationshipTypeId"
              ]
            }
          },
          "childInstances": {
            "description": "Child instances",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "subInstanceId": {
                  "description": "Id of sub Instance",
                  "type": "string"
                },
                "instanceRelationshipTypeId": {
                  "description": "Id of the relationship type",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "id",
                "subInstanceId",
                "instanceRelationshipTypeId"
              ]
            }
          },
          "title": {
            "type": "string",
            "description": "The primary title (or label) associated with the resource"
          },
          "indexTitle": {
            "type": "string",
            "description": "Title normalized for browsing and searching; based on the title with articles removed"
          },
          "alternativeTitles": {
            "type": "array",
            "description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
            "items": {
              "type": "object",
              "properties": {
                "alternativeTitleTypeId": {
                  "type": "string",
                  "description": "ID for an alternative title qualifier"
                },
                "alternativeTitle": {
                  "type": "string",
                  "description": "An alternative title for the resource"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls an alternative title",
                  "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}$"
                }
              }
            },
            "uniqueItems": true
          },
          "editions": {
            "type": "array",
            "description": "The edition statement, imprint and other publication source information",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "series": {
            "type": "array",
            "description": "List of series titles associated with the resource (e.g. Harry Potter)",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Series title value"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls an series title",
                  "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}$"
                }
              },
              "additionalProperties": false,
              "required": [
                "value"
              ]
            },
            "uniqueItems": true
          },
          "identifiers": {
            "type": "array",
            "description": "An extensible set of name-value pairs of identifiers associated with the resource",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Resource identifier value"
                },
                "identifierTypeId": {
                  "type": "string",
                  "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                }
              },
              "additionalProperties": false,
              "required": [
                "value",
                "identifierTypeId"
              ]
            }
          },
          "contributors": {
            "type": "array",
            "description": "List of contributors",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Personal name, corporate name, meeting name"
                },
                "contributorTypeId": {
                  "type": "string",
                  "description": "ID for the contributor type term defined as a referencetable in settings"
                },
                "contributorTypeText": {
                  "type": "string",
                  "description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
                },
                "contributorNameTypeId": {
                  "type": "string",
                  "description": "Contributor type terms defined by the MARC code list for relators"
                },
                "authorityId": {
                  "type": "string",
                  "description": "ID of authority record that controls the contributor",
                  "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}$"
                },
                "primary": {
                  "type": "boolean",
                  "description": "Whether this is the primary contributor"
                }
              },
              "additionalProperties": false,
              "required": [
                "name",
                "contributorNameTypeId"
              ]
            }
          },
          "subjects": {
            "type": "array",
            "description": "List of subject headings",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Subject heading value"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls a subject heading",
                  "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}$"
                },
                "sourceId": {
                  "type": "string",
                  "description": "UUID of subject source",
                  "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}$"
                },
                "typeId": {
                  "type": "string",
                  "description": "UUID of subject type",
                  "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}$"
                }
              },
              "additionalProperties": false,
              "required": [
                "value"
              ]
            },
            "uniqueItems": true
          },
          "classifications": {
            "type": "array",
            "description": "List of classifications",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "classificationNumber": {
                  "type": "string",
                  "description": "Classification (e.g. classification scheme, classification schedule)"
                },
                "classificationTypeId": {
                  "type": "string",
                  "description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
                }
              },
              "additionalProperties": false,
              "required": [
                "classificationNumber",
                "classificationTypeId"
              ]
            }
          },
          "publication": {
            "type": "array",
            "description": "List of publication items",
            "items": {
              "type": "object",
              "properties": {
                "publisher": {
                  "type": "string",
                  "description": "Name of publisher, distributor, etc."
                },
                "place": {
                  "type": "string",
                  "description": "Place of publication, distribution, etc."
                },
                "dateOfPublication": {
                  "type": "string",
                  "description": "Date (year YYYY) of publication, distribution, etc."
                },
                "role": {
                  "type": "string",
                  "description": "The role of the publisher, distributor, etc."
                }
              }
            }
          },
          "publicationFrequency": {
            "type": "array",
            "description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "publicationRange": {
            "type": "array",
            "description": "The range of sequential designation/chronology of publication, or date range",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "electronicAccess": {
            "type": "array",
            "description": "List of electronic access items",
            "items": {
              "type": "object",
              "properties": {
                "uri": {
                  "type": "string",
                  "description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
                },
                "linkText": {
                  "type": "string",
                  "description": "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"
                },
                "materialsSpecification": {
                  "type": "string",
                  "description": "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)"
                },
                "publicNote": {
                  "type": "string",
                  "description": "URL public note to be displayed in the discovery"
                },
                "relationshipId": {
                  "type": "string",
                  "description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
                }
              },
              "additionalProperties": false,
              "required": [
                "uri"
              ]
            }
          },
          "dates": {
            "type": "object",
            "description": "Instance Dates",
            "properties": {
              "dateTypeId": {
                "type": "string",
                "description": "Date type ID",
                "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}$"
              },
              "date1": {
                "type": "string",
                "description": "Date 1",
                "maxLength": 4
              },
              "date2": {
                "type": "string",
                "description": "Date 2",
                "maxLength": 4
              }
            }
          },
          "instanceTypeId": {
            "type": "string",
            "description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
          },
          "instanceFormatIds": {
            "type": "array",
            "description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
            "items": {
              "type": "string"
            }
          },
          "physicalDescriptions": {
            "type": "array",
            "description": "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",
            "items": {
              "type": "string"
            }
          },
          "languages": {
            "type": "array",
            "description": "The set of languages used by the resource",
            "minItems": 0,
            "items": {
              "type": "string"
            }
          },
          "notes": {
            "type": "array",
            "description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
            "items": {
              "type": "object",
              "properties": {
                "instanceNoteTypeId": {
                  "description": "ID of the type of note",
                  "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"
                },
                "staffOnly": {
                  "type": "boolean",
                  "description": "If true, determines that the note should not be visible for others than staff",
                  "default": false
                }
              }
            }
          },
          "administrativeNotes": {
            "type": "array",
            "description": "Administrative notes",
            "minItems": 0,
            "items": {
              "type": "string"
            }
          },
          "modeOfIssuanceId": {
            "type": "string",
            "description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph,  sequential monograph, serial; integrating Resource, other)"
          },
          "catalogedDate": {
            "type": "string",
            "description": "Date or timestamp on an instance for when is was considered cataloged"
          },
          "previouslyHeld": {
            "type": "boolean",
            "description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
          },
          "staffSuppress": {
            "type": "boolean",
            "description": "Records the fact that the record should not be displayed for others than catalogers"
          },
          "discoverySuppress": {
            "type": "boolean",
            "description": "Records the fact that the record should not be displayed in a discovery system"
          },
          "deleted": {
            "type": "boolean",
            "description": "Indicates whether the record was marked for deletion"
          },
          "statisticalCodeIds": {
            "type": "array",
            "description": "List of statistical code IDs",
            "items": {
              "type": "string"
            }
          },
          "sourceRecordFormat": {
            "description": "Format of the instance source record, if a source record exists",
            "type": "string",
            "enum": [
              "MARC-JSON"
            ],
            "readonly": true
          },
          "statusId": {
            "type": "string",
            "description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
          },
          "statusUpdatedDate": {
            "type": "string",
            "description": "Date [or timestamp] for when the instance status was updated"
          },
          "tags": {
            "description": "arbitrary tags associated with this instance",
            "id": "tags",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "tags",
            "properties": {
              "tagList": {
                "description": "List of tags",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "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"
            ]
          },
          "natureOfContentTermIds": {
            "type": "array",
            "description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
            "items": {
              "type": "string",
              "description": "Single UUID for the Instance nature of content",
              "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}$"
            }
          },
          "isBoundWith": {
            "description": "Indicates if this Instance is included in a bound-with",
            "type": "boolean",
            "default": false,
            "readonly": true
          },
          "precedingTitles": {
            "description": "Array of preceding titles",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the preceding title",
                  "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}$"
                },
                "precedingInstanceId": {
                  "description": "Id of the preceding instance id",
                  "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}$"
                },
                "title": {
                  "type": "string",
                  "description": "The primary title (or label) associated with the resource"
                },
                "hrid": {
                  "type": "string",
                  "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
                },
                "identifiers": {
                  "type": "array",
                  "description": "An extensible set of name-value pairs of identifiers associated with the resource",
                  "minItems": 0,
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "Resource identifier value"
                      },
                      "identifierTypeId": {
                        "type": "string",
                        "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "value",
                      "identifierTypeId"
                    ]
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "succeedingTitles": {
            "description": "Array of succeeding titles",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the succeeding title",
                  "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}$"
                },
                "succeedingInstanceId": {
                  "description": "Id of the succeeding instance id",
                  "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}$"
                },
                "title": {
                  "type": "string",
                  "description": "The primary title (or label) associated with the resource"
                },
                "hrid": {
                  "type": "string",
                  "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
                },
                "identifiers": {
                  "type": "array",
                  "description": "An extensible set of name-value pairs of identifiers associated with the resource",
                  "minItems": 0,
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "Resource identifier value"
                      },
                      "identifierTypeId": {
                        "type": "string",
                        "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "value",
                      "identifierTypeId"
                    ]
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "source",
          "title",
          "instanceTypeId"
        ]
      }
    },
    "errorMessages": {
      "id": "errorMessagesList",
      "description": "List of error messages",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "totalRecords": {
      "description": "Total number of successfully saved instances",
      "type": "integer"
    }
  },
  "required": [
    "instances",
    "errorMessages",
    "totalRecords"
  ]
}

Media type: text/plain

Type: any

Example:

version conflict

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Response schema for instances batch request",
  "type": "object",
  "properties": {
    "instances": {
      "id": "instancesList",
      "description": "List of Instances",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An instance record",
        "properties": {
          "id": {
            "type": "string",
            "description": "The system assigned unique ID of the instance record"
          },
          "_version": {
            "type": "integer",
            "description": "Record version for optimistic locking"
          },
          "hrid": {
            "type": "string",
            "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
          },
          "matchKey": {
            "type": "string",
            "description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
          },
          "sourceUri": {
            "type": "string",
            "description": "A remote URI uniquely identifying the source of the instance"
          },
          "source": {
            "type": "string",
            "description": "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)"
          },
          "parentInstances": {
            "description": "Array of parent instances",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the parent instance",
                  "type": "string"
                },
                "superInstanceId": {
                  "description": "Id of the super instance",
                  "type": "string"
                },
                "instanceRelationshipTypeId": {
                  "description": "Id of the relationship type",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "superInstanceId",
                "instanceRelationshipTypeId"
              ]
            }
          },
          "childInstances": {
            "description": "Child instances",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "subInstanceId": {
                  "description": "Id of sub Instance",
                  "type": "string"
                },
                "instanceRelationshipTypeId": {
                  "description": "Id of the relationship type",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "id",
                "subInstanceId",
                "instanceRelationshipTypeId"
              ]
            }
          },
          "title": {
            "type": "string",
            "description": "The primary title (or label) associated with the resource"
          },
          "indexTitle": {
            "type": "string",
            "description": "Title normalized for browsing and searching; based on the title with articles removed"
          },
          "alternativeTitles": {
            "type": "array",
            "description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
            "items": {
              "type": "object",
              "properties": {
                "alternativeTitleTypeId": {
                  "type": "string",
                  "description": "ID for an alternative title qualifier"
                },
                "alternativeTitle": {
                  "type": "string",
                  "description": "An alternative title for the resource"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls an alternative title",
                  "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}$"
                }
              }
            },
            "uniqueItems": true
          },
          "editions": {
            "type": "array",
            "description": "The edition statement, imprint and other publication source information",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "series": {
            "type": "array",
            "description": "List of series titles associated with the resource (e.g. Harry Potter)",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Series title value"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls an series title",
                  "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}$"
                }
              },
              "additionalProperties": false,
              "required": [
                "value"
              ]
            },
            "uniqueItems": true
          },
          "identifiers": {
            "type": "array",
            "description": "An extensible set of name-value pairs of identifiers associated with the resource",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Resource identifier value"
                },
                "identifierTypeId": {
                  "type": "string",
                  "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                }
              },
              "additionalProperties": false,
              "required": [
                "value",
                "identifierTypeId"
              ]
            }
          },
          "contributors": {
            "type": "array",
            "description": "List of contributors",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Personal name, corporate name, meeting name"
                },
                "contributorTypeId": {
                  "type": "string",
                  "description": "ID for the contributor type term defined as a referencetable in settings"
                },
                "contributorTypeText": {
                  "type": "string",
                  "description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
                },
                "contributorNameTypeId": {
                  "type": "string",
                  "description": "Contributor type terms defined by the MARC code list for relators"
                },
                "authorityId": {
                  "type": "string",
                  "description": "ID of authority record that controls the contributor",
                  "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}$"
                },
                "primary": {
                  "type": "boolean",
                  "description": "Whether this is the primary contributor"
                }
              },
              "additionalProperties": false,
              "required": [
                "name",
                "contributorNameTypeId"
              ]
            }
          },
          "subjects": {
            "type": "array",
            "description": "List of subject headings",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Subject heading value"
                },
                "authorityId": {
                  "type": "string",
                  "description": "UUID of authority record that controls a subject heading",
                  "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}$"
                },
                "sourceId": {
                  "type": "string",
                  "description": "UUID of subject source",
                  "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}$"
                },
                "typeId": {
                  "type": "string",
                  "description": "UUID of subject type",
                  "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}$"
                }
              },
              "additionalProperties": false,
              "required": [
                "value"
              ]
            },
            "uniqueItems": true
          },
          "classifications": {
            "type": "array",
            "description": "List of classifications",
            "minItems": 0,
            "items": {
              "type": "object",
              "properties": {
                "classificationNumber": {
                  "type": "string",
                  "description": "Classification (e.g. classification scheme, classification schedule)"
                },
                "classificationTypeId": {
                  "type": "string",
                  "description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
                }
              },
              "additionalProperties": false,
              "required": [
                "classificationNumber",
                "classificationTypeId"
              ]
            }
          },
          "publication": {
            "type": "array",
            "description": "List of publication items",
            "items": {
              "type": "object",
              "properties": {
                "publisher": {
                  "type": "string",
                  "description": "Name of publisher, distributor, etc."
                },
                "place": {
                  "type": "string",
                  "description": "Place of publication, distribution, etc."
                },
                "dateOfPublication": {
                  "type": "string",
                  "description": "Date (year YYYY) of publication, distribution, etc."
                },
                "role": {
                  "type": "string",
                  "description": "The role of the publisher, distributor, etc."
                }
              }
            }
          },
          "publicationFrequency": {
            "type": "array",
            "description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "publicationRange": {
            "type": "array",
            "description": "The range of sequential designation/chronology of publication, or date range",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "electronicAccess": {
            "type": "array",
            "description": "List of electronic access items",
            "items": {
              "type": "object",
              "properties": {
                "uri": {
                  "type": "string",
                  "description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
                },
                "linkText": {
                  "type": "string",
                  "description": "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"
                },
                "materialsSpecification": {
                  "type": "string",
                  "description": "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)"
                },
                "publicNote": {
                  "type": "string",
                  "description": "URL public note to be displayed in the discovery"
                },
                "relationshipId": {
                  "type": "string",
                  "description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
                }
              },
              "additionalProperties": false,
              "required": [
                "uri"
              ]
            }
          },
          "dates": {
            "type": "object",
            "description": "Instance Dates",
            "properties": {
              "dateTypeId": {
                "type": "string",
                "description": "Date type ID",
                "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}$"
              },
              "date1": {
                "type": "string",
                "description": "Date 1",
                "maxLength": 4
              },
              "date2": {
                "type": "string",
                "description": "Date 2",
                "maxLength": 4
              }
            }
          },
          "instanceTypeId": {
            "type": "string",
            "description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
          },
          "instanceFormatIds": {
            "type": "array",
            "description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
            "items": {
              "type": "string"
            }
          },
          "physicalDescriptions": {
            "type": "array",
            "description": "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",
            "items": {
              "type": "string"
            }
          },
          "languages": {
            "type": "array",
            "description": "The set of languages used by the resource",
            "minItems": 0,
            "items": {
              "type": "string"
            }
          },
          "notes": {
            "type": "array",
            "description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
            "items": {
              "type": "object",
              "properties": {
                "instanceNoteTypeId": {
                  "description": "ID of the type of note",
                  "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"
                },
                "staffOnly": {
                  "type": "boolean",
                  "description": "If true, determines that the note should not be visible for others than staff",
                  "default": false
                }
              }
            }
          },
          "administrativeNotes": {
            "type": "array",
            "description": "Administrative notes",
            "minItems": 0,
            "items": {
              "type": "string"
            }
          },
          "modeOfIssuanceId": {
            "type": "string",
            "description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph,  sequential monograph, serial; integrating Resource, other)"
          },
          "catalogedDate": {
            "type": "string",
            "description": "Date or timestamp on an instance for when is was considered cataloged"
          },
          "previouslyHeld": {
            "type": "boolean",
            "description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
          },
          "staffSuppress": {
            "type": "boolean",
            "description": "Records the fact that the record should not be displayed for others than catalogers"
          },
          "discoverySuppress": {
            "type": "boolean",
            "description": "Records the fact that the record should not be displayed in a discovery system"
          },
          "deleted": {
            "type": "boolean",
            "description": "Indicates whether the record was marked for deletion"
          },
          "statisticalCodeIds": {
            "type": "array",
            "description": "List of statistical code IDs",
            "items": {
              "type": "string"
            }
          },
          "sourceRecordFormat": {
            "description": "Format of the instance source record, if a source record exists",
            "type": "string",
            "enum": [
              "MARC-JSON"
            ],
            "readonly": true
          },
          "statusId": {
            "type": "string",
            "description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
          },
          "statusUpdatedDate": {
            "type": "string",
            "description": "Date [or timestamp] for when the instance status was updated"
          },
          "tags": {
            "description": "arbitrary tags associated with this instance",
            "id": "tags",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "tags",
            "properties": {
              "tagList": {
                "description": "List of tags",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "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"
            ]
          },
          "natureOfContentTermIds": {
            "type": "array",
            "description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
            "items": {
              "type": "string",
              "description": "Single UUID for the Instance nature of content",
              "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}$"
            }
          },
          "isBoundWith": {
            "description": "Indicates if this Instance is included in a bound-with",
            "type": "boolean",
            "default": false,
            "readonly": true
          },
          "precedingTitles": {
            "description": "Array of preceding titles",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the preceding title",
                  "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}$"
                },
                "precedingInstanceId": {
                  "description": "Id of the preceding instance id",
                  "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}$"
                },
                "title": {
                  "type": "string",
                  "description": "The primary title (or label) associated with the resource"
                },
                "hrid": {
                  "type": "string",
                  "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
                },
                "identifiers": {
                  "type": "array",
                  "description": "An extensible set of name-value pairs of identifiers associated with the resource",
                  "minItems": 0,
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "Resource identifier value"
                      },
                      "identifierTypeId": {
                        "type": "string",
                        "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "value",
                      "identifierTypeId"
                    ]
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "succeedingTitles": {
            "description": "Array of succeeding titles",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Id of the succeeding title",
                  "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}$"
                },
                "succeedingInstanceId": {
                  "description": "Id of the succeeding instance id",
                  "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}$"
                },
                "title": {
                  "type": "string",
                  "description": "The primary title (or label) associated with the resource"
                },
                "hrid": {
                  "type": "string",
                  "description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
                },
                "identifiers": {
                  "type": "array",
                  "description": "An extensible set of name-value pairs of identifiers associated with the resource",
                  "minItems": 0,
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "Resource identifier value"
                      },
                      "identifierTypeId": {
                        "type": "string",
                        "description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "value",
                      "identifierTypeId"
                    ]
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "source",
          "title",
          "instanceTypeId"
        ]
      }
    },
    "errorMessages": {
      "id": "errorMessagesList",
      "description": "List of error messages",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "totalRecords": {
      "description": "Total number of successfully saved instances",
      "type": "integer"
    }
  },
  "required": [
    "instances",
    "errorMessages",
    "totalRecords"
  ]
}