API docs by Redocly

Folio Open Access Management (3.2.0)

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

API for the Folio library services platform mod-oa app

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 <uuid>
internal
boolean
Array of objects (Refdata)
Array
id
string <uuid>
label
string
value
string

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "desc": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "values": [
    ]
}

Get a specified reference data category record

Authorizations:
accessTokenokapiToken
path Parameters
id
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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "values": [
    ]
}

Update reference data category record

Authorizations:
accessTokenokapiToken
path Parameters
id
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 <uuid>
internal
boolean
Array of objects (Refdata)
Array
id
string <uuid>
label
string
value
string

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "internal": true,
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "desc": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "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
id
required
string <uuid>

UUID for a reference data category

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

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. PublicationRequest

property
required
string

Name of the refdata-backed property on the domain class, e.g. requestStatus

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": [
    ]
}

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
id
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
id
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
id
required
string

Identifier for an application setting

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

Publication requests

Get a set of publication request 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 publication request record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
requestNumber
string
requestDate
string <date>
retrospectiveOA
boolean
Default: false
publicationTitle
string
authorNames
string
object (RequestParty)
required
string or Refdata (object)

The role this party plays on the request, e.g. corresponding author

required
object (Party)
object (RequestParty)
required
string or Refdata (object)

The role this party plays on the request, e.g. corresponding author

required
object (Party)
localReference
string
publicationUrl
string <uri>
doi
string
bookDateOfPublication
string^\d{4}(-((0[0-9])|(1[0-2]))(-(([0-2][0-9])|3[...
bookPlaceOfPublication
string
string or Refdata (object)
One of
string
correspondingInstitutionLevel2
string
withoutAgreement
required
boolean
Default: false
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
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
object (Work)
title
required
string
string or Refdata (object)
string or Refdata (object)
Array of objects (WorkTitleInstance)
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
object (PublicationRequestAgreement)
remoteId
required
string <uuid>
Array of objects (ExternalRequestId)
Array
externalId
string

An identifier for this request in an external system

Array of objects (PublicationRequestHistory)
Array
note
string
string or Refdata (object)
required
string or Refdata (object)
Array of objects (PublicationIdentifier)
Array
string or Refdata (object)
publicationIdentifier
string
Array of objects (PublicationStatus)
Array
string or Refdata (object)
statusDate
string <date>
statusNote
string
Array of objects (Funding)
Array
string or Refdata (object)
string or Refdata (object)
Array of objects (Correspondence)
Array
object
dateOfCorrespondence
required
string <date>
content
required
string
correspondent
required
string
required
string or Refdata (object)
required
string or Refdata (object)
string or Refdata (object)
Array of objects (Charge)
Array
owner
string <uuid>
required
object (MonetaryValue)
object (ExchangeRate)
description
string
paymentPeriod
string^([0-9]{4})?$
string or Refdata (object)
discount
number
Default: 0
string or Refdata (object)
discountNote
string
tax
number
string or Refdata (object)
invoiceReference
string <uuid>
invoiceLineItemReference
string <uuid>
Array of objects (Payer)
Array of objects (ChecklistItem)

Checklist items tracking this request's progress through a workflow

Array
required
object (ChecklistItemDefinition)
string or Refdata (object)
string or Refdata (object)
Array of objects (ChecklistItemNote)

Responses

Request samples

Content type
application/json
{
  • "requestNumber": "string",
  • "requestDate": "2019-08-24",
  • "retrospectiveOA": false,
  • "publicationTitle": "string",
  • "authorNames": "string",
  • "correspondingAuthor": {
    },
  • "requestContact": {
    },
  • "localReference": "string",
  • "publicationUrl": "http://example.com",
  • "doi": "string",
  • "bookDateOfPublication": "string",
  • "bookPlaceOfPublication": "string",
  • "correspondingInstitutionLevel1": "string",
  • "correspondingInstitutionLevel2": "string",
  • "withoutAgreement": false,
  • "requestStatus": "string",
  • "closureReason": "string",
  • "publicationType": "string",
  • "subtype": "string",
  • "publisher": "string",
  • "license": "string",
  • "work": {
    },
  • "workIndexedInDOAJ": "string",
  • "workOAStatus": "string",
  • "agreement": {
    },
  • "externalRequestIds": [
    ],
  • "history": [
    ],
  • "identifiers": [
    ],
  • "publicationStatuses": [
    ],
  • "fundings": [
    ],
  • "correspondences": [
    ],
  • "charges": [
    ],
  • "checklist": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "requestNumber": "string",
  • "requestDate": "2019-08-24",
  • "retrospectiveOA": false,
  • "publicationTitle": "string",
  • "authorNames": "string",
  • "correspondingAuthor": {
    },
  • "requestContact": {
    },
  • "localReference": "string",
  • "publicationUrl": "http://example.com",
  • "doi": "string",
  • "bookDateOfPublication": "string",
  • "bookPlaceOfPublication": "string",
  • "correspondingInstitutionLevel1": "string",
  • "correspondingInstitutionLevel2": "string",
  • "withoutAgreement": false,
  • "requestStatus": "string",
  • "closureReason": "string",
  • "publicationType": "string",
  • "subtype": "string",
  • "publisher": "string",
  • "license": "string",
  • "work": {
    },
  • "workIndexedInDOAJ": "string",
  • "workOAStatus": "string",
  • "agreement": {
    },
  • "externalRequestIds": [
    ],
  • "history": [
    ],
  • "identifiers": [
    ],
  • "publicationStatuses": [
    ],
  • "fundings": [
    ],
  • "correspondences": [
    ],
  • "charges": [
    ],
  • "checklist": [
    ]
}

Get a specified publication request record

Authorizations:
accessTokenokapiToken
path Parameters
publicationRequestId
required
string <uuid>

UUID for a publication request

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "requestNumber": "string",
  • "requestDate": "2019-08-24",
  • "retrospectiveOA": false,
  • "publicationTitle": "string",
  • "authorNames": "string",
  • "correspondingAuthor": {
    },
  • "requestContact": {
    },
  • "localReference": "string",
  • "publicationUrl": "http://example.com",
  • "doi": "string",
  • "bookDateOfPublication": "string",
  • "bookPlaceOfPublication": "string",
  • "correspondingInstitutionLevel1": "string",
  • "correspondingInstitutionLevel2": "string",
  • "withoutAgreement": false,
  • "requestStatus": "string",
  • "closureReason": "string",
  • "publicationType": "string",
  • "subtype": "string",
  • "publisher": "string",
  • "license": "string",
  • "work": {
    },
  • "workIndexedInDOAJ": "string",
  • "workOAStatus": "string",
  • "agreement": {
    },
  • "externalRequestIds": [
    ],
  • "history": [
    ],
  • "identifiers": [
    ],
  • "publicationStatuses": [
    ],
  • "fundings": [
    ],
  • "correspondences": [
    ],
  • "charges": [
    ],
  • "checklist": [
    ]
}

Update publication request record

Authorizations:
accessTokenokapiToken
path Parameters
publicationRequestId
required
string <uuid>

UUID for a publication request

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
requestNumber
string
requestDate
string <date>
retrospectiveOA
boolean
Default: false
publicationTitle
string
authorNames
string
object (RequestParty)
required
string or Refdata (object)

The role this party plays on the request, e.g. corresponding author

required
object (Party)
object (RequestParty)
required
string or Refdata (object)

The role this party plays on the request, e.g. corresponding author

required
object (Party)
localReference
string
publicationUrl
string <uri>
doi
string
bookDateOfPublication
string^\d{4}(-((0[0-9])|(1[0-2]))(-(([0-2][0-9])|3[...
bookPlaceOfPublication
string
string or Refdata (object)
One of
string
correspondingInstitutionLevel2
string
withoutAgreement
required
boolean
Default: false
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
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
object (Work)
title
required
string
string or Refdata (object)
string or Refdata (object)
Array of objects (WorkTitleInstance)
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
object (PublicationRequestAgreement)
remoteId
required
string <uuid>
Array of objects (ExternalRequestId)
Array
externalId
string

An identifier for this request in an external system

Array of objects (PublicationRequestHistory)
Array
note
string
string or Refdata (object)
required
string or Refdata (object)
Array of objects (PublicationIdentifier)
Array
string or Refdata (object)
publicationIdentifier
string
Array of objects (PublicationStatus)
Array
string or Refdata (object)
statusDate
string <date>
statusNote
string
Array of objects (Funding)
Array
string or Refdata (object)
string or Refdata (object)
Array of objects (Correspondence)
Array
object
dateOfCorrespondence
required
string <date>
content
required
string
correspondent
required
string
required
string or Refdata (object)
required
string or Refdata (object)
string or Refdata (object)
Array of objects (Charge)
Array
owner
string <uuid>
required
object (MonetaryValue)
object (ExchangeRate)
description
string
paymentPeriod
string^([0-9]{4})?$
string or Refdata (object)
discount
number
Default: 0
string or Refdata (object)
discountNote
string
tax
number
string or Refdata (object)
invoiceReference
string <uuid>
invoiceLineItemReference
string <uuid>
Array of objects (Payer)
Array of objects (ChecklistItem)

Checklist items tracking this request's progress through a workflow

Array
required
object (ChecklistItemDefinition)
string or Refdata (object)
string or Refdata (object)
Array of objects (ChecklistItemNote)

Responses

Request samples

Content type
application/json
{
  • "requestNumber": "string",
  • "requestDate": "2019-08-24",
  • "retrospectiveOA": false,
  • "publicationTitle": "string",
  • "authorNames": "string",
  • "correspondingAuthor": {
    },
  • "requestContact": {
    },
  • "localReference": "string",
  • "publicationUrl": "http://example.com",
  • "doi": "string",
  • "bookDateOfPublication": "string",
  • "bookPlaceOfPublication": "string",
  • "correspondingInstitutionLevel1": "string",
  • "correspondingInstitutionLevel2": "string",
  • "withoutAgreement": false,
  • "requestStatus": "string",
  • "closureReason": "string",
  • "publicationType": "string",
  • "subtype": "string",
  • "publisher": "string",
  • "license": "string",
  • "work": {
    },
  • "workIndexedInDOAJ": "string",
  • "workOAStatus": "string",
  • "agreement": {
    },
  • "externalRequestIds": [
    ],
  • "history": [
    ],
  • "identifiers": [
    ],
  • "publicationStatuses": [
    ],
  • "fundings": [
    ],
  • "correspondences": [
    ],
  • "charges": [
    ],
  • "checklist": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "requestNumber": "string",
  • "requestDate": "2019-08-24",
  • "retrospectiveOA": false,
  • "publicationTitle": "string",
  • "authorNames": "string",
  • "correspondingAuthor": {
    },
  • "requestContact": {
    },
  • "localReference": "string",
  • "publicationUrl": "http://example.com",
  • "doi": "string",
  • "bookDateOfPublication": "string",
  • "bookPlaceOfPublication": "string",
  • "correspondingInstitutionLevel1": "string",
  • "correspondingInstitutionLevel2": "string",
  • "withoutAgreement": false,
  • "requestStatus": "string",
  • "closureReason": "string",
  • "publicationType": "string",
  • "subtype": "string",
  • "publisher": "string",
  • "license": "string",
  • "work": {
    },
  • "workIndexedInDOAJ": "string",
  • "workOAStatus": "string",
  • "agreement": {
    },
  • "externalRequestIds": [
    ],
  • "history": [
    ],
  • "identifiers": [
    ],
  • "publicationStatuses": [
    ],
  • "fundings": [
    ],
  • "correspondences": [
    ],
  • "charges": [
    ],
  • "checklist": [
    ]
}

Delete a specified publication request record

Authorizations:
accessTokenokapiToken
path Parameters
publicationRequestId
required
string <uuid>

UUID for a publication request

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

Title instances

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": [
    ]
}

Create title instance record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
title
required
string
work
string <uuid>
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (IdentifierOccurrence)
Array
required
object (Identifier)
string or Refdata (object)

Present when reached via /oa/titleInstances; absent via /oa/publicationRequest or /oa/works

selected
boolean

Present when reached via /oa/titleInstances; absent via /oa/publicationRequest or /oa/works

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "work": "01d48ba0-e6ef-4687-bcc4-68d071e7afa9",
  • "publicationType": "string",
  • "type": "string",
  • "subType": "string",
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "publicationType": "string",
  • "type": "string",
  • "subType": "string",
  • "identifiers": [
    ]
}

Get a specified title instance record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a title instance

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "publicationType": "string",
  • "type": "string",
  • "subType": "string",
  • "identifiers": [
    ]
}

Update title instance record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a title instance

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
title
required
string
work
string <uuid>
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (IdentifierOccurrence)
Array
required
object (Identifier)
string or Refdata (object)

Present when reached via /oa/titleInstances; absent via /oa/publicationRequest or /oa/works

selected
boolean

Present when reached via /oa/titleInstances; absent via /oa/publicationRequest or /oa/works

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "work": "01d48ba0-e6ef-4687-bcc4-68d071e7afa9",
  • "publicationType": "string",
  • "type": "string",
  • "subType": "string",
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "publicationType": "string",
  • "type": "string",
  • "subType": "string",
  • "identifiers": [
    ]
}

Delete a specified title instance record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a title instance

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

Works

Get a set of work 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 work record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a work

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "indexedInDOAJ": "string",
  • "oaStatus": "string",
  • "instances": [
    ]
}

Update work record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a work

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
title
required
string
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string
Array of objects (WorkTitleInstance)
Array
title
required
string
Array of objects (IdentifierOccurrence)
object (Refdata)
object (Refdata)
object (Refdata)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "indexedInDOAJ": "string",
  • "oaStatus": "string",
  • "instances": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "indexedInDOAJ": "string",
  • "oaStatus": "string",
  • "instances": [
    ]
}

Import a Work and TitleInstances from citation metadata

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

e.g. serial or monograph. Used as the default type for each instance in instances that does not set its own.

indexedInDOAJ
string

Refdata value for the Global.Yes_No category, e.g. Yes/No. Used as the default for each instance's Work that does not set its own.

oaStatus
string

Refdata value for the Work's oaStatus category, e.g. Gold/Hybrid. Used as the default for each instance's Work that does not set its own.

required
Array of objects (WorkCitationInstance) non-empty
Array (non-empty)
required
Array of objects (WorkCitationIdentifier) non-empty

Identifiers used to match this instance against an existing TitleInstance. A new TitleInstance is created if none match; if more than one matches, the request fails.

title
string

Overrides the citation's top-level title for this instance. If this instance matches an existing TitleInstance, its title must equal the resolved title or the request fails.

type
string

Overrides the citation's top-level type for this instance, e.g. serial or monograph. Also drives the derived publicationType (serial -> Journal, monograph -> Book) when publicationType is not set.

subType
string

Refdata value for the TitleInstance's subType category.

publicationType
string

Refdata value for the TitleInstance's publicationType category. Derived from type when not set.

indexedInDOAJ
string

Overrides the citation's top-level indexedInDOAJ for this instance's Work.

oaStatus
string

Overrides the citation's top-level oaStatus for this instance's Work.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type": "string",
  • "indexedInDOAJ": "string",
  • "oaStatus": "string",
  • "instances": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "indexedInDOAJ": "string",
  • "oaStatus": "string",
  • "instances": [
    ]
}

Parties

Get a set of party 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 party record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
title
string
familyName
string
givenNames
string
orcidId
string
mainEmail
string <email>
phone
string
mobile
string
object (PartyAddress)
required
object (Address)
string or Refdata (object)
One of
string
institutionLevel2
string
Array of objects (AlternateEmailAddress)
Array
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "familyName": "string",
  • "givenNames": "string",
  • "orcidId": "string",
  • "mainEmail": "user@example.com",
  • "phone": "string",
  • "mobile": "string",
  • "streetAddress": {
    },
  • "institutionLevel1": "string",
  • "institutionLevel2": "string",
  • "alternateEmails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "familyName": "string",
  • "givenNames": "string",
  • "fullName": "string",
  • "orcidId": "string",
  • "mainEmail": "user@example.com",
  • "phone": "string",
  • "mobile": "string",
  • "streetAddress": {
    },
  • "institutionLevel1": "string",
  • "institutionLevel2": "string",
  • "alternateEmails": [
    ]
}

Get a specified party record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a party

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "familyName": "string",
  • "givenNames": "string",
  • "fullName": "string",
  • "orcidId": "string",
  • "mainEmail": "user@example.com",
  • "phone": "string",
  • "mobile": "string",
  • "streetAddress": {
    },
  • "institutionLevel1": "string",
  • "institutionLevel2": "string",
  • "alternateEmails": [
    ]
}

Update party record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a party

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
title
string
familyName
string
givenNames
string
orcidId
string
mainEmail
string <email>
phone
string
mobile
string
object (PartyAddress)
required
object (Address)
string or Refdata (object)
One of
string
institutionLevel2
string
Array of objects (AlternateEmailAddress)
Array
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "familyName": "string",
  • "givenNames": "string",
  • "orcidId": "string",
  • "mainEmail": "user@example.com",
  • "phone": "string",
  • "mobile": "string",
  • "streetAddress": {
    },
  • "institutionLevel1": "string",
  • "institutionLevel2": "string",
  • "alternateEmails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "familyName": "string",
  • "givenNames": "string",
  • "fullName": "string",
  • "orcidId": "string",
  • "mainEmail": "user@example.com",
  • "phone": "string",
  • "mobile": "string",
  • "streetAddress": {
    },
  • "institutionLevel1": "string",
  • "institutionLevel2": "string",
  • "alternateEmails": [
    ]
}

Delete a specified party record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a party

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

Correspondence

Get a set of correspondence 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 correspondence record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
object
id
required
string <uuid>
dateOfCorrespondence
required
string <date>
content
required
string
correspondent
required
string
required
string or Refdata (object)
One of
string
required
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string

Responses

Request samples

Content type
application/json
{
  • "owner": {
    },
  • "dateOfCorrespondence": "2019-08-24",
  • "content": "string",
  • "correspondent": "string",
  • "status": "string",
  • "mode": "string",
  • "category": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "owner": {
    },
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "dateOfCorrespondence": "2019-08-24",
  • "content": "string",
  • "correspondent": "string",
  • "status": "string",
  • "mode": "string",
  • "category": "string"
}

Get a specified correspondence record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a correspondence record

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "owner": {
    },
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "dateOfCorrespondence": "2019-08-24",
  • "content": "string",
  • "correspondent": "string",
  • "status": "string",
  • "mode": "string",
  • "category": "string"
}

Update correspondence record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a correspondence record

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
object
id
required
string <uuid>
dateOfCorrespondence
required
string <date>
content
required
string
correspondent
required
string
required
string or Refdata (object)
One of
string
required
string or Refdata (object)
One of
string
string or Refdata (object)
One of
string

Responses

Request samples

Content type
application/json
{
  • "owner": {
    },
  • "dateOfCorrespondence": "2019-08-24",
  • "content": "string",
  • "correspondent": "string",
  • "status": "string",
  • "mode": "string",
  • "category": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "owner": {
    },
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "dateOfCorrespondence": "2019-08-24",
  • "content": "string",
  • "correspondent": "string",
  • "status": "string",
  • "mode": "string",
  • "category": "string"
}

Delete a specified correspondence record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a correspondence record

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

Charges

Get a set of charge 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 charge record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
owner
string <uuid>
required
object (MonetaryValue)
baseCurrency
required
string
value
required
number decimal places <= 2

Monetary amount, fixed to 2 decimal places

object (ExchangeRate)
fromCurrency
required
string
toCurrency
required
string
coefficient
required
number
description
string
paymentPeriod
string^([0-9]{4})?$
string or Refdata (object)
One of
string
discount
number
Default: 0
string or Refdata (object)
One of
string
discountNote
string
tax
number
string or Refdata (object)
One of
string
invoiceReference
string <uuid>
invoiceLineItemReference
string <uuid>
Array of objects (Payer)
Array
required
string or Refdata (object)
payerAmount
required
number
payerNote
string

Responses

Request samples

Content type
application/json
{
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "amount": {
    },
  • "exchangeRate": {
    },
  • "description": "string",
  • "paymentPeriod": "string",
  • "category": "string",
  • "discount": 0,
  • "discountType": "string",
  • "discountNote": "string",
  • "tax": 0,
  • "chargeStatus": "string",
  • "invoiceReference": "ca10175c-5839-4177-9dc9-5d14b5e27424",
  • "invoiceLineItemReference": "91de3b2c-029c-482c-b94f-0ea71471563f",
  • "payers": [
    ],
  • "estimatedInvoicePrice": {
    },
  • "estimatedPrice": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "amount": {
    },
  • "exchangeRate": {
    },
  • "description": "string",
  • "paymentPeriod": "string",
  • "category": "string",
  • "discount": 0,
  • "discountType": "string",
  • "discountNote": "string",
  • "tax": 0,
  • "chargeStatus": "string",
  • "invoiceReference": "ca10175c-5839-4177-9dc9-5d14b5e27424",
  • "invoiceLineItemReference": "91de3b2c-029c-482c-b94f-0ea71471563f",
  • "payers": [
    ],
  • "estimatedInvoicePrice": {
    },
  • "estimatedPrice": {
    }
}

Get a specified charge record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a charge

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",
  • "amount": {
    },
  • "exchangeRate": {
    },
  • "description": "string",
  • "paymentPeriod": "string",
  • "category": "string",
  • "discount": 0,
  • "discountType": "string",
  • "discountNote": "string",
  • "tax": 0,
  • "chargeStatus": "string",
  • "invoiceReference": "ca10175c-5839-4177-9dc9-5d14b5e27424",
  • "invoiceLineItemReference": "91de3b2c-029c-482c-b94f-0ea71471563f",
  • "payers": [
    ],
  • "estimatedInvoicePrice": {
    },
  • "estimatedPrice": {
    }
}

Update charge record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a charge

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
owner
string <uuid>
required
object (MonetaryValue)
baseCurrency
required
string
value
required
number decimal places <= 2

Monetary amount, fixed to 2 decimal places

object (ExchangeRate)
fromCurrency
required
string
toCurrency
required
string
coefficient
required
number
description
string
paymentPeriod
string^([0-9]{4})?$
string or Refdata (object)
One of
string
discount
number
Default: 0
string or Refdata (object)
One of
string
discountNote
string
tax
number
string or Refdata (object)
One of
string
invoiceReference
string <uuid>
invoiceLineItemReference
string <uuid>
Array of objects (Payer)
Array
required
string or Refdata (object)
payerAmount
required
number
payerNote
string

Responses

Request samples

Content type
application/json
{
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "amount": {
    },
  • "exchangeRate": {
    },
  • "description": "string",
  • "paymentPeriod": "string",
  • "category": "string",
  • "discount": 0,
  • "discountType": "string",
  • "discountNote": "string",
  • "tax": 0,
  • "chargeStatus": "string",
  • "invoiceReference": "ca10175c-5839-4177-9dc9-5d14b5e27424",
  • "invoiceLineItemReference": "91de3b2c-029c-482c-b94f-0ea71471563f",
  • "payers": [
    ],
  • "estimatedInvoicePrice": {
    },
  • "estimatedPrice": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "amount": {
    },
  • "exchangeRate": {
    },
  • "description": "string",
  • "paymentPeriod": "string",
  • "category": "string",
  • "discount": 0,
  • "discountType": "string",
  • "discountNote": "string",
  • "tax": 0,
  • "chargeStatus": "string",
  • "invoiceReference": "ca10175c-5839-4177-9dc9-5d14b5e27424",
  • "invoiceLineItemReference": "91de3b2c-029c-482c-b94f-0ea71471563f",
  • "payers": [
    ],
  • "estimatedInvoicePrice": {
    },
  • "estimatedPrice": {
    }
}

Delete a specified charge record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a charge

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

Checklist Items

Get a set of checklist item 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 checklist item definition record

Authorizations:
accessTokenokapiToken
header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
label
required
string
name
string
description
string
weight
integer
Default: 0

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "name": "string",
  • "description": "string",
  • "weight": 0
}

Response samples

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

Get a specified checklist item definition record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a checklist item definition

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",
  • "label": "string",
  • "name": "string",
  • "description": "string",
  • "weight": 0
}

Update checklist item definition record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a checklist item definition

header Parameters
x-okapi-tenant
required
string
Request Body schema: application/json
required
label
required
string
name
string
description
string
weight
integer
Default: 0

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "name": "string",
  • "description": "string",
  • "weight": 0
}

Response samples

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

Delete a specified checklist item definition record

Authorizations:
accessTokenokapiToken
path Parameters
id
required
string <uuid>

UUID for a checklist item definition

header Parameters
x-okapi-tenant
required
string

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "status": 0,
  • "error": "string",
  • "path": "string"
}

Reports

Get an open-access charges CSV report

Authorizations:
accessTokenokapiToken
query Parameters
institution
string

Not used to filter the underlying query - included verbatim as the institution column value on every output row.

paymentPeriod
string
chargeCategory
string

Comma-separated list of Charge category refdata values.

chargeStatus
string

Comma-separated list of Charge status refdata values.

header Parameters
x-okapi-tenant
required
string

Responses

Get a book processing charges CSV report

Authorizations:
accessTokenokapiToken
query Parameters
institution
string

Not used to filter the underlying query - included verbatim as the institution column value on every output row.

paymentPeriod
string
chargeCategory
string

Comma-separated list of Charge category refdata values.

chargeStatus
string

Comma-separated list of Charge status refdata values.

header Parameters
x-okapi-tenant
required
string

Responses

Get a transformative agreement CSV report

Authorizations:
accessTokenokapiToken
query Parameters
institution
string

Not used to filter the underlying query - included verbatim as the institution column value on every output row.

paymentPeriod
string
publicationStatus
string

PublicationStatus refdata value to filter on.

agreementId
string

Remote ID of the agreement to report on.

header Parameters
x-okapi-tenant
required
string

Responses