Skip to content
Xpansiv Power (formerly A...
/
/
/
Query for a list of files...

File Registry API API (1.1.49)

Download OpenAPI description
pm-file-api.v1.openapi.json
pm-file-api.v1.openapi.yaml
Languages
Servers
Generated server url
https://pm-file-api.apx.com/

/fileRegistry

the File Registry REST API

Operations

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

Request

Query
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

Bodyapplication/jsonrequired
regionstringrequired

ISO code

participantstringrequired

APX MarketSuite participant code

fileTypestringrequired

APX MarketSuite File Type Name

sourcestringrequired

Data source system

renditionstringrequired

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

latestVersionOnlybooleanrequired

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.

curl -i -X PUT \
  'https://pm-file-api.apx.com/fileRegistry/listFiles?intervalBegin=2019-08-24T14%3A15%3A22Z&intervalEnd=2019-08-24T14%3A15%3A22Z' \
  -H 'Content-Type: application/json' \
  -d '{
    "region": "string",
    "participant": "string",
    "fileType": "string",
    "source": "string",
    "rendition": "string",
    "latestVersionOnly": true
  }'

Responses

List of files which can be downloaded from the APX MarketSuite

Bodyapplication/jsonArray [
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(int32)

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

]
Response
application/json
[
  {
    "location": "string",
    "participant": "string",
    "intervalBegin": "string",
    "intervalEnd": "string",
    "source": "string",
    "rendition": "string",
    "fileType": "string",
    "fileVersion": 0,
    "fileStructureVersion": 0,
    "fileFormat": "string",
    "fileHandle": "string",
    "createDate": "string"
  }
]

Query for a list files which can be downloaded from the APX MarketSuite which have changed since the specified date.

Request

Query
watermarkDatestring(yyyy-mm-ddThh:mm:ss)required

The expected format for the watermarkDate parameter is yyyy-mm-ddThh:mm:ss

Example: watermarkDate=2019-10-08T00:00:00
Bodyapplication/jsonrequired
regionstringrequired

ISO code

participantstringrequired

APX MarketSuite participant code

fileTypestringrequired

APX MarketSuite File Type Name

sourcestringrequired

Data source system

renditionstringrequired

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

latestVersionOnlybooleanrequired

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.

curl -i -X PUT \
  'https://pm-file-api.apx.com/fileRegistry/listFilesSince?watermarkDate=2019-10-08T00%3A00%3A00' \
  -H 'Content-Type: application/json' \
  -d '{
    "region": "string",
    "participant": "string",
    "fileType": "string",
    "source": "string",
    "rendition": "string",
    "latestVersionOnly": true
  }'

Responses

List files which can be downloaded from the APX MarketSuite which have changed since the specified date

Bodyapplication/jsonArray [
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(int32)

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

]
Response
application/json
[
  {
    "location": "string",
    "participant": "string",
    "intervalBegin": "string",
    "intervalEnd": "string",
    "source": "string",
    "rendition": "string",
    "fileType": "string",
    "fileVersion": 0,
    "fileStructureVersion": 0,
    "fileFormat": "string",
    "fileHandle": "string",
    "createDate": "string"
  }
]

Query for ISO Scheduling data with current status.

Request

Path
fileNamestringrequired

Returned file name

Bodyapplication/jsonrequired
regionstringrequired
marketParticipantsArray of stringsrequired
marketStagestringrequired
marketStatusstringrequired
firstIntervalBeginstring(date-time)
lastIntervalEndstring(date-time)
applicationsArray of stringsrequired
formatstring
Enum"xml""csv"
curl -i -X PUT \
  'https://pm-file-api.apx.com/fileRegistry/getScheduleData/{fileName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "region": "string",
    "marketParticipants": [
      "string"
    ],
    "marketStage": "string",
    "marketStatus": "string",
    "firstIntervalBegin": "2019-08-24T14:15:22Z",
    "lastIntervalEnd": "2019-08-24T14:15:22Z",
    "applications": [
      "string"
    ],
    "format": "xml"
  }'

Responses

ISO Scheduling data with current status

Body*/*Array [
string(byte)
]
Response
No content

Upload a file to the APX MarketSuite

Request

Bodymultipart/form-data
uploadFileDescriptionobject(UploadFileDescription)

UploadFileDescription

filestring(binary)
curl -i -X POST \
  https://pm-file-api.apx.com/fileRegistry/file \
  -H 'Content-Type: multipart/form-data' \
  -F 'uploadFileDescription[location]=string' \
  -F 'uploadFileDescription[participant]=string' \
  -F 'uploadFileDescription[intervalBegin]=2019-08-24T14:15:22Z' \
  -F 'uploadFileDescription[intervalEnd]=2019-08-24T14:15:22Z' \
  -F 'uploadFileDescription[fileType]=string' \
  -F 'uploadFileDescription[source]=string' \
  -F 'uploadFileDescription[rendition]=string' \
  -F file=string

Responses

A files unique identifier (filehandle).

Body*/*
string
Response
No content

Download a specific file from the APX MarketSuite based on the files unique identifier (filehandle).

Request

Path
fileHandlestringrequired

The file identifier that has been returned by the /file function

curl -i -X GET \
  'https://pm-file-api.apx.com/fileRegistry/file/{fileHandle}'

Responses

A file from the APX MarketSuite based on the files unique identifier (filehandle)

Body*/*Array [
string(byte)
]
Response
No content

Get scheduling data validation errors for an uploaded ISO Scheduling file based on the files unique identifier (filehandle).

Request

Path
fileHandlestringrequired

A files unique identifier (filehandle).

curl -i -X GET \
  'https://pm-file-api.apx.com/fileRegistry/file/{fileHandle}/status'

Responses

A file from the APX MarketSuite based on the files unique identifier (filehandle)

Body*/*Array [
string(byte)
]
Response
No content

/reporting

the Reporting REST API

Operations