LCM Export (v2)

The LCM Export (v2) REST API initiates a repeat export of a Migration artifact based on the settings that were used to export artifacts using the Migration artifact export screen.

The presence of status -1 in the response indicates that the reexport is in progress. You should use the job status URI to determine whether the reexport is complete.

If the Job completes with status 1, the task details will be mentioned in the items from which the source, destination, and URL to fetch the first set of errors is available. All issues for a particular task can be fetched in the manner of pagination. Acceptable values for msgtype are: error/warn/info; limit represents the number of issues requested per request, and offset marks the beginning number to fetch the issues.

This API is version v2.

Required Roles

Service Administrator

Power User assigned to the Migration Administrator Profitability and Cost Management application role

Table 9-16 LCM Export

Task	Request	REST Resource
LCM Export	POST	/interop/rest/v2/snapshots/export
Export Status	GET	/interop/rest/v2/status/migration/28
Details	GET	/interop/rest/v2/status/migration/28/1/details?limit=25&offset=0&msgtype=info

REST Resource

POST /interop/rest/v2/snapshots/export

Supported Media Types: application/json

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

The following table summarizes the request parameters.

Table 9-17 Parameters

Name	Description	Type	Required	Default
SnapshotName	Application snapshot that has to be exported	Payload	Yes	None

Example URL and Payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/snapshots/export

{
    "snapshotName": "Artifact Snapshot"
}

Response

Supported Media Types: application/json

Parameters:

Table 9-18 Parameters

Attribute	Description
details	In case of errors, details are published with the error string
status	See Status Codes
links	Detailed information about the link
href	Links to API call
action	The HTTP call type
rel	Possible values. Can be self and/or Job Status. If set to Job Status, you can use the href to get the status of the re-export operation
data	Parameters as key value pairs passed in the request
items	Details about the resource
source	From where the navigation is being performed
destination	To where the navigation is being performed
name	Name of the task, usually "Task Information"
links	Details of the first URL to be requested to get the job details; rel is "Job Details"

Example of Response Body

The following is an example of the response body in JSON format.

Response 1 example when export is in progress:

{
    "details": null,
    "status": -1,
    "links": [
        {
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/snapshots/export",
            "action": "POST",
            "rel": "self",
            "data": null
        },
        {
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/migration/28",
            "action": "POST",
            "rel": "Job Status",
            "data": null
        }
    ]
} 

Response 2 example when export completes:

{
    "details": null,
    "status": 0,
    "items": [
        {
            "name": "Task Information",
            "source": "Shared Services",
            "destination": "/Artifact Snapshot1/HSS-Shared Services",
            "links": [
                {
                    "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/migration/28/0/details?limit=25&offset=0&msgtype=info",
                    "action": "GET",
                    "rel": "Job Details",
                    "data": null
                }
            ]
        },
        {
            "name": "Task Information",
            "source": "Vision",
            "destination": "/Artifact Snapshot1/HP-Vision",
            "links": [
                {
                    "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/migration/28/1/details?limit=25&offset=0&msgtype=info",
                    "action": "GET",
                    "rel": "Job Details",
                    "data": null
                }
            ]
        },
        {
            "name": "Task Information",
            "source": "Document Repository",
            "destination": "/Artifact Snapshot1/DOCREP-Document Repository",
            "links": [
                {
                    "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/migration/28/2/details?limit=25&offset=0&msgtype=info",
                    "action": "GET",
                    "rel": "Job Details",
                    "data": null
                }
            ]
        },
        {
            "name": "Task Information",
            "source": "Calculation Manager",
            "destination": "/Artifact Snapshot1/CALC-Calculation Manager",
            "links": [
                {
                    "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/migration/28/3/details?limit=25&offset=0&msgtype=info",
                    "action": "GET",
                    "rel": "Job Details",
                    "data": null
                }
            ]
        },
        {
            "name": "Task Information",
            "source": "FDM Enterprise Edition",
            "destination": "/Artifact Snapshot1/FDMEE-FDM Enterprise Edition",
            "links": [
                {
                    "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/migration/28/4/details?limit=25&offset=0&msgtype=info",
                    "action": "GET",
                    "rel": "Job Details",
                    "data": null
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/migration/28",
            "action": "GET",
            "rel": "self",
            "data": null
        }
    ]
}

Sample cURL command

curl -X POST -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H
'Content-Type: application/json' -d '{"snapshotName":"Artifact Snapshot"}'
'https://<SERVICE_NAME>-
<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/snapshots/export'