FOLIO · Schema
contributionDTO
INN-Reach contribution job execution status tracking and basic statistics
CompanyLibraryLibrary Services PlatformOpen SourceMicroservicesEducation
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Contribution id |
| jobId | string | Instance iteration job id |
| itemTypeMappingStatus | object | Material type mapping validation status |
| locationsMappingStatus | object | Location mapping validation status |
| status | string | Status |
| contributionStarted | string | Date and time when the contribution has started |
| contributionStartedBy | string | Username of the user who started the contribution |
| contributionComplete | string | Date and time when the contribution has completed |
| recordsTotal | integer | Total number of FOLIO instance records |
| recordsProcessed | integer | Total number of Processed records |
| recordsContributed | integer | Total number of Contributed records |
| recordsUpdated | integer | Total number of Updated records |
| recordsDecontributed | integer | Total number of De-contributed records |
| errors | array | List of errors occurred |
| metadata | object | Entity metadata |
JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://artifacts.apis.io/folio/json-schema/folio-contribution-dto-schema.json",
"title": "contributionDTO",
"description": "INN-Reach contribution job execution status tracking and basic statistics",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/folio-contributions-api-openapi.yml#/components/schemas/contributionDTO",
"type": "object",
"properties": {
"id": {
"description": "Contribution id",
"type": "string",
"format": "uuid"
},
"jobId": {
"description": "Instance iteration job id",
"type": "string",
"format": "uuid"
},
"itemTypeMappingStatus": {
"description": "Material type mapping validation status",
"$ref": "#/$defs/mappingValidationStatusDTO",
"default": "Invalid"
},
"locationsMappingStatus": {
"description": "Location mapping validation status",
"$ref": "#/$defs/mappingValidationStatusDTO",
"default": "Invalid"
},
"status": {
"description": "Status",
"type": "string",
"enum": [
"In Progress",
"Complete",
"Not started",
"Cancelled"
],
"default": "Not started"
},
"contributionStarted": {
"description": "Date and time when the contribution has started",
"type": "string",
"format": "date-time"
},
"contributionStartedBy": {
"description": "Username of the user who started the contribution",
"type": "string"
},
"contributionComplete": {
"description": "Date and time when the contribution has completed",
"type": "string",
"format": "date-time"
},
"recordsTotal": {
"description": "Total number of FOLIO instance records",
"type": "integer",
"format": "int64"
},
"recordsProcessed": {
"description": "Total number of Processed records",
"type": "integer",
"format": "int64"
},
"recordsContributed": {
"description": "Total number of Contributed records",
"type": "integer",
"format": "int64"
},
"recordsUpdated": {
"description": "Total number of Updated records",
"type": "integer",
"format": "int64"
},
"recordsDecontributed": {
"description": "Total number of De-contributed records",
"type": "integer",
"format": "int64",
"readOnly": true
},
"errors": {
"description": "List of errors occurred",
"type": "array",
"items": {
"$ref": "#/$defs/contributionErrorDTO"
}
},
"metadata": {
"description": "Entity metadata",
"type": "object",
"$ref": "#/$defs/metadata"
}
},
"additionalProperties": false,
"required": [
"status",
"itemTypeMappingStatus",
"locationsMappingStatus"
],
"$defs": {
"contributionErrorDTO": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "INN-Reach contribution job execution status tracking and basic statistics",
"type": "object",
"properties": {
"id": {
"description": "Contribution id",
"type": "string",
"format": "uuid"
},
"message": {
"description": "Error message (cause)",
"type": "string"
},
"recordId": {
"description": "Id of instance record which has not been processed due to error",
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"required": [
"message",
"recordId"
]
},
"mappingValidationStatusDTO": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Mapping validation status",
"type": "string",
"enum": [
"Valid",
"Invalid"
],
"additionalProperties": false
},
"metadata": {
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"type": "object",
"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"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/folio-contribution-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.