Custom Reports version v1.1
http://localhost/mod-erm-usage
mod-erm-usage API
This documents the API calls that can be made to query and manage custom reports
Custom Usage Reports
Collection of custom-report items.
Get all reports.
Post new report
get /custom-reports
Get all reports.
Query Parameters
- 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.
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode year=2018 - orderBy: (string)
Order by field:
- order: (one of desc, asc - default: desc)
Order
- 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
Returns a list of custom-report items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "List of CustomReports",
"type": "object",
"properties": {
"customReports": {
"type": "array",
"description": "Entries",
"id": "customReportData",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom Report and Metadata",
"title": "Custom Report Schema",
"properties": {
"id": {
"type": "string"
},
"year": {
"type": "integer",
"description": "The year the report is valid. The report may not cover a whole year. You can add multiple reports with the same year. Then please specify the accurate reporting period in the notes."
},
"note": {
"type": "string",
"description": "Field to give additional information, e.g. month the report covers."
},
"fileId": {
"type": "string",
"description": "UUID of the binary file (which is uploaded before this custom report document)."
},
"fileName": {
"type": "string",
"description": "The file's filename."
},
"fileSize": {
"type": "number",
"description": "Size of file in kb."
},
"providerId": {
"description": "Id of associated usage data provider",
"type": "string"
},
"linkUrl": {
"description": "Link to an external resource",
"type": "string"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"required": [
"year",
"providerId"
],
"additionalProperties": false
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"customReports",
"totalRecords"
]
}Example:
{
"customReports": [
{
"id": "d359c28b-1b32-4d8c-9775-e0b444d3b370",
"year": 2019,
"note": "This is a custom report for January 2019",
"fileId": "d70d55be-06b4-42f7-8a2e-a4270686a062",
"fileName": "file.txt",
"fileSize": 1024,
"providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802"
},
{
"id": "1f1d53de-9224-4503-a047-ad3bd699c51e",
"year": 2019,
"note": "This is a custom report for February 2019",
"providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
"linkUrl": "http://localhost/link"
}
],
"totalRecords": 2
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
unable to list custom-reports -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list custom-reports -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /custom-reports
Post new report
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom Report and Metadata",
"title": "Custom Report Schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"year": {
"type": "integer",
"description": "The year the report is valid. The report may not cover a whole year. You can add multiple reports with the same year. Then please specify the accurate reporting period in the notes."
},
"note": {
"type": "string",
"description": "Field to give additional information, e.g. month the report covers."
},
"fileId": {
"type": "string",
"description": "UUID of the binary file (which is uploaded before this custom report document)."
},
"fileName": {
"type": "string",
"description": "The file's filename."
},
"fileSize": {
"type": "number",
"description": "Size of file in kb."
},
"providerId": {
"description": "Id of associated usage data provider",
"type": "string"
},
"linkUrl": {
"description": "Link to an external resource",
"type": "string"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"required": [
"year",
"providerId"
],
"additionalProperties": false
}Example:
{
"id": "d359c28b-1b32-4d8c-9775-e0b444d3b370",
"year": 2019,
"note": "This is a custom report for January 2019",
"fileId": "d70d55be-06b4-42f7-8a2e-a4270686a062",
"fileName": "filename.txt",
"fileSize": 1024,
"providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
"linkUrl": "http://localhost/link"
}HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created custom-report item
Body
Media type: application/json
Type: any
Example:
{
"id": "d359c28b-1b32-4d8c-9775-e0b444d3b370",
"year": 2019,
"note": "This is a custom report for January 2019",
"fileId": "d70d55be-06b4-42f7-8a2e-a4270686a062",
"fileName": "filename.txt",
"fileSize": 1024,
"providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
"linkUrl": "http://localhost/link"
}HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to add custom-report -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create custom-reports -- unauthorizedHTTP status code 422
Validation errors
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"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorEntity representing a custom-report
Get one report identified by id
Delete report identified by id
Put report identified by id
get /custom-reports/{id}
Get one report identified by id
URI Parameters
- id: required(string)
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom Report and Metadata",
"title": "Custom Report Schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"year": {
"type": "integer",
"description": "The year the report is valid. The report may not cover a whole year. You can add multiple reports with the same year. Then please specify the accurate reporting period in the notes."
},
"note": {
"type": "string",
"description": "Field to give additional information, e.g. month the report covers."
},
"fileId": {
"type": "string",
"description": "UUID of the binary file (which is uploaded before this custom report document)."
},
"fileName": {
"type": "string",
"description": "The file's filename."
},
"fileSize": {
"type": "number",
"description": "Size of file in kb."
},
"providerId": {
"description": "Id of associated usage data provider",
"type": "string"
},
"linkUrl": {
"description": "Link to an external resource",
"type": "string"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"required": [
"year",
"providerId"
],
"additionalProperties": false
}Example:
{
"id": "d359c28b-1b32-4d8c-9775-e0b444d3b370",
"year": 2019,
"note": "This is a custom report for January 2019",
"fileId": "d70d55be-06b4-42f7-8a2e-a4270686a062",
"fileName": "filename.txt",
"fileSize": 1024,
"providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
"linkUrl": "http://localhost/link"
}HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"custom-report not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /custom-reports/{id}
Delete report identified by id
URI Parameters
- id: required(string)
HTTP status code 204
Item deleted successfully
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to delete custom-report -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"custom-report not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorput /custom-reports/{id}
Put report identified by id
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom Report and Metadata",
"title": "Custom Report Schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"year": {
"type": "integer",
"description": "The year the report is valid. The report may not cover a whole year. You can add multiple reports with the same year. Then please specify the accurate reporting period in the notes."
},
"note": {
"type": "string",
"description": "Field to give additional information, e.g. month the report covers."
},
"fileId": {
"type": "string",
"description": "UUID of the binary file (which is uploaded before this custom report document)."
},
"fileName": {
"type": "string",
"description": "The file's filename."
},
"fileSize": {
"type": "number",
"description": "Size of file in kb."
},
"providerId": {
"description": "Id of associated usage data provider",
"type": "string"
},
"linkUrl": {
"description": "Link to an external resource",
"type": "string"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"required": [
"year",
"providerId"
],
"additionalProperties": false
}Example:
{
"id": "d359c28b-1b32-4d8c-9775-e0b444d3b370",
"year": 2019,
"note": "This is a custom report for January 2019",
"fileId": "d70d55be-06b4-42f7-8a2e-a4270686a062",
"fileName": "filename.txt",
"fileSize": 1024,
"providerId": "4b659cb9-e4bb-493d-ae30-5f5690c54802",
"linkUrl": "http://localhost/link"
}HTTP status code 204
Item successfully updated
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to update custom-report -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"custom-report not found"
HTTP status code 409
Optimistic locking version conflict
Body
Media type: text/plain
Type: any
Example:
version conflictHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administrator