3.4.9 Object Migration
Object Migration is the process of migrating or moving objects between environments.
You may want to migrate objects for several reasons such as managing global deployments on multiple environments or creating multiple environments so that you can separate the development, testing, and production processes.
Object Migration Rest Endpoints to support Migration of Object available in MMG
Table 3-1 Object Migration Rest Endpoints to support Migration of Object available in MMG
Sr No | Object Migration API | Technical Standards to Follow | Method | Endpoint | Sample Request | Sample Response |
---|---|---|---|---|---|---|
1 | Save Export Definition | Headers: ofs_workspace_id ofs_remote_user locale (default set as en-US) | POST | /v1/public/migrate/export/outline | { "migrationCode":"testexp42", "exportObjects":[ {"objectCode":"TEST_population", "objectType":"BATCH" } ]} | output success-> { "response": { "message": "Migration outline definition saved successfully." } } output failed -> { "migrationCode": "testexp42", "errorMessage": "objectCode/Type missing", "statusCode": "INVALID_INPUT", "status": "FAILED" } |
2 | Invoke Export | Headers: ofs_workspace_id ofs_remote_user locale (default set as en-US) | POST | /v1/public/migrate/export/{code} | { "response": { "message": "Object Migration Triggered Successfully" } } | |
3 | Save Import Definition | Headers: ofs_workspace_id ofs_remote_user locale (default set as en-US) | POST | /v1/public/migrate/import/outline | { "migrationCode":"imp1_exp41", "fileName":"TEST_TESTEXP41_06082024_680336", "code":"imp1_exp41" } | { "response": { "message": "Migration outline definition saved successfully." } } |
4 | Invoke Import | Headers: ofs_workspace_id ofs_remote_user locale (default set as en-US) | POST | /v1/public/migrate/import/{code} | { "response": { "message": "Object Migration Triggered Successfully" } } |
All APIs should be invoked through Gateway port, if enabled, and UI port, if not enabled. Auth should be the bearer token, which is same as OFS_AAI.