APG PayAPG Paydocs

Reporting

Create exports

POST/exports

Export what a source reads: the file itself when it is small, otherwise an export that writes it.

Permissions

Required permission
reports:query

Requires the `query` action on `reports` for the supplied runtime context

Request body

This body is a tagged shape: type is always "ExptCmdRun". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "ExptCmdRun"
sourcestringrequired

What to export.

modeExptMode

Auto when absent.

AutoJobUnknown
curl -X POST https://api.tst.au.apgpay.dev/exports \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "ExptCmdRun",
  "source": "string",
  "parameters": [
    {
      "type": "ExptParameterAttributes",
      "name": "Ada Lovelace",
      "value": "string"
    }
  ],
  "mode": "Auto"
}'

Responses

Example response
"string"

Error responses