List Files (v2)

This REST API (v2) 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 for Oracle Enterprise Performance Management Cloud.

This REST API is version v2.

Required Roles

Service Administrator

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

REST Resource

GET /interop/rest/v2/files/list

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.

Example URL

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

Response

Table 9-26 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. Available only for type EXTERNAL
`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 Request 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":"Artifact Snapshot",
		"type":"LCM",
		"size":null,
		"lastmodifiedtime":null
	}],
	"details":null,
	"links":[{
		"data":null,
		"action":"GET",
		"href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/files/list",
		"rel":"self"
	}]
}

List Files Sample Code

Sample cURL command

curl -X GET -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' 'https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/files/list'

Common Functions