List Files (v2)

This REST API lists the files in the repository and returns information about the available file and application snapshots.

This API provides details such as name, type, size and last modified time. Size and modified time are not available for LCM snapshots. See About EPM Automate in Working with EPM Automate.

Required Roles

Service Administrator

Any predefined role and the Migrations – Administer granular role

REST Resource

GET /interop/rest/v2/files/list

Supported Media Types: application/json

Request

Example URL

https://<BASE-URL>/interop/rest/v2/files/list

Response

Table 9-25 Parameters

Name	Description
Details	Will be published in case of error with the error string
Status	See Migration Status Codes
Items
Name	Name of the file or application snapshot
Type	Can be LCM or EXTERNAL Type signifies if this is an LCM snapshot or not. LCM indicates that the file is an LCM snapshot. EXTERNAL indicates that the file is not an LCM snapshot, such as a Planning file.
Size	Size of the file in bytes. Available only for type EXTERNAL
Lastmodifiedtime	Last modified time of the file in milliseconds since 1970-01-01.
Links	Detailed information about the link
Href	Link to API call/ status API
Action	The HTTP call type
Rel	Will be self
Data	null

Example of Response Body

{
	"status":0,
	"items":[{
		"name":"sample.csv",
		"type":"EXTERNAL",
		"size":"18",
		"lastmodifiedtime":"1422534438000"
		},{
		"name":"Artifact Snapshot",
		"type":"LCM",
		"size":null,
		"lastmodifiedtime":null
	}],
	"details":null,
	"links":[{
		"data":null,
		"action":"GET",
		"href": "https://<BASE-URL>/interop/rest/v2/files/list",
		"rel":"self"
	}]
}

Sample cURL command

curl -X GET -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 
'Content-Type: application/json' 'https://<BASE-URL>/interop/rest/v2/files/list'