http://localhost:8081
API calls for querying and managing individual parts or all parts of bound-withs
Collection of bound-with-part items.
Return a list of parts of bound-withs
GET /inventory-storage/bound-with-partsA 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
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:
noneSkip over a number of elements by specifying an offset value for the query
Example:
0Limit 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:
10Returns a list of bound-with-part items
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
}
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.
Media type: text/plain
Type: any
Example:
unable to list bound-with-parts -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list bound-with-parts -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorAdd a new part to a bound-with item
POST /inventory-storage/bound-with-partsMedia 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"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created bound-with-part item
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"
}
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.
Media type: text/plain
Type: any
Example:
"unable to add bound-with-part -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create bound-with-parts -- unauthorizedValidation errors
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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorRetrieve bound-with-part item with given {bound-with-partId}
GET /inventory-storage/bound-with-parts/{id}Returns item with a given ID
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"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"bound-with-part not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete bound-with-part item with given {bound-with-partId}
DELETE /inventory-storage/bound-with-parts/{id}Item deleted successfully
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.
Media type: text/plain
Type: any
Example:
"unable to delete bound-with-part -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"bound-with-part not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorUpdate bound-with-part item with given {bound-with-partId}
PUT /inventory-storage/bound-with-parts/{id}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"
}
Item successfully updated
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.
Media type: text/plain
Type: any
Example:
"unable to update bound-with-part -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"bound-with-part not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflictInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorManage the collective set of parts (holdings references) of a bound-with item
PUT /inventory-storage/bound-withsMedia 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"
}
]
}
No content; updates processed.
Constraint violation; referenced Item and/or holdings were not found.
Media type: application/json
Type: any
Schema violation, i.e. missing mandatory property or constraint violations.
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"
}
]
}
]
}