API for managing MARC record migrations in FOLIO.
This API allows users to:
The API supports migration operations for different entity types (authority, instance) and operation types (remapping).
Retrieves a collection of MARC migration operations with pagination and filtering options.
| offset | integer [ 0 .. 1000 ] Default: 0 Skip over a number of migrations by specifying an offset value for the query. |
| limit | integer [ 0 .. 1000 ] Default: 100 Limit the number of migration operations returned in the response. |
| entityType | string (EntityType) Enum: "authority" "instance" Example: entityType=authority Migration Entity Type to filter by. |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
{- "migrationOperations": [
- {
- "id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
- "userId": "0db8f753-6864-452c-9b49-5362a20188b5",
- "entityType": "authority",
- "operationType": "remapping",
- "status": "new",
- "totalNumOfRecords": 10000
}, - {
- "id": "46669e09-8b45-4ede-afbd-ca73bb89cdb3",
- "userId": "0db8f753-6864-452c-9b49-5362a20188b5",
- "entityType": "instance",
- "operationType": "remapping",
- "status": "new",
- "totalNumOfRecords": 50000
}
], - "totalRecords": 2
}Creates a new MARC migration operation for the specified entity type and operation type.
| X-Okapi-Tenant required | string Example: diku Tenant ID |
| entityType required | string (EntityType) Enum: "authority" "instance" Type of MARC entity being migrated. |
| operationType required | string (OperationType) Enum: "remapping" "import" Type of migration operation to perform. |
{- "entityType": "authority",
- "operationType": "remapping"
}{- "id": "474d0af6-028f-4d15-8354-d2fc10c71a68",
- "userId": "0db8f753-6864-452c-9b49-5362a20188b5",
- "entityType": "authority",
- "operationType": "remapping",
- "status": "new",
- "totalNumOfRecords": 10000
}Retries MARC migration operations for the specified chunk IDs.
| operationId required | string <uuid> Example: 774d0af6-028f-4d15-8354-d2fc10c71a77 The UUID of a MARC migration operation. |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
[- "574d0af6-028f-4d15-8354-d2fc10c71a07",
- "074d0af6-028f-4d15-8354-d2fc10c71a08"
]{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "entityType": "authority",
- "operationType": "remapping",
- "status": "data_mapping",
- "totalNumOfRecords": 0,
- "mappedNumOfRecords": 0,
- "savedNumOfRecords": 0,
- "startTimeMapping": "2019-08-24T14:15:22Z",
- "endTimeMapping": "2019-08-24T14:15:22Z",
- "startTimeSaving": "2019-08-24T14:15:22Z",
- "endTimeSaving": "2019-08-24T14:15:22Z"
}Retry saving MARC migration operations for the specified chunk IDs.
| operationId required | string <uuid> Example: 884d0af6-028f-4d15-8354-d2fc10c71a88 The UUID of a MARC migration operation. |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
[- "584d0af6-028f-4d15-8354-d2fc10c71a08",
- "884d0af6-028f-4d15-8354-d2fc10c71a08"
]{- "message": "Invalid UUID format",
- "type": "IllegalArgumentException",
- "parameters": [
- {
- "key": "operationId",
- "value": "invalid-uuid-format"
}
]
}Retrieves a specific MARC migration operation by its unique identifier.
| operationId required | string <uuid> Example: 474d0af6-028f-4d15-8354-d2fc10c71a68 The UUID of a MARC migration operation |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
{- "id": "474d0af6-028f-4d15-8354-d2fc10c71a68",
- "userId": "0db8f753-6864-452c-9b49-5362a20188b5",
- "entityType": "authority",
- "operationType": "remapping",
- "status": "data_mapping",
- "totalNumOfRecords": 10000,
- "mappedNumOfRecords": 5000,
- "startTimeMapping": "2023-01-15T10:30:00.000Z"
}Save results of the MARC migration operation.
| operationId required | string <uuid> Example: 474d0af6-028f-4d15-8354-d2fc10c71a68 The UUID of a MARC migration operation. |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
| status required | string (MigrationOperationStatus) Enum: "new" "data_mapping" "data_mapping_completed" "data_mapping_failed" "data_saving" "data_saving_completed" "data_saving_failed" Current status of the migration operation. |
| publishEvents | boolean Default: true A flag that indicates if domain events should be published when the operation is updated. |
{- "status": "data_mapping",
- "publishEvents": true
}{- "message": "Invalid UUID format",
- "type": "IllegalArgumentException",
- "parameters": [
- {
- "key": "operationId",
- "value": "invalid-uuid-format"
}
]
}Combines all error records in one report.
| operationId required | string <uuid> Example: 474d0af6-028f-4d15-8354-d2fc10c71a68 The UUID of a MARC migration operation |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
{- "message": "Invalid UUID format",
- "type": "IllegalArgumentException",
- "code": "validation_error",
- "parameters": [
- {
- "key": "operationId",
- "value": "invalid-uuid-format"
}
]
}Retrieves a list of error reports for a specific migration operation with pagination.
| operationId required | string <uuid> Example: 474d0af6-028f-4d15-8354-d2fc10c71a68 The UUID of a MARC migration operation |
| offset | integer [ 0 .. 1000 ] Default: 0 Skip over a number of error reports by specifying an offset value for the query. |
| limit | integer [ 0 .. 1000 ] Default: 100 Limit the number of error reports returned in the response. |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
{- "errorReports": [
- {
- "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
- "chunkId": "string",
- "stage": "string",
- "chunkStatus": "string",
- "recordId": "string",
- "errorMessage": "string"
}
]
}Provides the current status of error report generation for a specific migration operation.
| operationId required | string <uuid> Example: 474d0af6-028f-4d15-8354-d2fc10c71a68 The UUID of a MARC migration operation |
| X-Okapi-Tenant required | string Example: diku Tenant ID |
{- "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
- "status": "not_started"
}