Page Comparison

...

• Registering a Migration Operation:

  Code Block
  POST /marc-migrations Content-Type: application/json X-Okapi-Token: <your_access_token> { "entityType": "authority", "operationType": "remapping" }

  This call registers a new MARC Migration operation. The operationId needed for subsequent calls will be provided in the response of this request. The entityType can be either "authority" or "instance" depending on the records being migrated.

• Tracking Migration Operation:

  Code Block
  GET /marc-migrations/{operationId} X-Okapi-Token: <your_access_token>

  Replace {operationId} with the ID received from the response of the POST call. This endpoint allows you to track the progress and status of an ongoing MARC Migration operation. Possible statuses include:

  • "new": The operation has been initialized but not yet started.

  • "data_mapping": The operation is currently mapping data.

  • "data_mapping_completed": Data mapping is complete.

  • "data_mapping_failed": Data mapping has failed.

  • "data_saving": Data is currently being saved.

  • "data_saving_completed": Data saving is complete.

  • "data_saving_failed": Data saving has failed.

• Initiating Data Saving Phase:

  Code Block
  PUT /marc-migrations/{operationId} Content-Type: application/json X-Okapi-Token: <your_access_token> { "status": "data_saving", "publishEvents": false }

  Use this call to initiate the data saving phase for a MARC Migration operation once the data mapping phase is complete. Ensure to replace {operationId} with the valid ID from your registered operation. publishEvents field defines if domain events should be published. On big datasets, it is suggested not to publish domain events but to use re-index to index changes introduced during migration, as it will be more performant.

Known Limitations

The MARC Migration system currently has several limitations that users should be aware of when planning and executing migrations:

...