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 <uuid>
owner
string <uuid>
remoteId
string <uuid>
remoteId_object
object
string or Refdata (object)
Array of objects (UsageDataProvider)
Array
id
string <uuid>
owner
object (Agreement) Recursive
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",
  • "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",
  • "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 <uuid>
owner
string <uuid>
remoteId
string <uuid>
remoteId_object
object
string or Refdata (object)
Array of objects (UsageDataProvider)
Array
id
string <uuid>
owner
object (Agreement) Recursive
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",
  • "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

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
application/json
Example
{
  • "meta": { },
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "totalPages": 0,
  • "totalRecords": 0,
  • "results": [
    ]
}

Retuns 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",
  • "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 <uuid>
owner
string <uuid>
remoteId
string <uuid>
remoteId_object
object
string or Refdata (object)
Array of objects (UsageDataProvider)
Array
id
string <uuid>
owner
object (Agreement) Recursive
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",
  • "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 <date>
activeTo
string <date>
authority
string
Enum: "GOKB-RESOURCE" "EKB-PACKAGE" "EKB-TITLE"
contentUpdated
string <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
string
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)
accessStart
string <date>
accessEnd
string <date>
addedTimestamp
integer
depth
string
lastSeenTimestamp
integer
longName
string
note
string
removedTimestamp
integer
object (Embargo)
object (Package)
object (PlatformTitleInstance)
any
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 <date>
activeTo
string <date>
authority
string
Enum: "GOKB-RESOURCE" "EKB-PACKAGE" "EKB-TITLE"
contentUpdated
string <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
string
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)
accessStart
string <date>
accessEnd
string <date>
addedTimestamp
integer
depth
string
lastSeenTimestamp
integer
longName
string
note
string
removedTimestamp
integer
object (Embargo)
object (Package)
object (PlatformTitleInstance)
any
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": "string",
  • "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": [
    ],
  • "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
string
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)
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>
lastUpdated
string <date>
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": "string",
  • "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": [
    ],
  • "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": "string",
  • "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": [
    ],
  • "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": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

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"
}

Synchronously import a package from a KBART TSV file

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: multipart/form-data
required
packageName
required
string
packageSource
required
string
packageReference
required
string
packageProvider
string
trustedSourceTI
boolean
upload
required
string <binary>

Responses

Response samples

Content type
application/json
{ }

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": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

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": "string",
  • "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": [
    ],
  • "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
string
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)
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
string
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)
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
string
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)
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": "string",
  • "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": [
    ],
  • "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": "string",
  • "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": [
    ],
  • "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-24",
  • "lastUpdated": "2019-08-24",
  • "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>
lastUpdated
string <date>
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-24",
  • "lastUpdated": "2019-08-24",
  • "locators": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dateCreated": "2019-08-24",
  • "lastUpdated": "2019-08-24",
  • "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": "string",
  • "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": [
    ],
  • "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
string
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)
longName
string
required
object (Platform)
id
string <uuid>
name
required
string
dateCreated
string <date>
lastUpdated
string <date>
Array of objects
required
object (TitleInstance)
id
string <uuid>
class
string
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
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": "string",
  • "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": [
    ],
  • "longName": "string",
  • "platform": {
    },
  • "titleInstance": {
    },
  • "url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "string",
  • "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": [
    ],
  • "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": "string",
  • "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": [
    ],
  • "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
string
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
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": "string",
  • "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": [
    ],
  • "dateMonographPublished": "string",
  • "firstAuthor": "string",
  • "firstEditor": "string",
  • "monographEdition": "string",
  • "monographVolume": "string",
  • "work": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "class": "string",
  • "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": [
    ],
  • "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": [
    ]
}