API docs by Redocly

Folio ERM Agreements (7.3.0)

URL: https://www.k-int.com

API for the Folio library services platform mod-agreements app

Agreements

Get a set of subscription agreement (SA) aka Agreement records.

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create subscription agreement (SA) aka Agreement record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
description
string
required
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (AlternateName)
Array
name
required
string
localReference
string
vendorReference
string
Array of objects (AgreementContentType)
Array
object (Refdata)
required
Array of objects
Array
startDate
required
string <date>
endDate
string <date>
cancellationDeadline
string <date>
periodStatus
string
note
string
id
string <uuid>
Array of objects (InternalContact)
Array
id
string <uuid>
object
string or Refdata (object)
user
string <uuid>
Array of objects (AgreementOrg)

Organisations associated with the agreement

Array
object (Organisation)
primaryOrg
boolean
Default: false

Whether this is the primary organisation for the agreement

note
string

A note about this organisation's relationship to the agreement

Array of objects

The roles this organisation plays in relation to the agreement

Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (LinkedLicense)
Array
Array of objects (LinkedAmendment)
id
string
owner
string <uuid>
remoteId
string <uuid>
remoteId_object
object
string or Refdata (object)
Array of objects (UsageDataProvider)
Array
id
string
object
remoteId
string <uuid>
remoteId_object
object
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
object

Custom properties (agreement supplementary properties) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "cancellationDeadline": "2019-08-24",
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Get a specified agreement record

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "cancellationDeadline": "2019-08-24",
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Update agreement record

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
description
string
required
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (AlternateName)
Array
name
required
string
localReference
string
vendorReference
string
Array of objects (AgreementContentType)
Array
object (Refdata)
required
Array of objects
Array
startDate
required
string <date>
endDate
string <date>
cancellationDeadline
string <date>
periodStatus
string
note
string
id
string <uuid>
Array of objects (InternalContact)
Array
id
string <uuid>
object
string or Refdata (object)
user
string <uuid>
Array of objects (AgreementOrg)

Organisations associated with the agreement

Array
object (Organisation)
primaryOrg
boolean
Default: false

Whether this is the primary organisation for the agreement

note
string

A note about this organisation's relationship to the agreement

Array of objects

The roles this organisation plays in relation to the agreement

Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (LinkedLicense)
Array
Array of objects (LinkedAmendment)
id
string
owner
string <uuid>
remoteId
string <uuid>
remoteId_object
object
string or Refdata (object)
Array of objects (UsageDataProvider)
Array
id
string
object
remoteId
string <uuid>
remoteId_object
object
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
object

Custom properties (agreement supplementary properties) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "cancellationDeadline": "2019-08-24",
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Delete a specified agreement record

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Returns all resources in the internal KB associated with specified agreement

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns all resources in the internal KB associated with specified agreement

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns resources in the internal KB associated with specified agreement actively part of the agreement on the current date

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns resources in the internal KB associated with specified agreement which were actively part of the agreement in the past

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns resources in the internal KB associated with specified agreement which will be actively part of the agreement in the future

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns all resources in the internal KB associated with specified agreement based on direct HQL query

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns all resources in the internal KB associated with specified agreement based on direct HQL query

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns resources in the internal KB associated with specified agreement actively part of the agreement on the current date based on direct HQL query

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns resources in the internal KB associated with specified agreement which were actively part of the agreement in the past based on direct HQL query

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns resources in the internal KB associated with specified agreement which will be actively part of the agreement in the future based on direct HQL query

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Returns a list of either current or all resources in the internal KB associated with specified agreement using the specified format

format: kbart returns a tab-separated KBART file (one row per Package Content Item; Platform Title Instances and directly-entitled Title Instances are silently skipped). Any other format value returns a JSON array.

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

subset
required
string
Enum: "current" "all"
format
required
string
Enum: "json" "kbart"
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Returns JSON for an Agreement including a list of resources currently available via the agreement

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "cancellationDeadline": "2019-08-24",
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    },
  • "resources": [
    ]
}

Clones (makes a duplicate) of the specified agreement

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters
description
string
required
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (AlternateName)
Array
name
required
string
localReference
string
vendorReference
string
Array of objects (AgreementContentType)
Array
object (Refdata)
required
Array of objects
Array
startDate
required
string <date>
endDate
string <date>
cancellationDeadline
string <date>
periodStatus
string
note
string
id
string <uuid>
Array of objects (InternalContact)
Array
id
string <uuid>
object
string or Refdata (object)
user
string <uuid>
Array of objects (AgreementOrg)

Organisations associated with the agreement

Array
object (Organisation)
primaryOrg
boolean
Default: false

Whether this is the primary organisation for the agreement

note
string

A note about this organisation's relationship to the agreement

Array of objects

The roles this organisation plays in relation to the agreement

Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (LinkedLicense)
Array
Array of objects (LinkedAmendment)
id
string
owner
string <uuid>
remoteId
string <uuid>
remoteId_object
object
string or Refdata (object)
Array of objects (UsageDataProvider)
Array
id
string
object
remoteId
string <uuid>
remoteId_object
object
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
object

Custom properties (agreement supplementary properties) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "cancellationDeadline": "2019-08-24",
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Retrieves the licenses and amendments for a specified agreement from the licenses module

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Retrieves the usage data providers for a specified agreement

Authorizations:
accessTokenokapiToken
path Parameters
agreementId
required
string <uuid>

UUID for an Agreement

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a list of agreements including license terms for a resource or set of resources.

Authorizations:
accessTokenokapiToken
query Parameters
referenceId
string
resourceId
string
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "header": {
    },
  • "records": [
    ]
}

Retrieves the licenses and amendments for a set of agreements that fulfil the query parameters

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Retrieves the usage data providers for a set of agreements that fulfil the query parameters

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Entitlements

Get a set of entitlement aka agreement line records.

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create entitlement aka agreement line record.

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string <uuid>
dateCreated
string <date-time>
lastUpdated
string <date-time>
activeFrom
string or null <date>
activeTo
string or null <date>
authority
string
Enum: "GOKB-RESOURCE" "EKB-PACKAGE" "EKB-TITLE"
contentUpdated
string or null <date-time>
customCoverage
boolean
Array of objects (CoverageStatement)
Array
id
string <uuid>
startDate
string <date>
endDate
string <date>
summary
string
startVolume
string
startIssue
string
endVolume
string
endIssue
string
Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
explanation
string
haveAccess
boolean
note
string
description
string
Array of objects (PurchaseOrderLine)
Array
id
string <uuid>
object
poLineId
string <uuid>
PackageContentItem (object) or Package (object) (EntitlementOption)
One of
id
string <uuid>
class
required
string
Enum: "org.olf.kb.PackageContentItem" "org.olf.kb.TitleInstance" "org.olf.kb.PlatformTitleInstance" "org.olf.kb.Pkg"
Array of objects (CoverageStatement)
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
string
description
string
string or Refdata (object)
suppressFromDiscovery
boolean
string or Refdata (object)
Array of objects (Tag)
string or Refdata (object)
Array of objects (AlternateResourceName)
Array of objects (IdentifierOccurrence)
(TitleInstance (object) or TitleInstance (object) or TitleInstance (object) or TitleInstance (object)) or (PlatformTitleInstance (object) or PlatformTitleInstance (object) or PlatformTitleInstance (object) or PlatformTitleInstance (object)) or (PackageContentItem (object) or PackageContentItem (object) or PackageContentItem (object) or PackageContentItem (object)) or (Package (object) or Package (object) or Package (object) or Package (object))
accessStart
string <date>
accessEnd
string <date>
addedTimestamp
integer
depth
string
lastSeenTimestamp
integer
longName
string
note
string
removedTimestamp
integer
object (Embargo)
object (Package)
object (PlatformTitleInstance)
reference
string
reference_object
object
suppressFromDiscovery
boolean
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
type
string
Enum: "detached" "external" "internal"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "activeFrom": "2019-08-24",
  • "activeTo": "2019-08-24",
  • "authority": "GOKB-RESOURCE",
  • "contentUpdated": "2019-08-24T14:15:22Z",
  • "customCoverage": true,
  • "coverage": [
    ],
  • "docs": [
    ],
  • "explanation": "string",
  • "haveAccess": true,
  • "note": "string",
  • "description": "string",
  • "owner": {
    },
  • "poLines": [
    ],
  • "resource": {
    },
  • "reference": "string",
  • "reference_object": { },
  • "suppressFromDiscovery": true,
  • "tags": [
    ],
  • "type": "detached"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "activeFrom": "2019-08-24",
  • "activeTo": "2019-08-24",
  • "authority": "GOKB-RESOURCE",
  • "contentUpdated": "2019-08-24T14:15:22Z",
  • "customCoverage": true,
  • "coverage": [
    ],
  • "docs": [
    ],
  • "endDate": "2019-08-24",
  • "explanation": "string",
  • "haveAccess": true,
  • "note": "string",
  • "description": "string",
  • "owner": {
    },
  • "poLines": [
    ],
  • "resource": {
    },
  • "reference": "string",
  • "reference_object": { },
  • "startDate": "2019-08-24",
  • "suppressFromDiscovery": true,
  • "tags": [
    ],
  • "type": "detached"
}

Get a specified entitlement record

Authorizations:
accessTokenokapiToken
path Parameters
entitlementId
required
string <uuid>

UUID for an Entitlement (Agreement line)

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "activeFrom": "2019-08-24",
  • "activeTo": "2019-08-24",
  • "authority": "GOKB-RESOURCE",
  • "contentUpdated": "2019-08-24T14:15:22Z",
  • "customCoverage": true,
  • "coverage": [
    ],
  • "docs": [
    ],
  • "endDate": "2019-08-24",
  • "explanation": "string",
  • "haveAccess": true,
  • "note": "string",
  • "description": "string",
  • "owner": {
    },
  • "poLines": [
    ],
  • "resource": {
    },
  • "reference": "string",
  • "reference_object": { },
  • "startDate": "2019-08-24",
  • "suppressFromDiscovery": true,
  • "tags": [
    ],
  • "type": "detached"
}

Update entitlement record

Authorizations:
accessTokenokapiToken
path Parameters
entitlementId
required
string <uuid>

UUID for an Entitlement (Agreement line)

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string <uuid>
dateCreated
string <date-time>
lastUpdated
string <date-time>
activeFrom
string or null <date>
activeTo
string or null <date>
authority
string
Enum: "GOKB-RESOURCE" "EKB-PACKAGE" "EKB-TITLE"
contentUpdated
string or null <date-time>
customCoverage
boolean
Array of objects (CoverageStatement)
Array
id
string <uuid>
startDate
string <date>
endDate
string <date>
summary
string
startVolume
string
startIssue
string
endVolume
string
endIssue
string
Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
explanation
string
haveAccess
boolean
note
string
description
string
Array of objects (PurchaseOrderLine)
Array
id
string <uuid>
object
poLineId
string <uuid>
PackageContentItem (object) or Package (object) (EntitlementOption)
One of
id
string <uuid>
class
required
string
Enum: "org.olf.kb.PackageContentItem" "org.olf.kb.TitleInstance" "org.olf.kb.PlatformTitleInstance" "org.olf.kb.Pkg"
Array of objects (CoverageStatement)
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
string
description
string
string or Refdata (object)
suppressFromDiscovery
boolean
string or Refdata (object)
Array of objects (Tag)
string or Refdata (object)
Array of objects (AlternateResourceName)
Array of objects (IdentifierOccurrence)
(TitleInstance (object) or TitleInstance (object) or TitleInstance (object) or TitleInstance (object)) or (PlatformTitleInstance (object) or PlatformTitleInstance (object) or PlatformTitleInstance (object) or PlatformTitleInstance (object)) or (PackageContentItem (object) or PackageContentItem (object) or PackageContentItem (object) or PackageContentItem (object)) or (Package (object) or Package (object) or Package (object) or Package (object))
accessStart
string <date>
accessEnd
string <date>
addedTimestamp
integer
depth
string
lastSeenTimestamp
integer
longName
string
note
string
removedTimestamp
integer
object (Embargo)
object (Package)
object (PlatformTitleInstance)
reference
string
reference_object
object
suppressFromDiscovery
boolean
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
type
string
Enum: "detached" "external" "internal"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "activeFrom": "2019-08-24",
  • "activeTo": "2019-08-24",
  • "authority": "GOKB-RESOURCE",
  • "contentUpdated": "2019-08-24T14:15:22Z",
  • "customCoverage": true,
  • "coverage": [
    ],
  • "docs": [
    ],
  • "explanation": "string",
  • "haveAccess": true,
  • "note": "string",
  • "description": "string",
  • "owner": {
    },
  • "poLines": [
    ],
  • "resource": {
    },
  • "reference": "string",
  • "reference_object": { },
  • "suppressFromDiscovery": true,
  • "tags": [
    ],
  • "type": "detached"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "activeFrom": "2019-08-24",
  • "activeTo": "2019-08-24",
  • "authority": "GOKB-RESOURCE",
  • "contentUpdated": "2019-08-24T14:15:22Z",
  • "customCoverage": true,
  • "coverage": [
    ],
  • "docs": [
    ],
  • "endDate": "2019-08-24",
  • "explanation": "string",
  • "haveAccess": true,
  • "note": "string",
  • "description": "string",
  • "owner": {
    },
  • "poLines": [
    ],
  • "resource": {
    },
  • "reference": "string",
  • "reference_object": { },
  • "startDate": "2019-08-24",
  • "suppressFromDiscovery": true,
  • "tags": [
    ],
  • "type": "detached"
}

Delete a specified entitlement record

Authorizations:
accessTokenokapiToken
path Parameters
entitlementId
required
string <uuid>

UUID for an Entitlement (Agreement line)

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Entitlement Log

Get a set of entitlement log entries.

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified entitlement log entry record

Authorizations:
accessTokenokapiToken
path Parameters
entitlementLogEntryId
required
string <uuid>

UUID for an entitlement log entry

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "seqid": "string",
  • "entitlement_id": "5d403832-720f-4924-9542-f160bdee9e96",
  • "resource_name": "string",
  • "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  • "activeEntitlementCountForResource": "string",
  • "title": "string",
  • "defaultCoverage": [
    ],
  • "coverage": [
    ],
  • "customCoverage": true,
  • "identifiers": [
    ],
  • "suppress": true,
  • "type": "string",
  • "license": "string",
  • "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  • "eventType": "ADD",
  • "url": "http://example.com",
  • "packageIds": [
    ],
  • "templatedUrls": [
    ]
}

Packages

Get a set of package records.

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified package record

Authorizations:
accessTokenokapiToken
path Parameters
packageId
required
string <uuid>

UUID for a Package

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.Pkg",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "source": "string",
  • "sourceDataCreated": "2019-08-24T14:15:22Z",
  • "sourceDataUpdated": "2019-08-24T14:15:22Z",
  • "sourceTitleCount": 0,
  • "syncContentsFromSource": true,
  • "reference": "string",
  • "nominalPlatform": {
    },
  • "vendor": {
    },
  • "lifecycleStatus": "string",
  • "availabilityScope": "string",
  • "packageDescriptionUrls": [],
  • "contentTypes": [
    ],
  • "availabilityConstraints": [
    ],
  • "resourceCount": 0
}

Update package record

Authorizations:
accessTokenokapiToken
path Parameters
packageId
required
string <uuid>

UUID for a Package

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string <uuid>
class
required
string
Enum: "org.olf.kb.Pkg" "org.olf.kb.TitleInstance" "org.olf.kb.PlatformTitleInstance" "org.olf.kb.PackageContentItem"
Array of objects (CoverageStatement)
Array
id
string <uuid>
startDate
string <date>
endDate
string <date>
summary
string
startVolume
string
startIssue
string
endVolume
string
endIssue
string
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
required
string
description
string
string or Refdata (object)
One of
string
suppressFromDiscovery
boolean
string or Refdata (object)
One of
string
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
string or Refdata (object)
One of
string
Array of objects (AlternateResourceName)
Array
id
required
string <uuid>
name
required
string
Array of objects (IdentifierOccurrence)
Array
object
object (Identifier)
object (Refdata)
any

The full, type-specific representation of this resource (fields vary depending on class)

object org.olf.kb.TitleInstance Recursive
source
required
string
sourceDataCreated
string <date-time>
sourceDataUpdated
string <date-time>
sourceTitleCount
integer
syncContentsFromSource
boolean
reference
required
string
object (Platform)
id
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
Array of objects
object (Organisation)
id
string <uuid>
name
string
orgsUuid
string <uuid>
orgsUuid_object
object
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (PackageDescriptionUrl)
Array
id
required
string <uuid>
url
string <uri>
Array of objects (ContentType)
Array
id
required
string <uuid>
required
string or Refdata (object)
Array of objects (AvailabilityConstraint)
Array
id
required
string <uuid>
required
string or Refdata (object)
resourceCount
integer

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.Pkg",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "source": "string",
  • "sourceDataCreated": "2019-08-24T14:15:22Z",
  • "sourceDataUpdated": "2019-08-24T14:15:22Z",
  • "sourceTitleCount": 0,
  • "syncContentsFromSource": true,
  • "reference": "string",
  • "nominalPlatform": {
    },
  • "vendor": {
    },
  • "lifecycleStatus": "string",
  • "availabilityScope": "string",
  • "packageDescriptionUrls": [],
  • "contentTypes": [
    ],
  • "availabilityConstraints": [
    ],
  • "resourceCount": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.Pkg",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "source": "string",
  • "sourceDataCreated": "2019-08-24T14:15:22Z",
  • "sourceDataUpdated": "2019-08-24T14:15:22Z",
  • "sourceTitleCount": 0,
  • "syncContentsFromSource": true,
  • "reference": "string",
  • "nominalPlatform": {
    },
  • "vendor": {
    },
  • "lifecycleStatus": "string",
  • "availabilityScope": "string",
  • "packageDescriptionUrls": [],
  • "contentTypes": [
    ],
  • "availabilityConstraints": [
    ],
  • "resourceCount": 0
}

Get content items for a specified package

Authorizations:
accessTokenokapiToken
path Parameters
packageId
required
string <uuid>

UUID for a Package

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get content items for a specified package

Authorizations:
accessTokenokapiToken
path Parameters
packageId
required
string <uuid>

UUID for a Package

packageSubset
required
string
Enum: "current" "dropped" "future" "all"
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get ingress metadata for package

Authorizations:
accessTokenokapiToken
path Parameters
packageId
required
string <uuid>

UUID for a Package

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "resource": {
    },
  • "ingressType": "PUSHKB",
  • "ingressId": "string",
  • "ingressUrl": "http://example.com",
  • "contentIngressId": "string",
  • "contentIngressUrl": "http://example.com",
  • "dateCreated": 0,
  • "lastUpdated": 0
}

Import a package from the POSTed JSON which must conform to the mod-agreements-package schema

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
required
Array of objects (ImportPackage) non-empty
Array (non-empty)
source
required
string
reference
required
string
name
required
string
description
string
syncContentsFromSource
boolean
trustedSourceTI
boolean
sourceDataCreated
string <date-time>
sourceDataUpdated
string <date-time>
sourceTitleCount
integer
availabilityScope
string
lifecycleStatus
string
object
Array of objects (ImportIdentifier)
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
required
Array of objects (ImportContentItem) non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "packageId": "471cc1d4-ec27-4504-b7c2-949af95662bc"
}

Get a list of deduplicated list of distinct, non-null source values from all Pkg (Package) records

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Change the synchronisation status of a package

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
syncState
required
string
Enum: "PAUSED" "SYNCHRONIZING"
packageIds
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "syncState": "PAUSED",
  • "packageIds": [
    ]
}

Response samples

Content type
application/json
{
  • "packagesUpdated": 0,
  • "packagesSkipped": 0,
  • "success": true
}

Get a set of package ingress metadata records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified package ingress metadata record

Authorizations:
accessTokenokapiToken
path Parameters
metadataId
required
string <uuid>

UUID for a PackageIngressMetadata record

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "resource": {
    },
  • "ingressType": "PUSHKB",
  • "ingressId": "string",
  • "ingressUrl": "http://example.com",
  • "contentIngressId": "string",
  • "contentIngressUrl": "http://example.com",
  • "dateCreated": 0,
  • "lastUpdated": 0
}

PCIs

Get a set of package content item records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified package content item record

Authorizations:
accessTokenokapiToken
path Parameters
pciId
required
string <uuid>

UUID for a PackageContentItem

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.PackageContentItem",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "accessStart": "2019-08-24",
  • "accessEnd": "2019-08-24",
  • "addedTimestamp": 0,
  • "depth": "string",
  • "lastSeenTimestamp": 0,
  • "longName": "string",
  • "note": "string",
  • "removedTimestamp": 0,
  • "embargo": {
    },
  • "pkg": {
    },
  • "pti": {
    }
}

Update a package content item record

Authorizations:
accessTokenokapiToken
path Parameters
pciId
required
string <uuid>

UUID for a PackageContentItem

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string <uuid>
class
required
string
Enum: "org.olf.kb.PackageContentItem" "org.olf.kb.TitleInstance" "org.olf.kb.PlatformTitleInstance" "org.olf.kb.Pkg"
Array of objects (CoverageStatement)
Array
id
string <uuid>
startDate
string <date>
endDate
string <date>
summary
string
startVolume
string
startIssue
string
endVolume
string
endIssue
string
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
string
description
string
string or Refdata (object)
One of
string
suppressFromDiscovery
boolean
string or Refdata (object)
One of
string
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
string or Refdata (object)
One of
string
Array of objects (AlternateResourceName)
Array
id
required
string <uuid>
name
required
string
Array of objects (IdentifierOccurrence)
Array
object
object (Identifier)
object (Refdata)
any

The full, type-specific representation of this resource (fields vary depending on class)

object org.olf.kb.TitleInstance Recursive
accessStart
string <date>
accessEnd
string <date>
addedTimestamp
integer
depth
string
lastSeenTimestamp
integer
longName
string
note
string
removedTimestamp
integer
object (Embargo)
id
string <uuid>
object (EmbargoStatement)
object (EmbargoStatement)
object (Package)
id
string <uuid>
class
required
string
Enum: "org.olf.kb.Pkg" "org.olf.kb.TitleInstance" "org.olf.kb.PlatformTitleInstance" "org.olf.kb.PackageContentItem"
Array of objects (CoverageStatement)
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
required
string
description
string
string or Refdata (object)
suppressFromDiscovery
boolean
string or Refdata (object)
Array of objects (Tag)
string or Refdata (object)
Array of objects (AlternateResourceName)
Array of objects (IdentifierOccurrence)
any

The full, type-specific representation of this resource (fields vary depending on class)

source
required
string
sourceDataCreated
string <date-time>
sourceDataUpdated
string <date-time>
sourceTitleCount
integer
syncContentsFromSource
boolean
reference
required
string
object (Platform)
object (Organisation)
string or Refdata (object)
string or Refdata (object)
Array of objects (PackageDescriptionUrl)
Array of objects (ContentType)
Array of objects (AvailabilityConstraint)
resourceCount
integer
object (PlatformTitleInstance)
id
string <uuid>
class
required
string
Enum: "org.olf.kb.PlatformTitleInstance" "org.olf.kb.TitleInstance" "org.olf.kb.PackageContentItem" "org.olf.kb.Pkg"
Array of objects (CoverageStatement)
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
string
description
string
string or Refdata (object)
suppressFromDiscovery
boolean
string or Refdata (object)
Array of objects (Tag)
string or Refdata (object)
Array of objects (AlternateResourceName)
Array of objects (IdentifierOccurrence)
any

The full, type-specific representation of this resource (fields vary depending on class)

longName
string
required
object (Platform)
required
object (TitleInstance)
url
string <uri>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.PackageContentItem",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "accessStart": "2019-08-24",
  • "accessEnd": "2019-08-24",
  • "addedTimestamp": 0,
  • "depth": "string",
  • "lastSeenTimestamp": 0,
  • "longName": "string",
  • "note": "string",
  • "removedTimestamp": 0,
  • "embargo": {
    },
  • "pkg": {
    },
  • "pti": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.PackageContentItem",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "accessStart": "2019-08-24",
  • "accessEnd": "2019-08-24",
  • "addedTimestamp": 0,
  • "depth": "string",
  • "lastSeenTimestamp": 0,
  • "longName": "string",
  • "note": "string",
  • "removedTimestamp": 0,
  • "embargo": {
    },
  • "pkg": {
    },
  • "pti": {
    }
}

Platforms

Get a set of platform records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified platform record

Authorizations:
accessTokenokapiToken
path Parameters
platformId
required
string <uuid>

UUID for a Platform

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "locators": [
    ]
}

Update a platform record

Authorizations:
accessTokenokapiToken
path Parameters
platformId
required
string <uuid>

UUID for a Platform

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
Array of objects
Array
domainName
string
id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "locators": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "locators": [
    ]
}

PTIs

Get a set of platform title instance records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified platform title instance record

Authorizations:
accessTokenokapiToken
path Parameters
ptiId
required
string <uuid>

UUID for a PlatformTitleInstance

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.PlatformTitleInstance",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "longName": "string",
  • "platform": {
    },
  • "titleInstance": {
    },
  • "url": "http://example.com"
}

Update a platform title instance record

Authorizations:
accessTokenokapiToken
path Parameters
ptiId
required
string <uuid>

UUID for a PlatformTitleInstance

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string <uuid>
class
required
string
Enum: "org.olf.kb.PlatformTitleInstance" "org.olf.kb.TitleInstance" "org.olf.kb.PackageContentItem" "org.olf.kb.Pkg"
Array of objects (CoverageStatement)
Array
id
string <uuid>
startDate
string <date>
endDate
string <date>
summary
string
startVolume
string
startIssue
string
endVolume
string
endIssue
string
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
string
description
string
string or Refdata (object)
One of
string
suppressFromDiscovery
boolean
string or Refdata (object)
One of
string
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
string or Refdata (object)
One of
string
Array of objects (AlternateResourceName)
Array
id
required
string <uuid>
name
required
string
Array of objects (IdentifierOccurrence)
Array
object
object (Identifier)
object (Refdata)
any

The full, type-specific representation of this resource (fields vary depending on class)

object org.olf.kb.TitleInstance Recursive
longName
string
required
object (Platform)
id
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
Array of objects
required
object (TitleInstance)
id
string <uuid>
class
required
string
Enum: "org.olf.kb.TitleInstance" "org.olf.kb.PlatformTitleInstance" "org.olf.kb.PackageContentItem" "org.olf.kb.Pkg"
Array of objects (CoverageStatement)
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
required
string
description
string
string or Refdata (object)
suppressFromDiscovery
boolean
string or Refdata (object)
Array of objects (Tag)
string or Refdata (object)
Array of objects (AlternateResourceName)
Array of objects
any

The full, type-specific representation of this resource (fields vary depending on class)

dateMonographPublished
string^\d{4}(-((0[0-9])|(1[0-2]))(-(([0-2][0-9])|3[...
firstAuthor
string
firstEditor
string
monographEdition
string
monographVolume
string
object
url
string <uri>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.PlatformTitleInstance",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "longName": "string",
  • "platform": {
    },
  • "titleInstance": {
    },
  • "url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.PlatformTitleInstance",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    },
  • "longName": "string",
  • "platform": {
    },
  • "titleInstance": {
    },
  • "url": "http://example.com"
}

Titles

Get a set of title instance records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified title instance record

Authorizations:
accessTokenokapiToken
path Parameters
titleId
required
string <uuid>

UUID for a TitleInstance

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.TitleInstance",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": { },
  • "dateMonographPublished": "string",
  • "firstAuthor": "string",
  • "firstEditor": "string",
  • "longName": "string",
  • "monographEdition": "string",
  • "monographVolume": "string",
  • "work": {
    },
  • "relatedTitles": [
    ]
}

Update a title instance record

Authorizations:
accessTokenokapiToken
path Parameters
titleId
required
string <uuid>

UUID for a TitleInstance

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string <uuid>
class
required
string
Enum: "org.olf.kb.TitleInstance" "org.olf.kb.PlatformTitleInstance" "org.olf.kb.PackageContentItem" "org.olf.kb.Pkg"
Array of objects (CoverageStatement)
Array
id
string <uuid>
startDate
string <date>
endDate
string <date>
summary
string
startVolume
string
startIssue
string
endVolume
string
endIssue
string
customCoverage
boolean
dateCreated
string <date-time>
lastUpdated
string <date-time>
name
required
string
description
string
string or Refdata (object)
One of
string
suppressFromDiscovery
boolean
string or Refdata (object)
One of
string
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
string or Refdata (object)
One of
string
Array of objects (AlternateResourceName)
Array
id
required
string <uuid>
name
required
string
Array of objects
Array
object
object
object
any

The full, type-specific representation of this resource (fields vary depending on class)

object org.olf.kb.TitleInstance Recursive
dateMonographPublished
string^\d{4}(-((0[0-9])|(1[0-2]))(-(([0-2][0-9])|3[...
firstAuthor
string
firstEditor
string
monographEdition
string
monographVolume
string
object
id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.TitleInstance",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": { },
  • "dateMonographPublished": "string",
  • "firstAuthor": "string",
  • "firstEditor": "string",
  • "monographEdition": "string",
  • "monographVolume": "string",
  • "work": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.TitleInstance",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": { },
  • "dateMonographPublished": "string",
  • "firstAuthor": "string",
  • "firstEditor": "string",
  • "longName": "string",
  • "monographEdition": "string",
  • "monographVolume": "string",
  • "work": {
    },
  • "relatedTitles": [
    ]
}

Get a set of entitled title instance records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a set of electronic title instance records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Resources

Get a set of resource records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified resource record

Authorizations:
accessTokenokapiToken
path Parameters
ermResourceId
required
string <uuid>

UUID for an ERM resource

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.kb.TitleInstance",
  • "coverage": [
    ],
  • "customCoverage": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "normalizedName": "string",
  • "description": "string",
  • "publicationType": "string",
  • "suppressFromDiscovery": true,
  • "subType": "string",
  • "tags": [
    ],
  • "type": "string",
  • "alternateResourceNames": [
    ],
  • "identifiers": [
    ],
  • "_object": {
    }
}

Get a set of electronic resource records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get entitlement options for a specified resource

Authorizations:
accessTokenokapiToken
path Parameters
ermResourceId
required
string <uuid>

UUID for an ERM resource

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get static (pre-resolved) entitlement options for a specified resource

Authorizations:
accessTokenokapiToken
path Parameters
ermResourceId
required
string <uuid>

UUID for an ERM resource

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get entitlements for a specified resource

Authorizations:
accessTokenokapiToken
path Parameters
ermResourceId
required
string <uuid>

UUID for an ERM resource

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get related entitlements for a specified resource

Authorizations:
accessTokenokapiToken
path Parameters
ermResourceId
required
string <uuid>

UUID for an ERM resource

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Mark the resources belonging to a set of packages for deletion

Authorizations:
accessTokenokapiToken
query Parameters
includeIds
boolean
Default: false

Whether to include the ids of affected resources in the response. Defaults to false

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "resourceIds": {
    },
  • "statistics": {
    }
}

Mark package content items for deletion

Authorizations:
accessTokenokapiToken
query Parameters
includeIds
boolean
Default: false

Whether to include the ids of affected resources in the response. Defaults to false

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "resourceIds": {
    },
  • "statistics": {
    }
}

Mark platform title instances for deletion

Authorizations:
accessTokenokapiToken
query Parameters
includeIds
boolean
Default: false

Whether to include the ids of affected resources in the response. Defaults to false

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "resourceIds": {
    },
  • "statistics": {
    }
}

Mark title instances for deletion

Authorizations:
accessTokenokapiToken
query Parameters
includeIds
boolean
Default: false

Whether to include the ids of affected resources in the response. Defaults to false

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "resourceIds": {
    },
  • "statistics": {
    }
}

Delete a set of packages

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ResourceDeletionJob",
  • "name": "string",
  • "dateCreated": 0,
  • "started": "2019-08-24T14:15:22Z",
  • "ended": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "deletionJobType": "PackageDeletionJob",
  • "resourceInputs": "string"
}

Delete package content items

Authorizations:
accessTokenokapiToken
query Parameters
includeIds
boolean
Default: false

Whether to include the ids of affected resources in the response. Defaults to false

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "markedForDeletion": {
    },
  • "deleted": {
    }
}

Delete platform title instances

Authorizations:
accessTokenokapiToken
query Parameters
includeIds
boolean
Default: false

Whether to include the ids of affected resources in the response. Defaults to false

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "markedForDeletion": {
    },
  • "deleted": {
    }
}

Delete title instances

Authorizations:
accessTokenokapiToken
query Parameters
includeIds
boolean
Default: false

Whether to include the ids of affected resources in the response. Defaults to false

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
resources
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "markedForDeletion": {
    },
  • "deleted": {
    }
}

Remote Knowledge Bases

Get a set of remote Knowledge Base records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create a remote Knowledge Base record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
activationEnabled
boolean

If activation is supported, is recording activation in this remote KB enabled. Not currently used

activationSupported
boolean

Does this remote KB support content activation. Not currently used

active
boolean

If harvesting is supported, is harvesting from this remote KB activated

credentials
string

Credentials used to authenticate with the remote KB. Not currently used

cursor
string

Marks progress through a harvest. May be a timestamp, a transaction id, or another service-specific value depending on type

fullPrefix
string
id
string <uuid>
lastCheck
integer
listPrefix
string
name
required
string
principal
string

Identity/username used to authenticate with the remote KB. Not currently used

readonly
boolean

Marks the KB as protected/read-only, Used to prevent deletion the "LOCAL" source representing the local KB.

rectype
integer
Enum: 1 2

The kind of record this KB primarily deals in

supportsHarvesting
boolean

Does this remote KB support harvesting

string or Refdata (object)
One of
string
trustedSourceTI
required
boolean

Marks the KB as a trusted source of title instance metadata

type
string

Name of the Spring bean that implements this KB's adapter

uri
string <uri>

Responses

Request samples

Content type
application/json
{
  • "activationEnabled": true,
  • "activationSupported": true,
  • "active": true,
  • "credentials": "string",
  • "cursor": "string",
  • "fullPrefix": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastCheck": 0,
  • "listPrefix": "string",
  • "name": "string",
  • "principal": "string",
  • "readonly": true,
  • "rectype": 1,
  • "supportsHarvesting": true,
  • "syncStatus": "string",
  • "trustedSourceTI": true,
  • "type": "string",
  • "uri": "http://example.com"
}

Response samples

Content type
application/json
{
  • "activationEnabled": true,
  • "activationSupported": true,
  • "active": true,
  • "credentials": "string",
  • "cursor": "string",
  • "fullPrefix": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastCheck": 0,
  • "listPrefix": "string",
  • "name": "string",
  • "principal": "string",
  • "readonly": true,
  • "rectype": 1,
  • "supportsHarvesting": true,
  • "syncStatus": "string",
  • "trustedSourceTI": true,
  • "type": "string",
  • "uri": "http://example.com"
}

Get a specified remote Knowledge Base record

Authorizations:
accessTokenokapiToken
path Parameters
kbId
required
string <uuid>

UUID for a remote Knowledge Base

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "activationEnabled": true,
  • "activationSupported": true,
  • "active": true,
  • "credentials": "string",
  • "cursor": "string",
  • "fullPrefix": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastCheck": 0,
  • "listPrefix": "string",
  • "name": "string",
  • "principal": "string",
  • "readonly": true,
  • "rectype": 1,
  • "supportsHarvesting": true,
  • "syncStatus": "string",
  • "trustedSourceTI": true,
  • "type": "string",
  • "uri": "http://example.com"
}

Update a remote Knowledge Base record

Some fields cannot be changed once a KB is marked readonly (e.g. the local KB) — trustedSourceTI remains editable, but other property changes are rejected.

Authorizations:
accessTokenokapiToken
path Parameters
kbId
required
string <uuid>

UUID for a remote Knowledge Base

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
activationEnabled
boolean

If activation is supported, is recording activation in this remote KB enabled. Not currently used

activationSupported
boolean

Does this remote KB support content activation. Not currently used

active
boolean

If harvesting is supported, is harvesting from this remote KB activated

credentials
string

Credentials used to authenticate with the remote KB. Not currently used

cursor
string

Marks progress through a harvest. May be a timestamp, a transaction id, or another service-specific value depending on type

fullPrefix
string
id
string <uuid>
lastCheck
integer
listPrefix
string
name
required
string
principal
string

Identity/username used to authenticate with the remote KB. Not currently used

readonly
boolean

Marks the KB as protected/read-only, Used to prevent deletion the "LOCAL" source representing the local KB.

rectype
integer
Enum: 1 2

The kind of record this KB primarily deals in

supportsHarvesting
boolean

Does this remote KB support harvesting

string or Refdata (object)
One of
string
trustedSourceTI
required
boolean

Marks the KB as a trusted source of title instance metadata

type
string

Name of the Spring bean that implements this KB's adapter

uri
string <uri>

Responses

Request samples

Content type
application/json
{
  • "activationEnabled": true,
  • "activationSupported": true,
  • "active": true,
  • "credentials": "string",
  • "cursor": "string",
  • "fullPrefix": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastCheck": 0,
  • "listPrefix": "string",
  • "name": "string",
  • "principal": "string",
  • "readonly": true,
  • "rectype": 1,
  • "supportsHarvesting": true,
  • "syncStatus": "string",
  • "trustedSourceTI": true,
  • "type": "string",
  • "uri": "http://example.com"
}

Response samples

Content type
application/json
{
  • "activationEnabled": true,
  • "activationSupported": true,
  • "active": true,
  • "credentials": "string",
  • "cursor": "string",
  • "fullPrefix": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastCheck": 0,
  • "listPrefix": "string",
  • "name": "string",
  • "principal": "string",
  • "readonly": true,
  • "rectype": 1,
  • "supportsHarvesting": true,
  • "syncStatus": "string",
  • "trustedSourceTI": true,
  • "type": "string",
  • "uri": "http://example.com"
}

Delete a specified remote Knowledge Base record

Rejected if the KB is marked readonly, e.g. the local KB.

Authorizations:
accessTokenokapiToken
path Parameters
kbId
required
string <uuid>

UUID for a remote Knowledge Base

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Organisations

Get a set of Org records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified Org record

Authorizations:
accessTokenokapiToken
path Parameters
orgId
required
string <uuid>

UUID for an Org

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "orgsUuid": "ad460e86-3e95-4a96-8e2c-3e5b6da78e05",
  • "orgsUuid_object": { }
}

Internal Contacts

Get a set of Internal Contact records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified Internal Contact record

Authorizations:
accessTokenokapiToken
path Parameters
contactId
required
string <uuid>

UUID for an Internal Contact

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "owner": {
    },
  • "role": "string",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

Reference data

Get a set of reference data category records.

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create reference data category record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
desc
string
id
string
internal
boolean
Array of objects (Refdata)
Array
id
string
label
string
value
string

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "id": "string",
  • "internal": true,
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "desc": "string",
  • "id": "string",
  • "internal": true,
  • "values": [
    ]
}

Get a specified reference data category record

Authorizations:
accessTokenokapiToken
path Parameters
refdataId
required
string <uuid>

UUID for a reference data category

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "desc": "string",
  • "id": "string",
  • "internal": true,
  • "values": [
    ]
}

Update reference data category record

Authorizations:
accessTokenokapiToken
path Parameters
refdataId
required
string <uuid>

UUID for a reference data category

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
desc
string
id
string
internal
boolean
Array of objects (Refdata)
Array
id
string
label
string
value
string

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "id": "string",
  • "internal": true,
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "desc": "string",
  • "id": "string",
  • "internal": true,
  • "values": [
    ]
}

Delete a specified reference data category record. Categories marked internal cannot be deleted and will return a 405.

Authorizations:
accessTokenokapiToken
path Parameters
refdataId
required
string <uuid>

UUID for a reference data category

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Get the reference data values for a domain class property.

Authorizations:
accessTokenokapiToken
path Parameters
domain
required
string

Simple (case-insensitive) name of the domain class that owns the property, e.g. SubscriptionAgreement, Pkg

property
required
string

Name of the refdata-backed property on the domain class, e.g. agreementStatus (on SubscriptionAgreement)

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Custom Property Definitions

Get a set of custom property definition records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create custom property definition record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string
name
string
label
string
description
string
primary
boolean
defaultInternal
boolean
retired
boolean
weight
integer
type
string

Java class name indicating the property type (e.g. CustomPropertyInteger, CustomPropertyText, CustomPropertyRefdata)

object (RefdataCategory)
desc
string
id
string
internal
boolean
Array of objects (Refdata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "primary": true,
  • "defaultInternal": true,
  • "retired": true,
  • "weight": 0,
  • "type": "string",
  • "category": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "primary": true,
  • "defaultInternal": true,
  • "retired": true,
  • "weight": 0,
  • "type": "string",
  • "category": {
    }
}

Get a specified custom property definition record

Authorizations:
accessTokenokapiToken
path Parameters
custpropId
required
string <uuid>

UUID for a custom property definition

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "primary": true,
  • "defaultInternal": true,
  • "retired": true,
  • "weight": 0,
  • "type": "string",
  • "category": {
    }
}

Update custom property definition record

Authorizations:
accessTokenokapiToken
path Parameters
custpropId
required
string <uuid>

UUID for a custom property definition

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
id
string
name
string
label
string
description
string
primary
boolean
defaultInternal
boolean
retired
boolean
weight
integer
type
string

Java class name indicating the property type (e.g. CustomPropertyInteger, CustomPropertyText, CustomPropertyRefdata)

object (RefdataCategory)
desc
string
id
string
internal
boolean
Array of objects (Refdata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "primary": true,
  • "defaultInternal": true,
  • "retired": true,
  • "weight": 0,
  • "type": "string",
  • "category": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "primary": true,
  • "defaultInternal": true,
  • "retired": true,
  • "weight": 0,
  • "type": "string",
  • "category": {
    }
}

Delete a specified custom property definition record

Authorizations:
accessTokenokapiToken
path Parameters
custpropId
required
string <uuid>

UUID for a custom property definition

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Get the distinct set of contexts in use across custom property definitions

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Jobs

Get a set of persistent job records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified persistent job record

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ComparisonJob",
  • "name": "string",
  • "runnerId": "string",
  • "dateCreated": 0,
  • "started": 0,
  • "ended": 0,
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "comparisonPoints": [
    ]
}

Delete a specified persistent job record. Jobs currently in progress cannot be deleted and will return a 405

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Get a set of persistent job records of the specified type

Authorizations:
accessTokenokapiToken
path Parameters
jobType
required
string
Enum: "comparison" "coverageRegeneration" "packageImport" "kbartImport" "packageIngest" "supplementaryDocumentsCleaning" "externalEntitlementSync" "packageTriggerResync" "titleIngest" "resourceDeletion" "eHoldingsEntitlementSync" "identifierReassignment"

Unlike job creation, listing by type is not restricted to the types postable via /erm/jobs/{jobType} -- any PersistentJob subtype can be filtered on here, including types only ever created internally

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create and queue a comparison job

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string
required
Array of objects (ComparisonPoint) >= 2 items
Array (>= 2 items)
titleList
string <uuid>
date
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comparisonPoints": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ComparisonJob",
  • "name": "string",
  • "runnerId": "string",
  • "dateCreated": 0,
  • "started": "2019-08-24T14:15:22Z",
  • "ended": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "comparisonPoints": [
    ]
}

Create and queue a coverage regeneration job

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ComparisonJob",
  • "name": "string",
  • "runnerId": "string",
  • "dateCreated": 0,
  • "started": 0,
  • "ended": 0,
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "comparisonPoints": [
    ]
}

Create and queue a package import job

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
string

Derived from the uploaded file's name if omitted

object

Reference to a file already uploaded via /erm/files

id
string <uuid>
payload
object

Raw JSON payload. If provided without fileUpload, it is automatically wrapped into a file server-side

fileTitle
string

Optional file name to use when payload is supplied instead of fileUpload

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fileUpload": {
    },
  • "payload": { },
  • "fileTitle": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ComparisonJob",
  • "name": "string",
  • "runnerId": "string",
  • "dateCreated": 0,
  • "started": 0,
  • "ended": 0,
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "comparisonPoints": [
    ]
}

Create and queue a KBART package import job

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
string

Derived from the uploaded file's name if omitted

object

Reference to a file already uploaded via /erm/files

id
string <uuid>
payload
object

Raw JSON payload. If provided without fileUpload, it is automatically wrapped into a file server-side

fileTitle
string

Optional file name to use when payload is supplied instead of fileUpload

packageName
required
string
packageSource
required
string
packageReference
required
string
packageProvider
string
trustedSourceTI
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fileUpload": {
    },
  • "payload": { },
  • "fileTitle": "string",
  • "packageName": "string",
  • "packageSource": "string",
  • "packageReference": "string",
  • "packageProvider": "string",
  • "trustedSourceTI": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ComparisonJob",
  • "name": "string",
  • "runnerId": "string",
  • "dateCreated": 0,
  • "started": 0,
  • "ended": 0,
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "comparisonPoints": [
    ]
}

Create and queue a package ingest job

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ComparisonJob",
  • "name": "string",
  • "runnerId": "string",
  • "dateCreated": 0,
  • "started": 0,
  • "ended": 0,
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "comparisonPoints": [
    ]
}

Create and queue a supplementary documents cleaning job

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "org.olf.general.jobs.ComparisonJob",
  • "name": "string",
  • "runnerId": "string",
  • "dateCreated": 0,
  • "started": 0,
  • "ended": 0,
  • "status": "string",
  • "result": "string",
  • "fileUpload": {
    },
  • "fullLogCount": 0,
  • "errorLogCount": 0,
  • "infoLogCount": 0,
  • "comparisonPoints": [
    ]
}

Get the full (info and error) log for a specified job

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Stream the full (info and error) log for a specified job

Streams results in batches rather than paginating, so the response is a plain array with no pagination metadata

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

query Parameters
term
string
filters
string
match
string
sort
string
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the error-level log entries for a specified job

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Stream the error-level log entries for a specified job

Streams results in batches rather than paginating, so the response is a plain array with no pagination metadata

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

query Parameters
term
string
filters
string
match
string
sort
string
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the info-level log entries for a specified job

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Stream the info-level log entries for a specified job

Streams results in batches rather than paginating, so the response is a plain array with no pagination metadata

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

query Parameters
term
string
filters
string
match
string
sort
string
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download the file object attached to a specified job

Only meaningful for comparison jobs -- the underlying implementation looks up the record as a ComparisonJob regardless of the job's actual type, so ids for other job types will return a 404. Only available once the job has ended; returns a 405 otherwise

Authorizations:
accessTokenokapiToken
path Parameters
jobId
required
string <uuid>

UUID for a persistent job

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
text/json
"string"

Files

Get a set of File records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Upload a file

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: multipart/form-data
required
upload
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contentType": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "size": 0
}

Get a specified File record

Authorizations:
accessTokenokapiToken
path Parameters
fileId
required
string <uuid>

UUID for a file

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contentType": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "size": 0
}

Delete a specified File record

Authorizations:
accessTokenokapiToken
path Parameters
fileId
required
string <uuid>

UUID for a file

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Download the raw contents of a specified File record

Streams the stored file bytes back with the content type recorded against the File record (rather than a fixed content type).

Authorizations:
accessTokenokapiToken
path Parameters
fileId
required
string <uuid>

UUID for a file

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Identifiers

Get a set of Identifier records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
minOccurrenceCount
integer

Only return identifiers with at least this many occurrences.

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Get a specified Identifier record

Authorizations:
accessTokenokapiToken
path Parameters
identifierId
required
string <uuid>

UUID for an Identifier

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "ns": {
    },
  • "value": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "occurrences": [
    ]
}

Get a set of Identifier Namespace records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Validation

Validate a full record against the SubscriptionAgreement domain

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
description
string
required
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (AlternateName)
Array
name
required
string
localReference
string
vendorReference
string
Array of objects (AgreementContentType)
Array
object (Refdata)
required
Array of objects
Array
startDate
required
string <date>
endDate
string <date>
cancellationDeadline
string <date>
periodStatus
string
note
string
id
string <uuid>
Array of objects (InternalContact)
Array
id
string <uuid>
object
string or Refdata (object)
user
string <uuid>
Array of objects (AgreementOrg)

Organisations associated with the agreement

Array
object (Organisation)
primaryOrg
boolean
Default: false

Whether this is the primary organisation for the agreement

note
string

A note about this organisation's relationship to the agreement

Array of objects

The roles this organisation plays in relation to the agreement

Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (DocumentAttachment)
Array
id
required
string <uuid>
name
required
string
dateCreated
string <date-time>
lastUpdated
string <date-time>
location
string
url
string <uri>
note
string
string or Refdata (object)
object (File)
Array of objects (LinkedLicense)
Array
Array of objects (LinkedAmendment)
id
string
owner
string <uuid>
remoteId
string <uuid>
remoteId_object
object
string or Refdata (object)
Array of objects (UsageDataProvider)
Array
id
string
object
remoteId
string <uuid>
remoteId_object
object
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (AgreementRelationship)
Array
id
string <uuid>
string or Refdata (object)
object (AgreementRelationshipAgreement)
object (AgreementRelationshipAgreement)
Array of objects (Tag)
Array
id
integer
normValue
string
value
string
object

Custom properties (agreement supplementary properties) — keys are property names, values are arrays of property value instances

additional property
Array of objects (CustomPropertyValue)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "agreementStatus": "string",
  • "isPerpetual": "string",
  • "reasonForClosure": "string",
  • "renewalPriority": "string",
  • "alternateNames": [
    ],
  • "localReference": "string",
  • "vendorReference": "string",
  • "agreementContentTypes": [
    ],
  • "periods": [
    ],
  • "contacts": [
    ],
  • "orgs": [
    ],
  • "externalLicenseDocs": [
    ],
  • "supplementaryDocs": [
    ],
  • "linkedLicenses": [
    ],
  • "usageDataProviders": [
    ],
  • "inwardRelationships": [
    ],
  • "outwardRelationships": [
    ],
  • "tags": [
    ],
  • "customProperties": {
    }
}

Response samples

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

Validate a single property on a SubscriptionAgreement record

Authorizations:
accessTokenokapiToken
path Parameters
prop
required
string

Name of the single property to validate, e.g. name on subscriptionAgreement. Only this property is checked -- other constraints on the domain class (e.g. other required fields not present in the request body) are not evaluated.

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
object

Should contain at least the property named in the prop path parameter, keyed by its field name, e.g. { "name": "..." }.

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Validate a full record against the RemoteKB domain

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
activationEnabled
boolean

If activation is supported, is recording activation in this remote KB enabled. Not currently used

activationSupported
boolean

Does this remote KB support content activation. Not currently used

active
boolean

If harvesting is supported, is harvesting from this remote KB activated

credentials
string

Credentials used to authenticate with the remote KB. Not currently used

cursor
string

Marks progress through a harvest. May be a timestamp, a transaction id, or another service-specific value depending on type

fullPrefix
string
id
string <uuid>
lastCheck
integer
listPrefix
string
name
required
string
principal
string

Identity/username used to authenticate with the remote KB. Not currently used

readonly
boolean

Marks the KB as protected/read-only, Used to prevent deletion the "LOCAL" source representing the local KB.

rectype
integer
Enum: 1 2

The kind of record this KB primarily deals in

supportsHarvesting
boolean

Does this remote KB support harvesting

string or Refdata (object)
One of
string
trustedSourceTI
required
boolean

Marks the KB as a trusted source of title instance metadata

type
string

Name of the Spring bean that implements this KB's adapter

uri
string <uri>

Responses

Request samples

Content type
application/json
{
  • "activationEnabled": true,
  • "activationSupported": true,
  • "active": true,
  • "credentials": "string",
  • "cursor": "string",
  • "fullPrefix": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastCheck": 0,
  • "listPrefix": "string",
  • "name": "string",
  • "principal": "string",
  • "readonly": true,
  • "rectype": 1,
  • "supportsHarvesting": true,
  • "syncStatus": "string",
  • "trustedSourceTI": true,
  • "type": "string",
  • "uri": "http://example.com"
}

Response samples

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

Validate a single property on a RemoteKB record

Authorizations:
accessTokenokapiToken
path Parameters
prop
required
string

Name of the single property to validate, e.g. name on subscriptionAgreement. Only this property is checked -- other constraints on the domain class (e.g. other required fields not present in the request body) are not evaluated.

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
object

Should contain at least the property named in the prop path parameter, keyed by its field name.

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Settings

Get a set of application setting records

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create application setting record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
section
string
key
required
string
settingType
string
vocab
string
defValue
string
value
string
hidden
boolean

If true, this setting is excluded from filter/search results but is otherwise still retrievable and modifiable normally.

Responses

Request samples

Content type
application/json
{
  • "section": "string",
  • "key": "string",
  • "settingType": "string",
  • "vocab": "string",
  • "defValue": "string",
  • "value": "string",
  • "hidden": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "section": "string",
  • "key": "string",
  • "settingType": "string",
  • "vocab": "string",
  • "defValue": "string",
  • "value": "string",
  • "hidden": true
}

Get a specified application setting record

Authorizations:
accessTokenokapiToken
path Parameters
settingId
required
string

Identifier for an application setting

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "section": "string",
  • "key": "string",
  • "settingType": "string",
  • "vocab": "string",
  • "defValue": "string",
  • "value": "string",
  • "hidden": true
}

Update application setting record

Authorizations:
accessTokenokapiToken
path Parameters
settingId
required
string

Identifier for an application setting

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
section
string
key
required
string
settingType
string
vocab
string
defValue
string
value
string
hidden
boolean

If true, this setting is excluded from filter/search results but is otherwise still retrievable and modifiable normally.

Responses

Request samples

Content type
application/json
{
  • "section": "string",
  • "key": "string",
  • "settingType": "string",
  • "vocab": "string",
  • "defValue": "string",
  • "value": "string",
  • "hidden": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "section": "string",
  • "key": "string",
  • "settingType": "string",
  • "vocab": "string",
  • "defValue": "string",
  • "value": "string",
  • "hidden": true
}

Delete a specified application setting record

Authorizations:
accessTokenokapiToken
path Parameters
settingId
required
string

Identifier for an application setting

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Admin

Upload and upsert a package file

Developer helper for uploading a package JSON file directly (e.g. via curl) rather than through the normal harvest pipeline. If no package_file part is present, or it fails to bind, the response body is empty

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: multipart/form-data
package_file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "startTime": 0,
  • "updateTime": 0,
  • "packageId": "471cc1d4-ec27-4504-b7c2-949af95662bc",
  • "titleCount": 0,
  • "newTitles": 0,
  • "removedTitles": 0,
  • "updatedTitles": 0,
  • "updatedAccessStart": 0,
  • "updatedAccessEnd": 0
}

Trigger an update of the remote KB package cache

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "error": 0,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "message": "string",
  • "exception": "string",
  • "stackTrace": [
    ]
}

Trigger a remote KB harvest sync

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Trigger an activation update of the remote KB package cache

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{ }

Trigger ERM housekeeping

Also run automatically every 24 hours via Okapi's timer interface

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Trigger an update of the entitlement log

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Trigger migration of uploaded documents to object storage

Migrates uploaded file attachments still stored in the Postgres database (LOB) to the configured S3/MinIO object store

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Trigger an eHoldings entitlement sync

Also run automatically every hour via Okapi's timer interface, which never sets force, always honouring the entitlement sync buffer window

Authorizations:
accessTokenokapiToken
query Parameters
force
boolean
Default: false

Bypass the entitlement sync buffer window

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Statistics

Get record counts for knowledge base resource types

Counts every row in each of the listed tables -- not scoped to any particular agreement or package.

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "ErmResource": 0,
  • "Pkg": 0,
  • "PackageContentItem": 0,
  • "PlatformTitleInstance": 0,
  • "TitleInstance": 0,
  • "Work": 0
}

Get record counts for agreements and their entitlements

Counts every row in each of the listed tables -- not scoped to any particular agreement.

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "SubscriptionAgreement": 0,
  • "Entitlement": 0
}

String Templates

Get a set of string templates

Authorizations:
accessTokenokapiToken
query Parameters
filters
string
match
string
term
string
sort
string
stats
boolean
perPage
integer
offset
integer
page
integer
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Create a string template

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string
rule
required
string

A Handlebars template rendered against a binding of inputUrl and platformLocalCode to produce a customised or proxied URL.

string or Refdata (object)

Whether this template customises the platform's URL (urlCustomiser) or proxies it (urlProxier). Defaults to urlProxier if not supplied.

One of
string

Whether this template customises the platform's URL (urlCustomiser) or proxies it (urlProxier). Defaults to urlProxier if not supplied.

idScopes
Array of strings <uuid> [ items <uuid > ]

Scopes the template to (or, for urlProxier context, excludes it from) a set of resource ids -- in practice, Platform ids.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rule": "string",
  • "context": "string",
  • "idScopes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "rule": "string",
  • "context": "string",
  • "idScopes": [
    ]
}

Get a specified string template

Authorizations:
accessTokenokapiToken
path Parameters
stringTemplateId
required
string <uuid>

UUID for a string template

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "rule": "string",
  • "context": "string",
  • "idScopes": [
    ]
}

Update a string template

Authorizations:
accessTokenokapiToken
path Parameters
stringTemplateId
required
string <uuid>

UUID for a string template

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
name
required
string
rule
required
string

A Handlebars template rendered against a binding of inputUrl and platformLocalCode to produce a customised or proxied URL.

string or Refdata (object)

Whether this template customises the platform's URL (urlCustomiser) or proxies it (urlProxier). Defaults to urlProxier if not supplied.

One of
string

Whether this template customises the platform's URL (urlCustomiser) or proxies it (urlProxier). Defaults to urlProxier if not supplied.

idScopes
Array of strings <uuid> [ items <uuid > ]

Scopes the template to (or, for urlProxier context, excludes it from) a set of resource ids -- in practice, Platform ids.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rule": "string",
  • "context": "string",
  • "idScopes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "rule": "string",
  • "context": "string",
  • "idScopes": [
    ]
}

Delete a specified string template

Authorizations:
accessTokenokapiToken
path Parameters
stringTemplateId
required
string <uuid>

UUID for a string template

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": 0
}

Refresh templated URLs

Intended to trigger a background refresh of templated URLs for every Platform, re-running all applicable string templates. Currently a no-op: the refresh logic is disabled in the module, and this always returns an empty object.

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{ }

Get the string templates applicable to a Platform

Resolves which string templates (both urlProxier and urlCustomiser context) apply to the given Platform id, based on each template's idScopes allowlist/denylist.

Authorizations:
accessTokenokapiToken
path Parameters
platformId
required
string <uuid>

UUID for a Platform

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "urlProxiers": [
    ],
  • "urlCustomisers": [
    ]
}

Export

Export all entitled resources as JSON

Authorizations:
accessTokenokapiToken
query Parameters
subscriptionAgreementId
string <uuid>

Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export all entitled resources in a specified format

format: kbart returns a tab-separated KBART file (one row per Package Content Item; Platform Title Instances and directly-entitled Title Instances are silently skipped). Any other format value returns the same JSON shape as the plain /export path.

Authorizations:
accessTokenokapiToken
path Parameters
format
required
string
Enum: "json" "kbart"
query Parameters
subscriptionAgreementId
string <uuid>

Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Export currently entitled resources as JSON

Authorizations:
accessTokenokapiToken
query Parameters
subscriptionAgreementId
string <uuid>

Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export currently entitled resources in a specified format

format: kbart returns a tab-separated KBART file (one row per Package Content Item; Platform Title Instances and directly-entitled Title Instances are silently skipped). Any other format value returns the same JSON shape as the plain /export/current path.

Authorizations:
accessTokenokapiToken
path Parameters
format
required
string
Enum: "json" "kbart"
query Parameters
subscriptionAgreementId
string <uuid>

Undocumented in the module descriptor, but honoured by the implementation -- if supplied, scopes the export to this one agreement, equivalent to using the agreement-scoped export path.

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
[
  • {
    }
]

Dashboard

List dashboard widget definitions

Returns the dashboard widget definitions bundled with this module, describing the self-service search/list widgets (e.g. simple agreement search) that can be added to a FOLIO dashboard. Definitions are cached in memory after the first request, for the lifetime of the running instance. No specific permission is required beyond a valid tenant/token.

This path is provided under the dashboard interface, declared as interfaceType: multiple in the module descriptor, because other dashboard-capable modules (e.g. mod-licenses) expose the same path for their own widget definitions. Since more than one module enabled for a tenant can answer this exact path, a plain request is ambiguous — Okapi needs an X-Okapi-Module-Id header naming which one to route to. Discover the candidate module ids first with GET /_/proxy/tenants/{tenant}/modules?provide=dashboard, then pass one of them back on this request.

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
X-Okapi-Module-Id
required
string
Example: mod-agreements-7.4.0-SNAPSHOT

ID of the specific module to route this request to. Required on paths backed by an interfaceType: multiple interface

Responses

Response samples

Content type
application/json
[
  • {
    }
]