Access export files you have configured in PageUp's system for integrations
All scopes for endpoints on this page are listed below. The authentication page has further scope usage information.
HTTP | Endpoint | Scope |
---|---|---|
GET | Exporter | Public.Exporter.Read |
POST | Exporter | Public.Exporter.Write |
Root URL:
https://{environment}.{dataCentreId}.pageuppeople.com/v3/{tenantId}/platform/
environment = 'api' for LIVE or 'apiuat' for UAT
dataCentreId = the data centre to connect to (e.g. dc2)
tenantId = the organisation's tenant Id
Examples:
LIVE 6784 environment for dc2: https://api.dc2.pageuppeople.com/v3/6784/platform/...
UAT 6784 environment for dc5: https://apiuat.dc5.pageuppeople.com/v3/6784/platform/...
GET [endpoint_url]/Exporter/{exportReference}/ExportFiles
Where:
{exportReference}
= the unique reference for a given export (e.g. 'NewHire') - see Prerequisites above if you are not sure what this should beThe response returned in Step 1 will contain an array of files that have not yet been marked as processed:
[
{
"id": 0,
"fileName": "string",
"downloadUrl": "string",
"urlExpiration": "string"
}
]
For each file in the array:
downloadUrl
attribute to retrieve each file.urlExpiration
has passed before the URL is accessed, you may generate a new URL by returning to Step 1.id
attribute for that file and proceed to Step 3.POST [endpoint_url]/Exporter/{exportReference}/ExportFiles/{id}/MarkReceived
Where:
{exportReference}
= the unique reference used in Step 1{id}
= the id
attribute of the file from Step 2Once a given file has been marked as processed, it will no longer appear in the GET [endpoint_url]/Exporter/{exportReference}/ExportFiles
endpoint.
If for any reason a file needs to be downloaded after being marked as processed, this can be done provided the id
of the file is retained.
GET [endpoint_url]/Exporter/{exportReference}/ExportFiles/{id}
Where:
{exportReference}
= the unique reference for the export{id}
= the id
attribute of the fileThis will return a single-object array of the specified file, in the same format as seen in Step 2 of the Common workflow including the pre-authenticated S3 URL for download.