http://localhost:9130
Storage for request policies
Retrieve a list of request-policy items.
GET /request-policy-storage/request-policiesSkip over a number of elements by specifying an offset value for the query
Example:
0Limit the number of elements returned in the response
Example:
10A 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.
searchable using CQL
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
id="cf23adf0-61ba-4887-bf82-956c4aae2260"
Requested language. Optional. [lang=en]
Returns a list of request-policy items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of request policies",
"type": "object",
"properties": {
"requestPolicies": {
"description": "List of request policies",
"id": "requestPolicies",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "request policy schema",
"properties": {
"id": {
"description": "Unique request policy ID",
"type": "string"
},
"name": {
"description": "Unique request policy name, required",
"type": "string"
},
"description": {
"description": "Description of request policy",
"type": "string"
},
"requestTypes": {
"description": "Whether the item should be held upon return, recalled or paged for",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Whether the item should be held upon return, recalled or paged for",
"enum": [
"Hold",
"Recall",
"Page"
],
"additionalProperties": false
}
},
"metadata": {
"description": "Metadata about creation and changes to request policy, provided by the server (client should not provide)",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"type": "object",
"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": [
"name"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"requestPolicies",
"totalRecords"
]
}Example:
{
"requestPolicies": [
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Example Request Policy",
"description" : "Description of request policy",
"requestTypes" : ["Hold", "Page"]
},
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177232",
"name": "Example Recall Request Policy",
"description" : "Description of request policy",
"requestTypes" : ["Recall"]
},
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177233",
"name": "Example all-request-types Request Policy",
"description" : "Description of request policy",
"requestTypes" : ["Hold", "Page", "Recall"]
}
],
"totalRecords": 3
}
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 request-policies -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list request-policies -- unauthorizedGeneral errors
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorCreate a new request-policy item.
POST /request-policy-storage/request-policiesRequested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "request policy schema",
"properties": {
"id": {
"description": "Unique request policy ID",
"type": "string"
},
"name": {
"description": "Unique request policy name, required",
"type": "string"
},
"description": {
"description": "Description of request policy",
"type": "string"
},
"requestTypes": {
"description": "Whether the item should be held upon return, recalled or paged for",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Whether the item should be held upon return, recalled or paged for",
"enum": [
"Hold",
"Recall",
"Page"
],
"additionalProperties": false
}
},
"metadata": {
"description": "Metadata about creation and changes to request policy, provided by the server (client should not provide)",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"type": "object",
"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": [
"name"
]
}Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Example Request Policy",
"description" : "Description of request policy",
"requestTypes" : ["Hold", "Page"]
}
Request policy created
URI to the created request-policy item
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "request policy schema",
"properties": {
"id": {
"description": "Unique request policy ID",
"type": "string"
},
"name": {
"description": "Unique request policy name, required",
"type": "string"
},
"description": {
"description": "Description of request policy",
"type": "string"
},
"requestTypes": {
"description": "Whether the item should be held upon return, recalled or paged for",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Whether the item should be held upon return, recalled or paged for",
"enum": [
"Hold",
"Recall",
"Page"
],
"additionalProperties": false
}
},
"metadata": {
"description": "Metadata about creation and changes to request policy, provided by the server (client should not provide)",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"type": "object",
"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": [
"name"
]
}Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Example Request Policy",
"description" : "Description of request policy",
"requestTypes" : ["Hold", "Page"]
}
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 request-policy -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create request-policies -- unauthorizedGeneral errors
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorDELETE /request-policy-storage/request-policiesRequested language. Optional. [lang=en]
All request policies deleted
General errors
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorNot implemented yet
Retrieve request-policy item with given {request-policyId}
GET /request-policy-storage/request-policies/{requestPolicyId}Requested language. Optional. [lang=en]
Request policy successfully retreived
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "request policy schema",
"properties": {
"id": {
"description": "Unique request policy ID",
"type": "string"
},
"name": {
"description": "Unique request policy name, required",
"type": "string"
},
"description": {
"description": "Description of request policy",
"type": "string"
},
"requestTypes": {
"description": "Whether the item should be held upon return, recalled or paged for",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Whether the item should be held upon return, recalled or paged for",
"enum": [
"Hold",
"Recall",
"Page"
],
"additionalProperties": false
}
},
"metadata": {
"description": "Metadata about creation and changes to request policy, provided by the server (client should not provide)",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"type": "object",
"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": [
"name"
]
}Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Example Request Policy",
"description" : "Description of request policy",
"requestTypes" : ["Hold", "Page"]
}
Not found
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorGeneral errors
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorNot implemented yet
Update request-policy item with given {request-policyId}
PUT /request-policy-storage/request-policies/{requestPolicyId}Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "request policy schema",
"properties": {
"id": {
"description": "Unique request policy ID",
"type": "string"
},
"name": {
"description": "Unique request policy name, required",
"type": "string"
},
"description": {
"description": "Description of request policy",
"type": "string"
},
"requestTypes": {
"description": "Whether the item should be held upon return, recalled or paged for",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Whether the item should be held upon return, recalled or paged for",
"enum": [
"Hold",
"Recall",
"Page"
],
"additionalProperties": false
}
},
"metadata": {
"description": "Metadata about creation and changes to request policy, provided by the server (client should not provide)",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"type": "object",
"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": [
"name"
]
}Example:
{
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Example Request Policy",
"description" : "Description of request policy",
"requestTypes" : ["Hold", "Page"]
}
Request policy 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 request-policy -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"request-policy not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflictGeneral errors
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorNot implemented yet
Delete request-policy item with given {request-policyId}
DELETE /request-policy-storage/request-policies/{requestPolicyId}Requested language. Optional. [lang=en]
Request policy successfully deleted
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 request-policy -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"request-policy not found"
General errors
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator