/metadata-provider
get
get /metadata-provider/jobExecutions
Query Parameters
- excludeJobProfileName: (string)
Filter by Job profiles name
Example:
Bulk operations data import job profile - * - statusAny: (array of )
JobExecution statuses to filter by
Example:
[ "COMMITTED", "ERROR" ] - profileIdNotAny: (array of )
Filter by specified job profile ids
Example:
[ "d0ebb7b0-2f0f-11eb-adc1-0242ac120002", "91f9b8d6-d80e-4727-9783-73fb53e3c786" ] - statusNot: (string)
Filter by status not equal to
Example:
COMPLETED - uiStatusAny: (array of )
JobExecution statuses to filter by
Example:
[ "READY_FOR_PREVIEW" ] - hrId: (string)
Filter by jobExecution hrid
Example:
123 - fileName: (string)
Filter by jobExecution file name
Example:
importBib1.bib - fileNameNotAny: (array of )
Filter by specified file names
Example:
[ "No file name" ] - profileIdAny: (array of )
Filter by specified job profile ids
Example:
[ "d0ebb7b0-2f0f-11eb-adc1-0242ac120002", "91f9b8d6-d80e-4727-9783-73fb53e3c786" ] - subordinationTypeNotAny: (array of )
Filter by specified SubordinationTypes
Example:
[ "COMPOSITE_CHILD" ] - userId: (string)
Filter by user id
Example:
d0ebb7b0-2f0f-11eb-adc1-0242ac120002 - completedAfter: (datetime)
Start date to filter after, inclusive
- completedBefore: (datetime)
End date to filter before, inclusive
- sortBy: (array of - default: completed_date,asc)
Sorting jobExecutions by field: completed_date, progress_total, file_name, status, job_profile_name, hrid, job_user_first_name, job_user_last_name
Example:
[ "completed_date,asc" ] - 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
Example:
10
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of execution job dtos",
"type": "object",
"additionalProperties": false,
"properties": {
"jobExecutions": {
"description": "List of execution job dtos",
"type": "array",
"id": "jobExecutionList",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Job Execution Dto Schema",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionDto",
"properties": {
"id": {
"description": "Unique identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"hrId": {
"description": "Human readable id",
"type": "integer"
},
"parentJobId": {
"description": "Id of the parent JobExecution entity",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"subordinationType": {
"description": "Type of subordination to another JobExecution entities",
"type": "string",
"enum": [
"CHILD",
"PARENT_SINGLE",
"PARENT_MULTIPLE",
"COMPOSITE_PARENT",
"COMPOSITE_CHILD"
]
},
"jobProfileInfo": {
"description": "Related JobProfile information",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.JobProfileInfo",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique JobProfile identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"name": {
"description": "Job Profile name",
"type": "string"
},
"dataType": {
"description": "Data type",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"enum": [
"Delimited",
"EDIFACT",
"MARC"
]
},
"hidden": {
"description": "Indicates that job should be hidden in data-import log",
"type": "boolean",
"default": false,
"example": false
}
},
"required": [
"id"
]
},
"sourcePath": {
"description": "Path to the file",
"type": "string"
},
"fileName": {
"description": "File name",
"type": "string"
},
"runBy": {
"description": "First and last name of the user that triggered the job execution",
"type": "object",
"properties": {
"firstName": {
"description": "First name",
"type": "string"
},
"lastName": {
"description": "Last name",
"type": "string"
}
}
},
"progress": {
"description": "Execution progress of the job",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"jobExecutionId": {
"description": "Corresponding jobExecution id",
"type": "string"
},
"current": {
"description": "Currently processing record",
"type": "integer"
},
"total": {
"description": "Total number of records to be processed",
"type": "integer"
}
}
},
"startedDate": {
"description": "Date and time when the job execution started",
"type": "string",
"format": "date-time"
},
"completedDate": {
"description": "Date and time when the job execution completed",
"type": "string",
"format": "date-time"
},
"status": {
"description": "Current status of the job execution",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"enum": [
"PARENT",
"NEW",
"FILE_UPLOADED",
"PARSING_IN_PROGRESS",
"PARSING_FINISHED",
"PROCESSING_IN_PROGRESS",
"PROCESSING_FINISHED",
"COMMIT_IN_PROGRESS",
"COMMITTED",
"ERROR",
"DISCARDED",
"CANCELLED"
]
},
"uiStatus": {
"description": "Status that is rendered on UI",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"enum": [
"PARENT",
"INITIALIZATION",
"PREPARING_FOR_PREVIEW",
"READY_FOR_PREVIEW",
"RUNNING",
"RUNNING_COMPLETE",
"ERROR",
"DISCARDED",
"CANCELLED"
]
},
"errorStatus": {
"description": "Status that describe error state of job execution",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"enum": [
"SNAPSHOT_UPDATE_ERROR",
"RECORD_UPDATE_ERROR",
"FILE_PROCESSING_ERROR",
"INSTANCE_CREATING_ERROR",
"PROFILE_SNAPSHOT_CREATING_ERROR"
]
},
"userId": {
"description": "ID of the user who created the JobExecution",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"jobPartNumber": {
"description": "The order number of the chunk job for COMPOSITE jobs",
"type": "integer",
"default": 1
},
"totalJobParts": {
"description": "The total number of chunk jobs for COMPOSITE jobs",
"type": "integer",
"default": 1
},
"compositeDetails": {
"description": "The statuses of this execution's children; applicable only for COMPOSITE_PARENT jobs",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailsDto",
"properties": {
"newState": {
"description": "The number of children with status NEW",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"fileUploadedState": {
"description": "The number of children with status FILE_UPLOADED",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"parsingInProgressState": {
"description": "The number of children with status PARSING_IN_PROGRESS",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"parsingFinishedState": {
"description": "The number of children with status PARSING_FINISHED",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"processingInProgressState": {
"description": "The number of children with status PROCESSING_IN_PROGRESS",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"processingFinishedState": {
"description": "The number of children with status PROCESSING_FINISHED",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"commitInProgressState": {
"description": "The number of children with status COMMIT_IN_PROGRESS",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"committedState": {
"description": "The number of children with status COMMITTED",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"errorState": {
"description": "The number of children with status ERROR",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"discardedState": {
"description": "The number of children with status DISCARDED",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
},
"cancelledState": {
"description": "The number of children with status CANCELLED",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionCompositeDetailDto",
"properties": {
"chunksCount": {
"type": "integer",
"description": "Number of chunks in this state"
},
"totalRecordsCount": {
"type": "integer",
"description": "Number of total records in this state"
},
"currentlyProcessedCount": {
"type": "integer",
"description": "Number of processed records in this state"
}
}
}
}
},
"totalRecordsInFile": {
"description": "The total number of records in the source file for COMPOSITE_PARENT jobs",
"type": "integer",
"default": 0
}
},
"required": [
"id",
"parentJobId",
"subordinationType",
"status",
"uiStatus",
"userId"
],
"excludedFromEqualsAndHashCode": [
"hrId",
"progress",
"runBy"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"excludedFromEqualsAndHashCode": [
"totalRecords"
],
"required": [
"jobExecutions",
"totalRecords"
]
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorget
get journal records by job execution id
get /metadata-provider/journalRecords/{jobExecutionId}
get journal records by job execution id
URI Parameters
- jobExecutionId: required(string)
Query Parameters
- sortBy: (string)
sort criteria
Example:
source_record_order, action_type, error - order: required(one of asc, desc - default: asc)
sort direction
Example:
desc
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of journal records",
"type": "object",
"additionalProperties": false,
"properties": {
"journalRecords": {
"description": "List of journal records",
"type": "array",
"id": "journalRecordList",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Journal record data model",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"jobExecutionId": {
"description": "UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"sourceId": {
"description": "SRS record identifier, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"sourceRecordOrder": {
"description": "Order of the record in imported file",
"type": "integer",
"minimum": 0
},
"entityType": {
"description": "Type of entity",
"type": "string",
"additionalProperties": false,
"enum": [
"INSTANCE",
"HOLDINGS",
"AUTHORITY",
"ITEM",
"ORDER",
"INVOICE",
"MARC_BIBLIOGRAPHIC",
"MARC_HOLDINGS",
"MARC_AUTHORITY",
"EDIFACT",
"PO_LINE"
]
},
"entityId": {
"description": "entity UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"instanceId": {
"description": "instance UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"holdingsId": {
"description": "holdings UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"orderId": {
"description": "order UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"permanentLocationId": {
"description": "permanent location UUID inside Holdings entity",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"entityHrId": {
"description": "Entity human readable id",
"type": "string"
},
"actionType": {
"description": "Type of action",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATE",
"UPDATE",
"DELETE",
"MODIFY",
"MATCH",
"NON_MATCH",
"PARSE"
]
},
"actionStatus": {
"description": "Status of action",
"type": "string",
"enum": [
"COMPLETED",
"ERROR"
]
},
"error": {
"description": "Error message",
"type": "string"
},
"title": {
"description": "Title from source record",
"type": "string"
},
"actionDate": {
"description": "Date and time when action was performed during record processing",
"type": "string",
"format": "date-time"
},
"tenantId": {
"description": "Id of tenant in which action was performed over entity. Mostly used to save the Id of the central tenant in which the record/entity was updated by data import initiated on member tenant",
"type": "string"
}
},
"required": [
"jobExecutionId"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"excludedFromEqualsAndHashCode": [
"totalRecords"
],
"required": [
"journalRecords",
"totalRecords"
]
}HTTP status code 400
Bad request
Body
Media type: text/plain
Type: any
Example:
Bad requestHTTP status code 404
Not found
Body
Media type: text/plain
Type: any
Example:
Not foundget
get journal records by job execution id
get /metadata-provider/jobLogEntries/{jobExecutionId}
get journal records by job execution id
URI Parameters
- jobExecutionId: required(string)
Query Parameters
- sortBy: (string - default: source_record_order)
sorting by field: source_record_order, title, source_record_action_status, instance_action_status, holdings_action_status, item_action_status, order_action_status, invoice_action_status, error
Example:
source_record_order - order: (one of asc, desc - default: asc)
sorting direction
Example:
desc - errorsOnly: (boolean - default: false)
Filter by occurrence of error field
Example:
true - entityType: (one of MARC, INSTANCE, HOLDINGS, AUTHORITY, ITEM, ORDER, INVOICE, ALL - default: ALL)
Filter by entity type: MARC, INSTANCE, HOLDINGS, AUTHORITY, ITEM, ORDER, INVOICE
Example:
MARC - 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
Example:
10
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of record processing logs",
"type": "object",
"additionalProperties": false,
"properties": {
"entries": {
"description": "List of of record processing logs",
"type": "array",
"id": "entries",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Record processing log DTO schema",
"javaType": "org.folio.rest.jaxrs.model.RecordProcessingLogDto",
"type": "object",
"additionalProperties": false,
"properties": {
"jobExecutionId": {
"description": "UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"incomingRecordId": {
"description": "Incoming record identifier, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"sourceRecordId": {
"description": "SRS record identifier, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"sourceRecordOrder": {
"description": "Order of a record in imported file",
"type": "string"
},
"sourceRecordTitle": {
"description": "Title from record",
"type": "string"
},
"sourceRecordActionStatus": {
"description": "Status of action performed above a record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"sourceRecordType": {
"description": "Type of entity",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Record Type Schema",
"additionalProperties": false,
"enum": [
"INSTANCE",
"HOLDINGS",
"AUTHORITY",
"ITEM",
"ORDER",
"INVOICE",
"MARC_BIBLIOGRAPHIC",
"MARC_HOLDINGS",
"MARC_AUTHORITY",
"EDIFACT"
]
},
"error": {
"description": "Error message",
"type": "string"
},
"sourceRecordTenantId": {
"description": "Id of tenant in which action was performed over record",
"type": "string"
},
"relatedInstanceInfo": {
"description": "Information about instance associated with source record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ProcessedEntityInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"tenantId": {
"description": "Id of tenant in which action was performed over entity",
"type": "string"
}
}
},
"relatedHoldingsInfo": {
"description": "Information about holdings associated with source record",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Information about affected holdings by data import process",
"javaType": "org.folio.rest.jaxrs.model.ProcessedHoldingsInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"id": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"hrid": {
"description": "Human readable id of the entity affected during data import process",
"type": "string"
},
"permanentLocationId": {
"description": "Holdings permanent location",
"type": "string"
},
"error": {
"description": "Error message",
"type": "string"
}
}
}
},
"relatedItemInfo": {
"description": "Information about item associated with source record",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Information about affected item by data import process",
"javaType": "org.folio.rest.jaxrs.model.ProcessedItemInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"id": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"hrid": {
"description": "Human readable id of the entity affected during data import process",
"type": "string"
},
"holdingsId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"error": {
"description": "Error message",
"type": "string"
}
}
}
},
"relatedAuthorityInfo": {
"description": "Information about authority associated with source record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ProcessedEntityInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"tenantId": {
"description": "Id of tenant in which action was performed over entity",
"type": "string"
}
}
},
"relatedPoLineInfo": {
"description": "Information about poLine associated with source record",
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"orderId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
}
},
"relatedInvoiceInfo": {
"description": "Information about invoice associated with source record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ProcessedEntityInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"tenantId": {
"description": "Id of tenant in which action was performed over entity",
"type": "string"
}
}
},
"relatedInvoiceLineInfo": {
"description": "Information about invoice line associated with source record",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed with invoice line",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"id": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"fullInvoiceLineNumber": {
"description": "Consists of vendor invoice number and invoice line sequence number",
"type": "string"
},
"error": {
"description": "Error message",
"type": "string"
}
}
},
"invoiceLineJournalRecordId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"required": [
"jobExecutionId",
"sourceRecordOrder"
]
}
},
"totalRecords": {
"description": "Total number of records in collection",
"type": "integer"
}
},
"excludedFromEqualsAndHashCode": [
"totalRecords"
],
"required": [
"entries",
"totalRecords"
]
}HTTP status code 400
Bad request
Body
Media type: text/plain
Type: any
Example:
Bad requestget
get record processing log dto by job execution id and record id (to get EDIFACT import log data a journal record id is expected)
get /metadata-provider/jobLogEntries/{jobExecutionId}/records/{recordId}
get record processing log dto by job execution id and record id (to get EDIFACT import log data a journal record id is expected)
URI Parameters
- jobExecutionId: required(string)
- recordId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Record processing log DTO schema",
"javaType": "org.folio.rest.jaxrs.model.RecordProcessingLogDto",
"type": "object",
"additionalProperties": false,
"properties": {
"jobExecutionId": {
"description": "UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"incomingRecordId": {
"description": "Incoming record identifier, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"sourceRecordId": {
"description": "SRS record identifier, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"sourceRecordOrder": {
"description": "Order of a record in imported file",
"type": "string"
},
"sourceRecordTitle": {
"description": "Title from record",
"type": "string"
},
"sourceRecordActionStatus": {
"description": "Status of action performed above a record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"sourceRecordType": {
"description": "Type of entity",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Record Type Schema",
"additionalProperties": false,
"enum": [
"INSTANCE",
"HOLDINGS",
"AUTHORITY",
"ITEM",
"ORDER",
"INVOICE",
"MARC_BIBLIOGRAPHIC",
"MARC_HOLDINGS",
"MARC_AUTHORITY",
"EDIFACT"
]
},
"error": {
"description": "Error message",
"type": "string"
},
"sourceRecordTenantId": {
"description": "Id of tenant in which action was performed over record",
"type": "string"
},
"relatedInstanceInfo": {
"description": "Information about instance associated with source record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ProcessedEntityInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"tenantId": {
"description": "Id of tenant in which action was performed over entity",
"type": "string"
}
}
},
"relatedHoldingsInfo": {
"description": "Information about holdings associated with source record",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Information about affected holdings by data import process",
"javaType": "org.folio.rest.jaxrs.model.ProcessedHoldingsInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"id": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"hrid": {
"description": "Human readable id of the entity affected during data import process",
"type": "string"
},
"permanentLocationId": {
"description": "Holdings permanent location",
"type": "string"
},
"error": {
"description": "Error message",
"type": "string"
}
}
}
},
"relatedItemInfo": {
"description": "Information about item associated with source record",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Information about affected item by data import process",
"javaType": "org.folio.rest.jaxrs.model.ProcessedItemInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"id": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"hrid": {
"description": "Human readable id of the entity affected during data import process",
"type": "string"
},
"holdingsId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"error": {
"description": "Error message",
"type": "string"
}
}
}
},
"relatedAuthorityInfo": {
"description": "Information about authority associated with source record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ProcessedEntityInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"tenantId": {
"description": "Id of tenant in which action was performed over entity",
"type": "string"
}
}
},
"relatedPoLineInfo": {
"description": "Information about poLine associated with source record",
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"orderId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
}
},
"relatedInvoiceInfo": {
"description": "Information about invoice associated with source record",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ProcessedEntityInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed above folio entity, value MULTIPLE if multiple entities of the same type were affected",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"idList": {
"description": "Id of entities which were affected during data import process",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"hridList": {
"description": "Human readable id of entities which were affected during data import process",
"type": "array",
"items": {
"type": "string"
}
},
"error": {
"description": "Error message",
"type": "string"
},
"tenantId": {
"description": "Id of tenant in which action was performed over entity",
"type": "string"
}
}
},
"relatedInvoiceLineInfo": {
"description": "Information about invoice line associated with source record",
"type": "object",
"additionalProperties": false,
"properties": {
"actionStatus": {
"description": "Status of action performed with invoice line",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.ActionStatus",
"type": "string",
"additionalProperties": false,
"enum": [
"CREATED",
"UPDATED",
"MULTIPLE",
"DISCARDED"
]
},
"id": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"fullInvoiceLineNumber": {
"description": "Consists of vendor invoice number and invoice line sequence number",
"type": "string"
},
"error": {
"description": "Error message",
"type": "string"
}
}
},
"invoiceLineJournalRecordId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
}
},
"required": [
"jobExecutionId",
"sourceRecordOrder"
]
}HTTP status code 400
Bad request
Body
Media type: text/plain
Type: any
Example:
Bad requestHTTP status code 404
Not found
Body
Media type: text/plain
Type: any
Example:
Not foundget
get summary result for import job
get /metadata-provider/jobSummary/{jobExecutionId}
get summary result for import job
URI Parameters
- jobExecutionId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Job execution summary DTO schema",
"type": "object",
"additionalProperties": false,
"properties": {
"jobExecutionId": {
"description": "UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"totalErrors": {
"description": "Total errors number",
"type": "integer"
},
"sourceRecordSummary": {
"description": "Source record processing summary",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.EntityProcessingSummary",
"type": "object",
"additionalProperties": false,
"properties": {
"totalCreatedEntities": {
"description": "Total number of created entities",
"type": "integer"
},
"totalUpdatedEntities": {
"description": "Total number of updated entities",
"type": "integer"
},
"totalDiscardedEntities": {
"description": "Total number of discarded entities, consists of total errors and number of occurrences that entity does not match",
"type": "integer"
},
"totalErrors": {
"description": "Total errors number during entity processing",
"type": "integer"
}
}
},
"instanceSummary": {
"description": "Instance processing summary",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.EntityProcessingSummary",
"type": "object",
"additionalProperties": false,
"properties": {
"totalCreatedEntities": {
"description": "Total number of created entities",
"type": "integer"
},
"totalUpdatedEntities": {
"description": "Total number of updated entities",
"type": "integer"
},
"totalDiscardedEntities": {
"description": "Total number of discarded entities, consists of total errors and number of occurrences that entity does not match",
"type": "integer"
},
"totalErrors": {
"description": "Total errors number during entity processing",
"type": "integer"
}
}
},
"holdingSummary": {
"description": "Holding processing summary",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.EntityProcessingSummary",
"type": "object",
"additionalProperties": false,
"properties": {
"totalCreatedEntities": {
"description": "Total number of created entities",
"type": "integer"
},
"totalUpdatedEntities": {
"description": "Total number of updated entities",
"type": "integer"
},
"totalDiscardedEntities": {
"description": "Total number of discarded entities, consists of total errors and number of occurrences that entity does not match",
"type": "integer"
},
"totalErrors": {
"description": "Total errors number during entity processing",
"type": "integer"
}
}
},
"itemSummary": {
"description": "Item processing summary",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.EntityProcessingSummary",
"type": "object",
"additionalProperties": false,
"properties": {
"totalCreatedEntities": {
"description": "Total number of created entities",
"type": "integer"
},
"totalUpdatedEntities": {
"description": "Total number of updated entities",
"type": "integer"
},
"totalDiscardedEntities": {
"description": "Total number of discarded entities, consists of total errors and number of occurrences that entity does not match",
"type": "integer"
},
"totalErrors": {
"description": "Total errors number during entity processing",
"type": "integer"
}
}
},
"authoritySummary": {
"description": "Authority processing summary",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.EntityProcessingSummary",
"type": "object",
"additionalProperties": false,
"properties": {
"totalCreatedEntities": {
"description": "Total number of created entities",
"type": "integer"
},
"totalUpdatedEntities": {
"description": "Total number of updated entities",
"type": "integer"
},
"totalDiscardedEntities": {
"description": "Total number of discarded entities, consists of total errors and number of occurrences that entity does not match",
"type": "integer"
},
"totalErrors": {
"description": "Total errors number during entity processing",
"type": "integer"
}
}
},
"orderSummary": {
"description": "Order processing summary",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.EntityProcessingSummary",
"type": "object",
"additionalProperties": false,
"properties": {
"totalCreatedEntities": {
"description": "Total number of created entities",
"type": "integer"
},
"totalUpdatedEntities": {
"description": "Total number of updated entities",
"type": "integer"
},
"totalDiscardedEntities": {
"description": "Total number of discarded entities, consists of total errors and number of occurrences that entity does not match",
"type": "integer"
},
"totalErrors": {
"description": "Total errors number during entity processing",
"type": "integer"
}
}
},
"invoiceSummary": {
"description": "Invoice processing summary",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "org.folio.rest.jaxrs.model.EntityProcessingSummary",
"type": "object",
"additionalProperties": false,
"properties": {
"totalCreatedEntities": {
"description": "Total number of created entities",
"type": "integer"
},
"totalUpdatedEntities": {
"description": "Total number of updated entities",
"type": "integer"
},
"totalDiscardedEntities": {
"description": "Total number of discarded entities, consists of total errors and number of occurrences that entity does not match",
"type": "integer"
},
"totalErrors": {
"description": "Total errors number during entity processing",
"type": "integer"
}
}
}
},
"required": [
"jobExecutionId"
]
}HTTP status code 404
Not found
Body
Media type: text/plain
Type: any
Example:
Not foundget
get /metadata-provider/jobExecutions/jobProfiles
Query Parameters
- 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
Example:
10
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of related Job Profiles",
"type": "object",
"additionalProperties": false,
"properties": {
"jobProfilesInfo": {
"description": "List of related Job Profiles",
"type": "array",
"id": "profileInfoList",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Related JobProfile information",
"javaType": "org.folio.rest.jaxrs.model.JobProfileInfo",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique JobProfile identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"name": {
"description": "Job Profile name",
"type": "string"
},
"dataType": {
"description": "Data type",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"enum": [
"Delimited",
"EDIFACT",
"MARC"
]
},
"hidden": {
"description": "Indicates that job should be hidden in data-import log",
"type": "boolean",
"default": false,
"example": false
}
},
"required": [
"id"
]
}
},
"totalRecords": {
"description": "Total number of related Job Profiles",
"type": "integer"
}
},
"excludedFromEqualsAndHashCode": [
"totalRecords"
],
"required": [
"jobProfilesInfo",
"totalRecords"
]
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorget
get unique users for job JobExecutions
get /metadata-provider/jobExecutions/users
get unique users for job JobExecutions
Query Parameters
- 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
Example:
10
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of job executions unique user info",
"type": "object",
"additionalProperties": false,
"properties": {
"jobExecutionUsersInfo": {
"description": "List of Job Execution unique users info",
"type": "array",
"id": "entries",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Job Execution unique user info",
"javaType": "org.folio.rest.jaxrs.model.JobExecutionUserInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"userId": {
"description": "Unique user identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"jobUserFirstName": {
"description": "User first name for jobs.",
"type": "string"
},
"jobUserLastName": {
"description": "User last name for jobs.",
"type": "string"
}
},
"required": [
"userId"
]
}
},
"totalRecords": {
"description": "Total number of records in collection",
"type": "integer"
}
},
"excludedFromEqualsAndHashCode": [
"totalRecords"
],
"required": [
"jobExecutionUsersInfo",
"totalRecords"
]
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorget
get incoming record by id
get /metadata-provider/incomingRecords/{recordId}
get incoming record by id
URI Parameters
- recordId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Incoming Record Data Model",
"javaType": "org.folio.rest.jaxrs.model.IncomingRecord",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"jobExecutionId": {
"description": "Job execution id",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"recordType": {
"description": "Type of record, e.g. MARC",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"enum": [
"MARC_BIB",
"MARC_AUTHORITY",
"MARC_HOLDING",
"EDIFACT"
]
},
"order": {
"description": "Order of the record in imported file",
"type": "integer",
"minimum": 0
},
"rawRecordContent": {
"description": "Raw record content",
"type": "string"
},
"parsedRecordContent": {
"description": "Parsed record content"
}
}
}HTTP status code 404
Not found
Body
Media type: text/plain
Type: any
Example:
Not found