Get Information About All Application Snapshots
This API returns information about all application snapshots that are available in an Planning instance. It provides details such as name, type, size, and last modified time. Type signifies whether it is a Migration snapshot or an external snapshot. Size and last modified time are not available for Migration type snapshots.
This API is version 11.1.2.3.600.
Required Roles
Service Administrator
REST Resource
GET /interop/rest/{api_version}/applicationsnapshots
Response
Supported Media Types: application/json
Table 9-48 Parameters
Name | Description |
---|---|
api_version |
Specific API version |
details |
In case of errors, details are published with the error string |
status |
See Migration Status Codes |
items |
Detailed information about the API |
name |
Name of the application snapshot |
type |
Possible values: LCM , EXTERNAL |
size |
Size of the application snapshot in bytes. Available only for type EXTERNAL |
lastmodifiedtime |
Time in Long value as per the last modified time of the file. Will be available only for type EXTERNAL |
links |
Detailed information about the link |
href |
Links to API call |
action |
The HTTP call type |
rel |
Possible value: self |
data |
Parameters as key value pairs passed in the request |
Example of Response Body
The following shows an example of the response body in JSON format.
{
"status":0,
"items":[{
"name":"sample.csv",
"type":"EXTERNAL",
"size":"18",
"lastmodifiedtime":"1422534438000"
},{
"name":"snapshot1",
"type":"LCM",
"size":null,
"lastmodifiedtime":null
}],
"details":null,
"links":[{
"data":null,
"action":"GET",
"href":"https://<BASE URL>/interop/rest/11.1.2.3.600/applicationsnapshots",
"rel":"self"
}]
}
Common Functions