mod-finance-storage API documentation version v1
https://github.com/folio-org/mod-finance-storage
mod-finance-storage (Ledger Rollover Progress)
CRUD APIs used to manage ledger rollover progress.
/finance-storage/ledger-rollovers-progress
Collection of ledger-rollovers-progress items.
Get list of rollovers progresses
Create a new ledger-rollovers-progress item.
get /finance-storage/ledger-rollovers-progress
Get list of rollovers progresses
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.
with valid searchable fields: for example code
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode ["code", "MEDGRANT", "="]
- 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
Example:
10
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns a list of ledger-rollovers-progress items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of ledger fiscal year rollovers progress",
"type": "object",
"properties": {
"ledgerFiscalYearRolloverProgresses": {
"description": "The list of ledger fiscal year rollovers progress",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Ledger fiscal year rollover progress",
"type": "object",
"properties": {
"id": {
"description": "Id of ledger fiscal year rollover progress",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"overallRolloverStatus": {
"description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"budgetsClosingRolloverStatus": {
"description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"financialRolloverStatus": {
"description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"ordersRolloverStatus": {
"description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"metadata": {
"readonly": true,
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"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"
]
}
},
"additionalProperties": false,
"required": [
"ledgerRolloverId"
]
}
},
"totalRecords": {
"description": "The number of records contained in this collection",
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false,
"required": [
"ledgerFiscalYearRolloverProgresses",
"totalRecords"
]
}
Example:
{
"ledgerFiscalYearRolloverProgresses": [
{
"id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"overallRolloverStatus": "In Progress",
"budgetsClosingRolloverStatus": "Success",
"financialRolloverStatus": "In Progress",
"ordersRolloverStatus": "Not Started",
"metadata": {
"createdDate": "2020-12-03T20:53:43.984+0000",
"createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
"updatedDate": "2020-12-03T20:53:43.984+0000",
"updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
}
}
],
"totalRecords": 1
}
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 ledger-rollovers-progress -- malformed parameter 'query', syntax error at column 6
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list ledger-rollovers-progress -- unauthorized
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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#",
"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": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"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 administrator
post /finance-storage/ledger-rollovers-progress
Create a new ledger-rollovers-progress item.
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Ledger fiscal year rollover progress",
"type": "object",
"properties": {
"id": {
"description": "Id of ledger fiscal year rollover progress",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"overallRolloverStatus": {
"description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"budgetsClosingRolloverStatus": {
"description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"financialRolloverStatus": {
"description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"ordersRolloverStatus": {
"description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"metadata": {
"readonly": true,
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"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"
]
}
},
"additionalProperties": false,
"required": [
"ledgerRolloverId"
]
}
Example:
{
"id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"overallRolloverStatus": "In Progress",
"budgetsClosingRolloverStatus": "Success",
"financialRolloverStatus": "In Progress",
"ordersRolloverStatus": "Not Started",
"metadata": {
"createdDate": "2020-12-03T20:53:43.984+0000",
"createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
"updatedDate": "2020-12-03T20:53:43.984+0000",
"updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
}
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created ledger-rollovers-progress item
Body
Media type: application/json
Type: any
Example:
{
"id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"overallRolloverStatus": "In Progress",
"budgetsClosingRolloverStatus": "Success",
"financialRolloverStatus": "In Progress",
"ordersRolloverStatus": "Not Started",
"metadata": {
"createdDate": "2020-12-03T20:53:43.984+0000",
"createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
"updatedDate": "2020-12-03T20:53:43.984+0000",
"updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
}
}
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 ledger-rollovers-progress -- 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 ledger-rollovers-progress -- unauthorized
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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#",
"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": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"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 administrator
Entity representing a ledger-rollovers-progress
Retrieve ledger-rollovers-progress item with given {ledger-rollovers-progressId}
Delete ledger-rollovers-progress item with given {ledger-rollovers-progressId}
Update ledger-rollovers-progress item with given {ledger-rollovers-progressId}
get /finance-storage/ledger-rollovers-progress/{id}
Retrieve ledger-rollovers-progress item with given {ledger-rollovers-progressId}
URI Parameters
- id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a rollover progress record
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
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": "Ledger fiscal year rollover progress",
"type": "object",
"properties": {
"id": {
"description": "Id of ledger fiscal year rollover progress",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"overallRolloverStatus": {
"description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"budgetsClosingRolloverStatus": {
"description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"financialRolloverStatus": {
"description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"ordersRolloverStatus": {
"description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"metadata": {
"readonly": true,
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"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"
]
}
},
"additionalProperties": false,
"required": [
"ledgerRolloverId"
]
}
Example:
{
"id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"overallRolloverStatus": "In Progress",
"budgetsClosingRolloverStatus": "Success",
"financialRolloverStatus": "In Progress",
"ordersRolloverStatus": "Not Started",
"metadata": {
"createdDate": "2020-12-03T20:53:43.984+0000",
"createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
"updatedDate": "2020-12-03T20:53:43.984+0000",
"updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
}
}
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"ledger-rollovers-progress not found"
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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#",
"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": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"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 administrator
delete /finance-storage/ledger-rollovers-progress/{id}
Delete ledger-rollovers-progress item with given {ledger-rollovers-progressId}
URI Parameters
- id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a rollover progress record
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
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 ledger-rollovers-progress -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"ledger-rollovers-progress not found"
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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#",
"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": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"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 administrator
put /finance-storage/ledger-rollovers-progress/{id}
Update ledger-rollovers-progress item with given {ledger-rollovers-progressId}
URI Parameters
- id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a rollover progress record
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Ledger fiscal year rollover progress",
"type": "object",
"properties": {
"id": {
"description": "Id of ledger fiscal year rollover progress",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"overallRolloverStatus": {
"description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"budgetsClosingRolloverStatus": {
"description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"financialRolloverStatus": {
"description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"ordersRolloverStatus": {
"description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Not Started",
"In Progress",
"Error",
"Success"
],
"default": "Not Started"
},
"metadata": {
"readonly": true,
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"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"
]
}
},
"additionalProperties": false,
"required": [
"ledgerRolloverId"
]
}
Example:
{
"id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"overallRolloverStatus": "In Progress",
"budgetsClosingRolloverStatus": "Success",
"financialRolloverStatus": "In Progress",
"ordersRolloverStatus": "Not Started",
"metadata": {
"createdDate": "2020-12-03T20:53:43.984+0000",
"createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
"updatedDate": "2020-12-03T20:53:43.984+0000",
"updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
}
}
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 ledger-rollovers-progress -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"ledger-rollovers-progress not found"
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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#",
"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": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"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 administrator