http://github.com/org/folio/mod-inventory-storage
This documents the API calls that can be made to query and manage nature-of-content terms of the system
Collection of nature-of-content-term items.
Return a list of nature-of-content terms
GET /nature-of-content-termsA 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
Skip over a number of elements by specifying an offset value for the query
Example:
0Limit the number of elements returned in the response
Example:
10Requested language. Optional. [lang=en]
Returns a list of nature-of-content-term items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of nature-of-content terms (controlled vocabulary)",
"type": "object",
"properties": {
"natureOfContentTerms": {
"description": "List of nature-of-content terms",
"id": "natureOfContentTerm",
"type": "array",
"items": {
"type": "object",
"$ref": "natureofcontentterm.json"
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"natureOfContentTerms",
"totalRecords"
]
}
Example:
{
"natureOfContentTerms": [
{
"id": "dc25b657-d892-4b7e-adf4-67e47af18064",
"name": "audiobook",
"source": "folio"
},
{
"id": "5621fb72-8282-4819-9b89-61349ff88027",
"name": "autobiography",
"source": "folio"
},
{
"id": "f9f9e23d-c7f8-446c-97c9-d173f604ad50",
"name": "bibliography",
"source": "folio"
}
],
"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 nature-of-content-terms -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list nature-of-content-terms -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorCreate a new nature-of-content term
POST /nature-of-content-termsRequested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A term describing the nature of content for an instance",
"type": "object",
"properties": {
"id": {
"description": "unique ID of the nature-of-content term",
"$ref": "uuid.json"
},
"name": {
"type": "string",
"description": "term for the nature of content"
},
"source": {
"type": "string",
"description": "label indicating where the term originates from, i.e. 'folio' or 'local'"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"name",
"source"
]
}
Example:
{
"id": "dc25b657-d892-4b7e-adf4-67e47af18064",
"name": "audiobook",
"source": "folio"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created nature-of-content-term item
Media type: application/json
Type: any
Example:
{
"id": "dc25b657-d892-4b7e-adf4-67e47af18064",
"name": "audiobook",
"source": "folio"
}
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 nature-of-content-term -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create nature-of-content-terms -- unauthorizedValidation errors
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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorRetrieve nature-of-content-term item with given {nature-of-content-termId}
GET /nature-of-content-terms/{id}Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A term describing the nature of content for an instance",
"type": "object",
"properties": {
"id": {
"description": "unique ID of the nature-of-content term",
"$ref": "uuid.json"
},
"name": {
"type": "string",
"description": "term for the nature of content"
},
"source": {
"type": "string",
"description": "label indicating where the term originates from, i.e. 'folio' or 'local'"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"name",
"source"
]
}
Example:
{
"id": "dc25b657-d892-4b7e-adf4-67e47af18064",
"name": "audiobook",
"source": "folio"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"nature-of-content-term not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete nature-of-content-term item with given {nature-of-content-termId}
DELETE /nature-of-content-terms/{id}Requested language. Optional. [lang=en]
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 nature-of-content-term -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"nature-of-content-term not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorUpdate nature-of-content-term item with given {nature-of-content-termId}
PUT /nature-of-content-terms/{id}Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A term describing the nature of content for an instance",
"type": "object",
"properties": {
"id": {
"description": "unique ID of the nature-of-content term",
"$ref": "uuid.json"
},
"name": {
"type": "string",
"description": "term for the nature of content"
},
"source": {
"type": "string",
"description": "label indicating where the term originates from, i.e. 'folio' or 'local'"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"name",
"source"
]
}
Example:
{
"id": "dc25b657-d892-4b7e-adf4-67e47af18064",
"name": "audiobook",
"source": "folio"
}
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 nature-of-content-term -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"nature-of-content-term not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator