mod-erm-usage-harvester API
http://localhost/erm-usage-harvester
mod-erm-usage-harvester API
This documents the API calls that can be made to mod-erm-usage-harvester
/erm-usage-harvester
get
Start harvesting for tenant - process all defined usage data providers
get /erm-usage-harvester/start
Start harvesting for tenant - process all defined usage data providers
get
Start harvesting for tenant - process a specific usage data provider only
get /erm-usage-harvester/start/{id}
Start harvesting for tenant - process a specific usage data provider only
URI Parameters
- id: required(string)
get
Get available service implementations
get /erm-usage-harvester/impl
Get available service implementations
HTTP status code 200
List of available service implementations
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of ServiceImplementation objects",
"type": "object",
"properties": {
"implementations": {
"description": "List of service implementations",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ServiceImplementation",
"title": "Service Implementation Schema",
"description": "A service endpoint implementation",
"type": "object",
"properties": {
"name": {
"description": "Human-readable display name",
"type": "string"
},
"description": {
"description": "Implementation description",
"type": "string"
},
"type": {
"description": "Service type identifier",
"type": "string"
},
"isDefault": {
"description": "Whether this is the default implementation",
"type": "boolean"
},
"reportRelease": {
"description": "COUNTER report release version",
"type": "string"
},
"supportedReports": {
"description": "List of supported report types",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"type"
],
"additionalProperties": false
}
}
},
"required": [
"implementations"
],
"additionalProperties": false
}HTTP status code 400
Bad request
Body
Media type: text/plain
Type: any
HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
get
Get harvesting jobs
get /erm-usage-harvester/jobs
Get harvesting jobs
Query Parameters
- timestamp: (number)
Only return jobs created at or before this timestamp
Example:
1641020400000 - providerId: (string)
Only return jobs with this providerId
Example:
6697f576-78d4-4712-ae18-2612ccdcd66d - query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
CQL string
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode type==provider - totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
none - offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
10
HTTP status code 200
List of harvesting jobs
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of JobInfo objects",
"type": "object",
"properties": {
"jobInfos": {
"description": "List of JobInfo",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "JobInfo Schema",
"description": "Job information",
"properties": {
"id": {
"description": "Job information id",
"type": "string"
},
"type": {
"description": "Job type",
"type": "string",
"enum": [
"periodic",
"tenant",
"provider"
]
},
"providerId": {
"description": "Job providerId",
"type": "string"
},
"timestamp": {
"description": "Job timestamp",
"type": "number",
"javaType": "java.lang.Long"
},
"startedAt": {
"description": "Job start date-time",
"type": "string",
"format": "date-time"
},
"finishedAt": {
"description": "Job finish date-time",
"type": "string",
"format": "date-time"
},
"nextStart": {
"description": "Job next start date-time",
"type": "string",
"format": "date-time"
},
"result": {
"description": "Job execution result",
"type": "string",
"enum": [
"success",
"failure"
]
},
"errorMessage": {
"description": "Job execution error message",
"type": "string"
}
},
"additionalProperties": false
}
},
"totalRecords": {
"description": "Total number of JobInfo objects",
"type": "integer"
}
},
"required": [
"jobInfos",
"totalRecords"
]
}HTTP status code 400
Bad request
Body
Media type: text/plain
Type: any
HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
post
Purge finished harvesting jobs
post /erm-usage-harvester/jobs/purgefinished
Purge finished harvesting jobs
Query Parameters
- timestamp: required(number)
Only purge jobs having a timestamp less than or equal to this value
Example:
1641020400000
post
Purge stale jobs
post
Perform cleanup tasks on harvesting jobs
Harvester error handling settings
get
post
Replace the stored settings. An option that is left out is unset and uses its default.
get /erm-usage-harvester/error-handling
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ErrorHandling Schema",
"description": "Harvester error handling settings. An option that is not set uses its default, see /erm-usage-harvester/error-handling/defaults",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"maxFailedAttempts": {
"description": "Maximum number of failed attempts per report and month before harvesting is given up",
"type": "integer",
"minimum": 1,
"maximum": 20
},
"code1000": {
"description": "1000 - Service Not Available",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1010": {
"description": "1010 - Service Busy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1011": {
"description": "1011 - Report Queued for Processing",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1020": {
"description": "1020 - Client has made too many requests",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "RateOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.RateOption",
"properties": {
"numberOfRequests": {
"description": "Number of requests",
"type": "integer",
"minimum": 1
},
"timeframeSeconds": {
"description": "Timeframe in seconds",
"type": "integer",
"minimum": 1,
"maximum": 86400
}
},
"required": [
"numberOfRequests",
"timeframeSeconds"
],
"additionalProperties": false
}
},
"additionalProperties": false
}Example:
{
"maxFailedAttempts": 5,
"code1000": {
"waitMinutes": 40
},
"code1010": {
"waitMinutes": 70
},
"code1020": {
"numberOfRequests": 10,
"timeframeSeconds": 10
}
}
HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
post /erm-usage-harvester/error-handling
Replace the stored settings. An option that is left out is unset and uses its default.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ErrorHandling Schema",
"description": "Harvester error handling settings. An option that is not set uses its default, see /erm-usage-harvester/error-handling/defaults",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"maxFailedAttempts": {
"description": "Maximum number of failed attempts per report and month before harvesting is given up",
"type": "integer",
"minimum": 1,
"maximum": 20
},
"code1000": {
"description": "1000 - Service Not Available",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1010": {
"description": "1010 - Service Busy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1011": {
"description": "1011 - Report Queued for Processing",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1020": {
"description": "1020 - Client has made too many requests",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "RateOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.RateOption",
"properties": {
"numberOfRequests": {
"description": "Number of requests",
"type": "integer",
"minimum": 1
},
"timeframeSeconds": {
"description": "Timeframe in seconds",
"type": "integer",
"minimum": 1,
"maximum": 86400
}
},
"required": [
"numberOfRequests",
"timeframeSeconds"
],
"additionalProperties": false
}
},
"additionalProperties": false
}Example:
{
"maxFailedAttempts": 5,
"code1000": {
"waitMinutes": 40
},
"code1010": {
"waitMinutes": 70
},
"code1020": {
"numberOfRequests": 10,
"timeframeSeconds": 10
}
}
HTTP status code 204
Success
HTTP status code 422
Unprocessable Entity
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Default error handling settings that apply to every option that is not set
get
get /erm-usage-harvester/error-handling/defaults
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ErrorHandling Schema",
"description": "Harvester error handling settings. An option that is not set uses its default, see /erm-usage-harvester/error-handling/defaults",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"maxFailedAttempts": {
"description": "Maximum number of failed attempts per report and month before harvesting is given up",
"type": "integer",
"minimum": 1,
"maximum": 20
},
"code1000": {
"description": "1000 - Service Not Available",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1010": {
"description": "1010 - Service Busy",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1011": {
"description": "1011 - Report Queued for Processing",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "WaitOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.WaitOption",
"properties": {
"waitMinutes": {
"description": "Wait time in minutes before the next attempt",
"type": "integer",
"minimum": 1,
"maximum": 1440
}
},
"required": [
"waitMinutes"
],
"additionalProperties": false
},
"code1020": {
"description": "1020 - Client has made too many requests",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "RateOption Schema",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.RateOption",
"properties": {
"numberOfRequests": {
"description": "Number of requests",
"type": "integer",
"minimum": 1
},
"timeframeSeconds": {
"description": "Timeframe in seconds",
"type": "integer",
"minimum": 1,
"maximum": 86400
}
},
"required": [
"numberOfRequests",
"timeframeSeconds"
],
"additionalProperties": false
}
},
"additionalProperties": false
}Example:
{
"maxFailedAttempts": 5,
"code1000": {
"waitMinutes": 60
},
"code1010": {
"waitMinutes": 60
},
"code1011": {
"waitMinutes": 30
},
"code1020": {
"numberOfRequests": 1,
"timeframeSeconds": 1
}
}