Inventory Storage Instance Date Type API

Instances Date Types API

/instance-date-types get

get

Retrieve a list of instances date type items.

Request
Response

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

code=a
```
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 instances date type items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of instance date types",
  "type": "object",
  "properties": {
    "instanceDateTypes": {
      "description": "List of instance date types",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An instance date type that indicates the type of dates given in Date 1 and Date 2",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique ID of the instance date type; a UUID",
            "readonly": true
          },
          "name": {
            "type": "string",
            "description": "Name of the instance date type",
            "readonly": true
          },
          "code": {
            "type": "string",
            "description": "Code of the instance date type",
            "maxLength": 1,
            "readonly": true
          },
          "displayFormat": {
            "type": "object",
            "description": "Describes how to format Date 1 and Date 2",
            "properties": {
              "delimiter": {
                "type": "string",
                "description": "Delimiter that will be used to format Date 1 and Date 2",
                "example": ",",
                "readonly": true
              },
              "keepDelimiter": {
                "type": "boolean",
                "description": "Define if formated date string should keep delimiter if one of dates is not exist",
                "example": false,
                "readonly": true
              }
            },
            "readonly": true,
            "additionalProperties": false
          },
          "source": {
            "type": "string",
            "description": "label indicating where the instance date type entry originates from, i.e. 'folio' or 'local'",
            "enum": [
              "folio",
              "local"
            ],
            "readonly": true
          },
          "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
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  }
}

Example:

examples/instance-date-types/instanceDateTypes.json

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 instances date type -- 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 instances date type -- 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

/instance-date-types/{id} patch

patch

Update Instances Date Type item with given id

Request
Response

URI Parameters

id: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Object that represents patch operation for instance date type",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the instance date type"
    }
  },
  "additionalProperties": false
}

Example:

examples/instance-date-types/instanceDateTypePatch.json

HTTP status code 204

Update accepted

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 instances date type -- 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 instances date type -- unauthorized"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"instances date type not found"

HTTP 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 administrator

Inventory Storage Instance Date Type API version v1.0

Instances Date Types API

/instance-date-types get

get /instance-date-types

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 500

Body

/instance-date-types/{id} patch

patch /instance-date-types/{id}

URI Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 404

Body

HTTP status code 422

Body

HTTP status code 500

Body