Reservoir API (except upload) (v1)

getOaiConfig

Get OAI configuration

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"transformer": "string",
"repositoryName": "string",
"baseURL": "string",
"adminEmail": "string"
}

putOaiConfig

Update OAI configuration.

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

transformer	string OAI server response transformer invocation: 'moduleId<::function>' where <::function> is optional
repositoryName	string OAI repository name
baseURL	string OAI repository base URL
adminEmail	string OAI repository admin email

Responses

Request samples

Payload

Content type

application/json

{"transformer": "string",
"repositoryName": "string",
"baseURL": "string",
"adminEmail": "string"
}

Response samples

400
404

Content type

text/plain

No sample

deleteOaiConfig

Update OAI configuration.

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400

Content type

text/plain

No sample

postConfigMatchKey

Create match key

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

id required	string match key identifier
matcher	string matcher module invocation: 'moduleId<::function>' where <::function> is optional
method	string Deprecated DEPRECATED: use 'matcher' instead
params	object Deprecated DEPRECATED: use 'matcher' instead
update	string Enum: "ingest" "manual" ingest: update when records are ingested, manual: update only when initialize is called

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"matcher": "string",
"method": "string",
"params": { },
"update": "ingest"
}

Response samples

201
400

Content type

application/json

{"id": "string",
"matcher": "string",
"method": "string",
"params": { },
"update": "ingest"
}

getConfigMatchKeys

Get match key configurations

query Parameters

count	string Default: "none" Enum: "exact" "none" control of counting in queries
limit	integer >= 0 Default: 10 Limit the number of elements returned in the response
query	string CQL query
offset	integer >= 0 Default: 0 Skip over number of elements (default is first element)

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400

Content type

application/json

{"matchKeys": [{"id": "string",
"matcher": "string",
"method": "string",
"params": { },
"update": "ingest"
}
],
"resultInfo": {"totalRecords": 0,
"diagnostics": [{"message": "string"
}
],
"facets": [{"facetValues": [{"count": 0,
"value": null
}
],
"type": "string"
}
]
}
}

getConfigMatchKey

Get match key configuration

path Parameters

id

required

string

match key identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"id": "string",
"matcher": "string",
"method": "string",
"params": { },
"update": "ingest"
}

deleteConfigMatchKey

Delete match key configuration

path Parameters

id

required

string

match key identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400
404

Content type

text/plain

No sample

putConfigMatchKey

Update match key configuration.

path Parameters

id

required

string

match key identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

id required	string match key identifier
matcher	string matcher module invocation: 'moduleId<::function>' where <::function> is optional
method	string Deprecated DEPRECATED: use 'matcher' instead
params	object Deprecated DEPRECATED: use 'matcher' instead
update	string Enum: "ingest" "manual" ingest: update when records are ingested, manual: update only when initialize is called

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"matcher": "string",
"method": "string",
"params": { },
"update": "ingest"
}

Response samples

400
404

Content type

text/plain

No sample

initializeMatchKey

Recalculate match key across all records.

path Parameters

id

required

string

match key identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"totalRecords": 0,
"clustersTotal": 0,
"matchValuesPerCluster": { },
"recordsPerCluster": { },
"recordsPerClusterSample": { }
}

statsMatchKey

Get statistics for match key configuration

path Parameters

id

required

string

match key identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"totalRecords": 0,
"clustersTotal": 0,
"matchValuesPerCluster": { },
"recordsPerCluster": { },
"recordsPerClusterSample": { }
}

postCodeModule

Create a new code module

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

id required	string local identifier of the module, name
type	string Enum: "jsonpath" "javascript" type of the module'
url	string HTTP URL of the module e.g GitHub url, required if no 'script' specified
function	string Deprecated DEPRECATED: do not use, specify function during invocation
script	string inline contents of the code module

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "jsonpath",
"url": "string",
"function": "string",
"script": "string"
}

Response samples

201
400

Content type

application/json

{"id": "string",
"type": "jsonpath",
"url": "string",
"function": "string",
"script": "string"
}

getCodeModules

Retrieve all code modules

query Parameters

count	string Default: "none" Enum: "exact" "none" control of counting in queries
limit	integer >= 0 Default: 10 Limit the number of elements returned in the response
query	string CQL query
offset	integer >= 0 Default: 0 Skip over number of elements (default is first element)

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400

Content type

application/json

{"modules": [{"id": "string",
"type": "jsonpath",
"url": "string",
"function": "string",
"script": "string"
}
],
"resultInfo": {"totalRecords": 0,
"diagnostics": [{"message": "string"
}
],
"facets": [{"facetValues": [{"count": 0,
"value": null
}
],
"type": "string"
}
]
}
}

getCodeModule

Retrieve a code module by id

path Parameters

id

required

string

code module identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"id": "string",
"type": "jsonpath",
"url": "string",
"function": "string",
"script": "string"
}

putCodeModule

Update code module by id

path Parameters

id

required

string

code module identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

id required	string local identifier of the module, name
type	string Enum: "jsonpath" "javascript" type of the module'
url	string HTTP URL of the module e.g GitHub url, required if no 'script' specified
function	string Deprecated DEPRECATED: do not use, specify function during invocation
script	string inline contents of the code module

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "jsonpath",
"url": "string",
"function": "string",
"script": "string"
}

Response samples

400
404

Content type

text/plain

No sample

deleteCodeModule

Delete code module by id

path Parameters

id

required

string

code module identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400
404

Content type

text/plain

No sample

reloadCodeModule

Force module to be reloaded

path Parameters

id

required

string

code module identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400
404

Content type

text/plain

No sample

getGlobalRecords

Get records that satisfy CQL query with fields localId, sourceId, globalId.

query Parameters

count	string Default: "none" Enum: "exact" "none" control of counting in queries
limit	integer >= 0 Default: 10 Limit the number of elements returned in the response
query	string CQL query
offset	integer >= 0 Default: 0 Skip over number of elements (default is first element)

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400

Content type

application/json

{"items": [{"globalId": "acafdba6-01a5-49f1-8345-02e5e658483c",
"localId": "string",
"sourceId": "string",
"payload": { }
}
],
"resultInfo": {"totalRecords": 0,
"diagnostics": [{"message": "string"
}
],
"facets": [{"facetValues": [{"count": 0,
"value": null
}
],
"type": "string"
}
]
}
}

putGlobalRecords

Create or update records.

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

sourceId

required

string

Source identifier

sourceVersion

integer

Source version

required

Array of objects (ingestRecordChunk)

Ingest job records chunk

Array

localId required	string Local identifier
delete	boolean If true, record is deleted. Default: false
payload	object Payload in JSON

Responses

Request samples

Payload

Content type

application/json

{"sourceId": "string",
"sourceVersion": 0,
"records": [{"localId": "string",
"delete": true,
"payload": { }
}
]
}

Response samples

200
400

Content type

application/json

[{"globalId": "acafdba6-01a5-49f1-8345-02e5e658483c",
"matchKeys": { }
}
]

deleteGlobalRecords

Delete global records.

query Parameters

query

string

CQL query

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400

Content type

text/plain

No sample

getGlobalRecord

Get record with global identifier.

path Parameters

globalId

required

string <uuid>

global identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"globalId": "acafdba6-01a5-49f1-8345-02e5e658483c",
"localId": "string",
"sourceId": "string",
"payload": { }
}

getClusters

Get clusters based on matchkeyid. Query is CQL with the following fields supported: matchValue, clusterId, globalId, localId, sourceId, sourceVersion.

query Parameters

count	string Default: "none" Enum: "exact" "none" control of counting in queries
limit	integer >= 0 Default: 10 Limit the number of elements returned in the response
matchkeyid required	string Match key configuration identifier
query	string CQL query
offset	integer >= 0 Default: 0 Skip over number of elements (default is first element)

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"items": [{"clusterId": "a3d24843-7014-4490-bdd3-b7cb39b400c8",
"datestamp": "2019-08-24",
"records": [{"globalId": "acafdba6-01a5-49f1-8345-02e5e658483c",
"localId": "string",
"sourceId": "string",
"payload": { }
}
],
"matchKeys": ["string"
]
}
],
"resultInfo": {"totalRecords": 0,
"diagnostics": [{"message": "string"
}
],
"facets": [{"facetValues": [{"count": 0,
"value": null
}
],
"type": "string"
}
]
}
}

touchClusters

Update cluster timestamps. CQL must specify at least matchkeyId and sourceId. The sourceVersion and clusterId are optional.

query Parameters

query

string

CQL query

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"count": 0
}

getCluster

Get cluster by identifier

path Parameters

clusterId

required

string <uuid>

cluster identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"clusterId": "a3d24843-7014-4490-bdd3-b7cb39b400c8",
"datestamp": "2019-08-24",
"records": [{"globalId": "acafdba6-01a5-49f1-8345-02e5e658483c",
"localId": "string",
"sourceId": "string",
"payload": { }
}
],
"matchKeys": ["string"
]
}

postOaiPmhClient

Create OAI PMH client job

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

from	string OAI PMH from date
id required	string OAI PMH Client identifier
headers	object Additional HTTP headers to be used against OAI server with keys and string values
metadataPrefix	string OAI PMH metadata prefix
params	object Additional query parameters with keys and string values
resumptionToken	string OAI PMH resumption token
numberRetries	integer Number of retries for temporary errors before giving up (default 3)
waitRetries	integer Number of seconds to wait between retries (default 10)
set	string OAI PMH set as returned in verb=ListSets
sourceId required	string Source identifier used for storing records
sourceVersion	integer Source version used for storing records
until	string OAI PMH until date
url required	string OAI PMH server prefix so that PREFIX?verb=.. works
xmlFixing	boolean Attempt to fix malformed server response by removing invalid chars

Responses

Request samples

Payload

Content type

application/json

{"from": "string",
"id": "string",
"headers": { },
"metadataPrefix": "string",
"params": { },
"resumptionToken": "string",
"numberRetries": 0,
"waitRetries": 0,
"set": "string",
"sourceId": "string",
"sourceVersion": 0,
"until": "string",
"url": "string",
"xmlFixing": true
}

Response samples

201
400

Content type

application/json

{"from": "string",
"id": "string",
"headers": { },
"metadataPrefix": "string",
"params": { },
"resumptionToken": "string",
"numberRetries": 0,
"waitRetries": 0,
"set": "string",
"sourceId": "string",
"sourceVersion": 0,
"until": "string",
"url": "string",
"xmlFixing": true
}

getCollectionOaiPmhClient

Get all OAI PMH client jobs

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

201
400

Content type

application/json

{"from": "string",
"id": "string",
"headers": { },
"metadataPrefix": "string",
"params": { },
"resumptionToken": "string",
"numberRetries": 0,
"waitRetries": 0,
"set": "string",
"sourceId": "string",
"sourceVersion": 0,
"until": "string",
"url": "string",
"xmlFixing": true
}

getOaiPmhClient

Get OAI-PMH client

path Parameters

id

required

string

OAI-PMH client identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"from": "string",
"id": "string",
"headers": { },
"metadataPrefix": "string",
"params": { },
"resumptionToken": "string",
"numberRetries": 0,
"waitRetries": 0,
"set": "string",
"sourceId": "string",
"sourceVersion": 0,
"until": "string",
"url": "string",
"xmlFixing": true
}

putOaiPmhClient

Update OAI-PMH client

path Parameters

id

required

string

OAI-PMH client identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Request Body schema: application/json

from	string OAI PMH from date
id required	string OAI PMH Client identifier
headers	object Additional HTTP headers to be used against OAI server with keys and string values
metadataPrefix	string OAI PMH metadata prefix
params	object Additional query parameters with keys and string values
resumptionToken	string OAI PMH resumption token
numberRetries	integer Number of retries for temporary errors before giving up (default 3)
waitRetries	integer Number of seconds to wait between retries (default 10)
set	string OAI PMH set as returned in verb=ListSets
sourceId required	string Source identifier used for storing records
sourceVersion	integer Source version used for storing records
until	string OAI PMH until date
url required	string OAI PMH server prefix so that PREFIX?verb=.. works
xmlFixing	boolean Attempt to fix malformed server response by removing invalid chars

Responses

Request samples

Payload

Content type

application/json

{"from": "string",
"id": "string",
"headers": { },
"metadataPrefix": "string",
"params": { },
"resumptionToken": "string",
"numberRetries": 0,
"waitRetries": 0,
"set": "string",
"sourceId": "string",
"sourceVersion": 0,
"until": "string",
"url": "string",
"xmlFixing": true
}

Response samples

400
404

Content type

text/plain

No sample

deleteOaiPmhClient

Delete OAI-PMH client

path Parameters

id

required

string

OAI-PMH client identifier

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400
404

Content type

text/plain

No sample

startOaiPmhClient

Start OAI PMH client job

path Parameters

id

required

string

OAI-PMH client identifier; "_all" for all clients

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400
404

Content type

text/plain

No sample

stopOaiPmhClient

Stop OAI PMH client job

path Parameters

id

required

string

OAI-PMH client identifier; "_all" for all clients

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

400
404

Content type

text/plain

No sample

statusOaiPmhClient

Get OAI PMH client status

path Parameters

id

required

string

OAI-PMH client identifier; "_all" for all clients

header Parameters

X-Okapi-Tenant	string Okapi Tenant
X-Okapi-Token	string Okapi Token
X-Okapi-Url	string Okapi URL

Responses

Response samples

200
400
404

Content type

application/json

{"items": [{"config": {"from": "string",
"id": "string",
"headers": { },
"metadataPrefix": "string",
"params": { },
"resumptionToken": "string",
"numberRetries": 0,
"waitRetries": 0,
"set": "string",
"sourceId": "string",
"sourceVersion": 0,
"until": "string",
"url": "string",
"xmlFixing": true
},
"error": "string",
"lastActiveTimestamp": "2019-08-24T14:15:22Z",
"lastRecsPerSec": 0,
"lastRunningTime": "string",
"lastTotalRecords": 0,
"lastStartedTimestamp": "2019-08-24T14:15:22Z",
"status": "idle",
"totalRecords": 0,
"totalDeleted": 0,
"totalInserted": 0,
"totalUpdated": 0,
"totalRequests": 0
}
]
}