Steps required to execute a migration.

https://docs.fenergox.com/developer-hub/data-migration/overview-and-guidelines

POST https://api.fenergox.com/datamigrationcommand/api/v2/migration
​
​Doc Portal: Create a Migration Instance

A migration instance holds and controls the data flow.

Migration instances are the starting point for any migration. After this instance is created, data can be attached to it and pushed to the supported domains.

The above API command returns the migration instance Id to be used by the rest of the commands.

GET https://api.fenergox.com/datamigrationquery/api/migration/{id}/get-artifacts
​
​Doc Portal: Get Available Artefacts List

This method gets the artefacts/files that have been uploaded and attached to the created data migration.

GET https://api.fenergox.com/datamigrationquery/api/migration/{id}/get-artifact-content

​Doc Portal: Get the Artefact Content

This method gets the content for a specified artefact. These files may be downloaded and have the content of the migration input for them to be added at the next stage

A schema file will also be returned with this request. This is useful. It lists all the characteristics of the policy components. This can be cross-referenced for potential conflicts with the data being migrated.

Input the migration data into the source files that are downloaded. Care should be taken not to add new columns or make modifications to the prescribed schema.

PUT https://api.fenergox.com/datamigrationcommand/api/v2/migration/{id}/add-file

​Doc Portal: Add files to existing data migration

This method adds the information about an artifact to an existing data migration which has been pre-created via the create migration method.

The method returns the signed URL to upload the file directly in the S3 bucket.

Files added should be based on the templates retrieved from the ‘Get Migration Artifacts’ step above.

PUT https://api.fenergox.com/datamigrationcommand/api/v2/migration/{id}/start

​Doc Portal: Start a migration

Starts a migration. It requires that the files have been already added to the migration using /add-file and that the migration instance has finished running preparation tasks.

Returns the migration instance Id to be used by the rest of the commands.

GET https://api.fenergox.com/datamigrationquery/api/migration/{id}

Doc Portal: Get migration metadata by id

This method gets the metadata information around a created migration including data around each stage and task like it’s status.

If there are issues with a migration job, an error file may be retrieved to

GET https://api.fenergox.com/datamigrationquery/api/migration/{id}/get-error-file

Doc Portal: Get error file

This method returns an error file for a specified data migration containing information on the failed records.

GET https://api.fenergox.com/datamigrationquery/api/migration/{id}/get-error-file-signed-url

​Doc Portal: Generates a signed URL for the migration error csv file

This method returns a signed URL pointing to the error file if it was generated.

Data Migration Troubleshooting with Paddy-20231211_160255-Meeting Recording.mp4