API docs by Redocly

RTAC Cache API (1.0.0)

rtac

Search RTAC holdings for a given instance

path Parameters
instanceId
required
string <uuid>

The UUID of a FOLIO instance

query Parameters
query
required
string

A search query to find holdings by volume, location name, or call number

available
boolean

Filter by holdings that are available

sort
Array of strings

A list of sort criteria in the format: property,(asc|desc). Supported properties are: effectiveShelvingOrder, libraryName, locationName, status. The default sort order is effectiveShelvingOrder, libraryName, locationName, status (ascending).

offset
integer [ 0 .. 100000 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 100

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "instanceId": "string",
  • "holdings": [
    ],
  • "totalRecords": 0
}

Browse RTAC holdings for a single instance

path Parameters
id
required
string <uuid>

The UUID of a FOLIO instance

query Parameters
sort
Array of strings

A list of sort criteria in the format: property,(asc|desc). Supported properties are: effectiveShelvingOrder, libraryName, locationName, status. The default sort order is effectiveShelvingOrder, libraryName, locationName, status (ascending).

offset
integer [ 0 .. 100000 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 100

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "instanceId": "string",
  • "holdings": [
    ],
  • "totalRecords": 0
}

Retrieve RTAC holdings in batch

Request Body schema: application/json
required
instanceIds
required
Array of strings (uuid) non-empty [ items^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... ]

Inventory instances identifiers

Responses

Request samples

Content type
application/json
{
  • "instanceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "holdings": [
    ],
  • "errors": [
    ]
}

Invalidate RTAC cache entries by instance IDs

Request Body schema: application/json
required
instanceIds
required
Array of strings (uuid) non-empty [ items^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... ]

Inventory instances identifiers

Responses

Request samples

Content type
application/json
{
  • "instanceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

Invalidate all RTAC cache entries

Responses

Response samples

Content type
text/plain
Access Denied

Get prewarming job statuses

query Parameters
offset
integer [ 0 .. 100000 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 100

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "jobs": [
    ],
  • "totalRecords": 0
}

Submit cache prewarming job

Request Body schema: application/json
required
instanceIds
Array of strings <uuid> [ items <uuid > ]

Prewarm instances with at least this many items

Responses

Request samples

Content type
application/json
{
  • "instanceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "status": "RUNNING",
  • "errorMessage": "string"
}

Get prewarming job status by ID

path Parameters
id
required
string <uuid>

The UUID of a RTAC prewarming job

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "status": "RUNNING",
  • "errorMessage": "string"
}