XPxpansiv
/fileRegistry

Query for a list of files which can be downloaded from the APX MarketSuite.

put/fileRegistry/listFiles

Request

Query parameters

intervalBeginstring date-time required

The expected format for the intervalBegin parameter is yyyy-mm-ddThh:mm:ss i.e 2016-10-08T00:00:00

intervalEndstring date-time required

The expected format for the intervalEnd parameter is yyyy-mm-ddThh:mm:ss i.e 2016-10-08T00:00:00

Request body

regionstring required

ISO code

participantstring required

APX MarketSuite participant code

fileTypestring required

APX MarketSuite File Type Name

sourcestring required

Data source system

renditionstring required

Type of data in the file, such as DA or RT

latestVersionOnlyboolean required

Flag indicating whether or not to list the most recent version of a file. True means list the most recent version only. False means list all versions. The default is true.

Response

List of files which can be downloaded from the APX MarketSuite

locationstring

Location associated with the file. Generally refers to the ISO or region

participantstring

APX MarketSuite participant code

intervalBeginstring

DateTime value of interval_begin that was specified when the file was uploaded or otherwise registered. This is not necessarily true for the content of the file. Format - yyyy-mm-ddThh:mm:ss

intervalEndstring

Datetime value of interval_end that was specified when the file was uploaded or otherwise registered. This is not necessarily true for the content of the file. Format - yyyy-mm-ddThh:mm:ss

sourcestring

Data source system

renditionstring

Type of data in the file, such as DA or RT

fileTypestring

APX MarketSuite File Type Name

fileVersioninteger

Version of the file instance within the APX MarketSuite for the same business keys

fileStructureVersionnumber

The version of the structure of the file

fileFormatstring

The format of the file (CSV, XML, etc.)

fileHandlestring

Unique identifier for the file within the APX MarketSuite

createDatestring

Datetime the file was created in the APX MarketSuite

Changes

No recorded changes to this operation across all 1 revision of this API.