Bound-With API version v1.1
http://localhost:8081
Bound-With API
API calls for querying and managing individual parts or all parts of bound-withs
/inventory-storage/bound-with-parts
Collection of bound-with-part items.
Return a list of parts of bound-withs
Add a new part to a bound-with item
get /inventory-storage/bound-with-parts
Return a list of parts of bound-withs
Query Parameters
- query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode itemId=aaa - totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
none - offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
10
HTTP status code 200
Returns a list of bound-with-part items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of parts (holdings-records) of one or more bound-with items",
"type": "object",
"properties": {
"boundWithParts": {
"description": "List of bound-with records",
"id": "boundWithPart",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Records the relationship between a part of a bound-with (a holdings-record) and the bound-with as a whole (the circulatable item)",
"properties": {
"id": {
"type": "string",
"description": "unique ID of the recorded bound-with relation; a UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingsRecordId": {
"type": "string",
"description": "the ID of the holdings record representing a part of a bound-with; a UUID"
},
"itemId": {
"type": "string",
"description": "the ID of the item representing the bind; a UUID"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.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"
]
}
},
"additionalProperties": false,
"required": [
"holdingsRecordId",
"itemId"
]
}
},
"totalRecords": {
"description": "Estimated or exact total number of records",
"type": "integer"
}
},
"required": [
"boundWithParts",
"totalRecords"
]
}Example:
{
"boundWithParts": [
{
"id": "f90ee7fb-3805-4e9b-91a2-68b5410b9f3e",
"holdingsRecordId": "af8f136b-93ea-4007-988e-d2b17851a357",
"itemId": "5e9eb5b6-34e0-4714-9f30-a538626c6af5"
},
{
"id": "de0d2126-884b-4e4e-a09a-d7d03c14ca8b",
"holdingsRecordId": "bc803e99-c5fd-4bd6-aae4-998d12f8fcf5",
"itemId": "5e9eb5b6-34e0-4714-9f30-a538626c6af5"
}
],
"totalRecords": 2
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
unable to list bound-with-parts -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list bound-with-parts -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /inventory-storage/bound-with-parts
Add a new part to a bound-with item
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Records the relationship between a part of a bound-with (a holdings-record) and the bound-with as a whole (the circulatable item)",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "unique ID of the recorded bound-with relation; a UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingsRecordId": {
"type": "string",
"description": "the ID of the holdings record representing a part of a bound-with; a UUID"
},
"itemId": {
"type": "string",
"description": "the ID of the item representing the bind; a UUID"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.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"
]
}
},
"additionalProperties": false,
"required": [
"holdingsRecordId",
"itemId"
]
}Example:
{
"id": "f90ee7fb-3805-4e9b-91a2-68b5410b9f3e",
"holdingsRecordId": "af8f136b-93ea-4007-988e-d2b17851a357",
"itemId": "5e9eb5b6-34e0-4714-9f30-a538626c6af5"
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created bound-with-part item
Body
Media type: application/json
Type: any
Example:
{
"id": "f90ee7fb-3805-4e9b-91a2-68b5410b9f3e",
"holdingsRecordId": "af8f136b-93ea-4007-988e-d2b17851a357",
"itemId": "5e9eb5b6-34e0-4714-9f30-a538626c6af5"
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to add bound-with-part -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create bound-with-parts -- unauthorizedHTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorPass in the bound with part id
Retrieve bound-with-part item with given {bound-with-partId}
Delete bound-with-part item with given {bound-with-partId}
Update bound-with-part item with given {bound-with-partId}
get /inventory-storage/bound-with-parts/{id}
Retrieve bound-with-part item with given {bound-with-partId}
URI Parameters
- id: required(string)
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Records the relationship between a part of a bound-with (a holdings-record) and the bound-with as a whole (the circulatable item)",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "unique ID of the recorded bound-with relation; a UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingsRecordId": {
"type": "string",
"description": "the ID of the holdings record representing a part of a bound-with; a UUID"
},
"itemId": {
"type": "string",
"description": "the ID of the item representing the bind; a UUID"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.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"
]
}
},
"additionalProperties": false,
"required": [
"holdingsRecordId",
"itemId"
]
}Example:
{
"id": "f90ee7fb-3805-4e9b-91a2-68b5410b9f3e",
"holdingsRecordId": "af8f136b-93ea-4007-988e-d2b17851a357",
"itemId": "5e9eb5b6-34e0-4714-9f30-a538626c6af5"
}
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"bound-with-part not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /inventory-storage/bound-with-parts/{id}
Delete bound-with-part item with given {bound-with-partId}
URI Parameters
- id: required(string)
HTTP status code 204
Item deleted successfully
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to delete bound-with-part -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"bound-with-part not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorput /inventory-storage/bound-with-parts/{id}
Update bound-with-part item with given {bound-with-partId}
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Records the relationship between a part of a bound-with (a holdings-record) and the bound-with as a whole (the circulatable item)",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "unique ID of the recorded bound-with relation; a UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingsRecordId": {
"type": "string",
"description": "the ID of the holdings record representing a part of a bound-with; a UUID"
},
"itemId": {
"type": "string",
"description": "the ID of the item representing the bind; a UUID"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.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"
]
}
},
"additionalProperties": false,
"required": [
"holdingsRecordId",
"itemId"
]
}Example:
{
"id": "f90ee7fb-3805-4e9b-91a2-68b5410b9f3e",
"holdingsRecordId": "af8f136b-93ea-4007-988e-d2b17851a357",
"itemId": "5e9eb5b6-34e0-4714-9f30-a538626c6af5"
}
HTTP status code 204
Item successfully updated
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to update bound-with-part -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"bound-with-part not found"
HTTP status code 409
Optimistic locking version conflict
Body
Media type: text/plain
Type: any
Example:
version conflictHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administrator/inventory-storage/bound-withs
Manage the collective set of parts (holdings references) of a bound-with item
put /inventory-storage/bound-withs
Manage the collective set of parts (holdings references) of a bound-with item
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Composite entity that records the ID of a bound-with item as well as all the holdings that make up the bound-with.",
"type": "object",
"properties": {
"itemId": {
"type": "string",
"description": "Unique ID (UUID) of the item representing the collection of titles.",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"boundWithContents": {
"type": "array",
"description": "Collection of references to the holdings records that make up the bound-with.",
"items": {
"type": "object",
"properties": {
"holdingsRecordId": {
"type": "string",
"description": "The ID (UUID) of a holdings record included in this bound-with"
}
}
}
}
},
"additionalProperties": false,
"required": [
"itemId",
"boundWithContents"
]
}Example:
{
"itemId": "265093b3-e91d-4b0e-be24-0e7fdc1dceac",
"boundWithContents": [
{
"holdingsRecordId": "d7cf8e51-ca36-4263-8c2a-f78c2615cf2a"
},
{
"holdingsRecordId": "29579ca2-43cb-4b70-9a21-ecd91da605fb"
},
{
"holdingsRecordId": "5972e8b5-0fca-4b1b-bc8c-c6d39fbe05fc"
}
]
}
HTTP status code 204
No content; updates processed.
HTTP status code 400
Constraint violation; referenced Item and/or holdings were not found.
Body
Media type: application/json
Type: any
HTTP status code 422
Schema violation, i.e. missing mandatory property or constraint violations.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "must not be null",
"type": "1",
"code": "javax.validation.constraints.NotNull.message",
"parameters": [
{
"key": "itemId",
"value": "null"
}
]
}
]
}