API docs by Redocly

Remote storages API (v1)

getConfigurations

Get a list of remote storage configurations

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

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

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

query
string

A query string to filter rules based on matching criteria in fields.

Responses

Response samples

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

postConfiguration

Add new remote storage configuration

Request Body schema: application/json
required
id
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

name
required
string

configuration name

apiKey
string

remote storage apiKey

providerName
required
string

remote storage provider name

url
string

remote storage url

statusUrl
string

remote storage url

accessionDelay
integer >= 1

accession schedule delay

accessionTimeUnit
string (timeUnits)
Enum: "minutes" "hours" "days" "weeks" "months"

Time units

accessionWorkflowDetails
string (accessionWorkflowDetails)
Enum: "Duplicate holdings" "Change permanent location"

Accession workflow details

returningWorkflowDetails
string (returningWorkflowDetails)
Enum: "Scanned to folio" "Scanned to CaiaSoft"

Return workflow details

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "apiKey": "string",
  • "providerName": "string",
  • "url": "string",
  • "statusUrl": "string",
  • "accessionDelay": 1,
  • "accessionTimeUnit": "minutes",
  • "accessionWorkflowDetails": "Duplicate holdings",
  • "returningWorkflowDetails": "Scanned to folio",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "apiKey": "string",
  • "providerName": "string",
  • "url": "string",
  • "statusUrl": "string",
  • "accessionDelay": 1,
  • "accessionTimeUnit": "minutes",
  • "accessionWorkflowDetails": "Duplicate holdings",
  • "returningWorkflowDetails": "Scanned to folio",
  • "metadata": {
    }
}

getConfigurationById

path Parameters
configId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "apiKey": "string",
  • "providerName": "string",
  • "url": "string",
  • "statusUrl": "string",
  • "accessionDelay": 1,
  • "accessionTimeUnit": "minutes",
  • "accessionWorkflowDetails": "Duplicate holdings",
  • "returningWorkflowDetails": "Scanned to folio",
  • "metadata": {
    }
}

putConfiguration

Change the remote storage configuration

path Parameters
configId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Request Body schema: application/json
required
id
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

name
required
string

configuration name

apiKey
string

remote storage apiKey

providerName
required
string

remote storage provider name

url
string

remote storage url

statusUrl
string

remote storage url

accessionDelay
integer >= 1

accession schedule delay

accessionTimeUnit
string (timeUnits)
Enum: "minutes" "hours" "days" "weeks" "months"

Time units

accessionWorkflowDetails
string (accessionWorkflowDetails)
Enum: "Duplicate holdings" "Change permanent location"

Accession workflow details

returningWorkflowDetails
string (returningWorkflowDetails)
Enum: "Scanned to folio" "Scanned to CaiaSoft"

Return workflow details

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "apiKey": "string",
  • "providerName": "string",
  • "url": "string",
  • "statusUrl": "string",
  • "accessionDelay": 1,
  • "accessionTimeUnit": "minutes",
  • "accessionWorkflowDetails": "Duplicate holdings",
  • "returningWorkflowDetails": "Scanned to folio",
  • "metadata": {
    }
}

deleteConfigurationById

path Parameters
configId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

postMapping

Add/update a mapping between remote and Folio locations

Request Body schema: application/json
required
folioLocationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

configurationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Request samples

Content type
application/json
{
  • "folioLocationId": "string",
  • "configurationId": "string"
}

Response samples

Content type
application/json
{
  • "folioLocationId": "string",
  • "configurationId": "string"
}

getMappings

Get a list of location mappings

query Parameters
finalLocationId
string

Final location id

remoteStorageConfigurationId
string

Remote storage configuration id

offset
integer [ 0 .. 2147483647 ]
Default: 0

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

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

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

getMappingById

path Parameters
folioLocationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Response samples

Content type
application/json
{
  • "folioLocationId": "string",
  • "configurationId": "string"
}

deleteMappingById

path Parameters
folioLocationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

postExtendedRemoteLocationConfigurationMapping

Add/update a mapping between remote and Folio locations

Request Body schema: application/json
required
finalLocationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

remoteConfigurationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

originalLocationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Request samples

Content type
application/json
{
  • "finalLocationId": "string",
  • "remoteConfigurationId": "string",
  • "originalLocationId": "string"
}

Response samples

Content type
application/json
{
  • "finalLocationId": "string",
  • "remoteConfigurationId": "string",
  • "originalLocationId": "string"
}

getExtendedRemoteLocationConfigurationMappings

Get a list of location mappings

query Parameters
finalLocationId
string

Final location id

remoteStorageConfigurationId
string

Remote storage configuration id

originalLocationId
string

Original location id

offset
integer [ 0 .. 2147483647 ]
Default: 0

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

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

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

getExtendedRemoteLocationConfigurationMappingsById

path Parameters
finalLocationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Response samples

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

deleteOriginalLocationByRemoteStorageConfigurationIdAndOriginalLocationId

path Parameters
remoteStorageConfigurationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

originalLocationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

getExtendedRemoteLocationConfigurationMappingsLocations

Get a list of location mappings

query Parameters
remoteStorageConfigurationId
string

Remote storage configuration id

offset
integer [ 0 .. 2147483647 ]
Default: 0

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

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

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

getProviders

Get a list of providers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

postAccession

Perform remote storage initiated accession

Request Body schema: application/json
required
itemBarcode
required
string

Barcode of the item to be accessioned

remoteStorageId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string",
  • "remoteStorageId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "itemBarcode": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "accessionedDateTime": "2019-08-24T14:15:22Z",
  • "remoteStorageId": "string",
  • "callNumber": "string",
  • "instanceTitle": "string",
  • "instanceAuthor": "string",
  • "instanceContributors": "string",
  • "publisher": "string",
  • "publishYear": "string",
  • "publishPlace": "string",
  • "volume": "string",
  • "enumeration": "string",
  • "chronology": "string",
  • "issn": "string",
  • "isbn": "string",
  • "oclc": "string",
  • "physicalDescription": "string",
  • "materialType": "string",
  • "copyNumber": "string",
  • "permanentLocationId": "string",
  • "notes": [
    ],
  • "metadata": {
    }
}

getAccessions

Get a list of accession records

query Parameters
accessioned
boolean

Flag to indicate, that accession queue record was accessioned and has accesion date

storageId
string

Remote storage id

createdDate
string

Date of accession queue record creation

offset
integer [ 0 .. 2147483647 ]
Default: 0

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

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

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

setAccessionedById

Set accessioned date by accession queue id

path Parameters
accessionId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

setAccessionedByBarcode

Set accessioned date by item barcode

path Parameters
barcode
required
string

Responses

/pub-sub-handlers/log-record-event

Request Body schema: application/json
required
logEventType
required
string

A payload for the log record event

payload
object

A payload for the log record event

itemBarcode
string

An item barcode (for check in log record event)

Responses

Request samples

Content type
application/json
{
  • "logEventType": "string",
  • "payload": { },
  • "itemBarcode": "string"
}

getRetrievals

Get a list of retrieval records

query Parameters
retrieved
boolean

Flag to indicate, that retrievals queue record was retrieved and has retrievals date

storageId
string

Remote storage id

createdDate
string

Date of accession queue record creation

offset
integer [ 0 .. 2147483647 ]
Default: 0

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

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

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

setRetrievedById

Set retrieval date by retrieval queue id

path Parameters
retrievalId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

setRetrievedByBarcode

Set retrieved date by item barcode

path Parameters
barcode
required
string

Responses

checkInItemByBarcodeWithRemoteStorageConfigurationId

Check-in the item in the primary service by barcode value

path Parameters
remoteStorageConfigurationId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Request Body schema: application/json
required
itemBarcode
required
string

Barcode of the item to be checked in

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string"
}

Response samples

Content type
application/json
"examples/errors.sample"

checkInItemByHoldIdWithRemoteStorageConfigurationId

Check-in the item in the primary service by barcode value

path Parameters
remoteStorageConfigurationId
required
string
Request Body schema: application/json
required
holdId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Request samples

Content type
application/json
{
  • "holdId": "string"
}

Response samples

Content type
application/json
"examples/errors.sample"

returnItemByBarcode

Return the item by barcode

path Parameters
remoteStorageConfigurationId
required
string
Request Body schema: application/json
required
itemBarcode
required
string

Barcode of the item to be checked in

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string"
}

Response samples

Content type
application/json
{
  • "isHoldRecallRequestExist": "false"
}

markItemAsMissingByBarcode

Mark item as missing

path Parameters
barcode
required
string

Responses