Instance Types API API documentation version v2.0
http://localhost
Instance Types API
This documents the API calls that can be made to query and manage instance resource types
/instance-types
Collection of instance-type items.
Return a list of instance types
Create a new instance type
get /instance-types
Return a list of instance types
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 name=aaa
- 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
Example:
10
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns a list of instance-type items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of Instance resource types (controlled vocabulary)",
"type": "object",
"properties": {
"instanceTypes": {
"description": "List of instance types",
"id": "instanceType",
"type": "array",
"items": {
"type": "object",
"$ref": "instancetype.json"
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"instanceTypes",
"totalRecords"
]
}
Example:
{
"instanceTypes": [
{
"id": "535e3160-763a-42f9-b0c0-d8ed7df6e2a2",
"name": "still image",
"code": "sti",
"source": "rdacarrier"
},
{
"id": "df5dddff-9c30-4507-8b82-119ff972d4d7",
"name": "computer dataset",
"code": "cod",
"source": "rdacarrier"
},
{
"id": "8105bd44-e7bd-487e-a8f2-b804a361d92f",
"name": "tactile text",
"code": "tct",
"source": "rdacarrier"
}
],
"totalRecords": 3
}
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 instance-types -- malformed parameter 'query', syntax error at column 6
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list instance-types -- unauthorized
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
post /instance-types
Create a new instance type
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The resource type of an Instance",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"description": "label for the resource type",
"type": "string"
},
"code": {
"description": "distinct code for the resource type",
"type": "string"
},
"source": {
"description": "origin of a resource type record",
"source": "string"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name",
"code",
"source"
]
}
Example:
{
"id": "535e3160-763a-42f9-b0c0-d8ed7df6e2a2",
"name": "still image",
"code": "sti",
"source": "rdacarrier"
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required (string)
URI to the created instance-type item
Body
Media type: application/json
Type: any
Example:
{
"id": "535e3160-763a-42f9-b0c0-d8ed7df6e2a2",
"name": "still image",
"code": "sti",
"source": "rdacarrier"
}
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 instance-type -- 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 instance-types -- unauthorized
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"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 administrator
Pass in the instance type id
Retrieve instance-type item with given {instance-typeId}
Delete instance-type item with given {instance-typeId}
Update instance-type item with given {instance-typeId}
get /instance-types/{instanceTypeId}
Retrieve instance-type item with given {instance-typeId}
URI Parameters
- instanceTypeId: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
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": "The resource type of an Instance",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"description": "label for the resource type",
"type": "string"
},
"code": {
"description": "distinct code for the resource type",
"type": "string"
},
"source": {
"description": "origin of a resource type record",
"source": "string"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name",
"code",
"source"
]
}
Example:
{
"id": "535e3160-763a-42f9-b0c0-d8ed7df6e2a2",
"name": "still image",
"code": "sti",
"source": "rdacarrier"
}
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"instance-type 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 administrator
delete /instance-types/{instanceTypeId}
Delete instance-type item with given {instance-typeId}
URI Parameters
- instanceTypeId: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
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 instance-type -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"instance-type 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 administrator
put /instance-types/{instanceTypeId}
Update instance-type item with given {instance-typeId}
URI Parameters
- instanceTypeId: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The resource type of an Instance",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"description": "label for the resource type",
"type": "string"
},
"code": {
"description": "distinct code for the resource type",
"type": "string"
},
"source": {
"description": "origin of a resource type record",
"source": "string"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name",
"code",
"source"
]
}
Example:
{
"id": "535e3160-763a-42f9-b0c0-d8ed7df6e2a2",
"name": "still image",
"code": "sti",
"source": "rdacarrier"
}
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 instance-type -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"instance-type 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 administrator