Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

/autoimport/export

This action exports a results file for an auto import.

To see if an auto import supports this API action, look at the api_capabilities field returned for the auto import in the response of the /autoimport/list API action.

Request

FieldDescriptionTypeRequired
autoimport_idUnique identifier for an auto importnumberYes
export_dateExport datestringYes

The meaning of the export_date depends on the auto import. For INS auto imports, the export date should be set to the date for the compiled PIR file.

Example:

{
  "autoimport_id": 80,
  "export_date": "2025-03-13"
}
curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -d '{"autoimport_id": 80, "export_date": "2025-03-13"}' \
     https://ppw.web/svc/autoimport/export

Response

FieldDescriptionType
file_nameFile name of the exported filestring
hashSHA256 hash of the file’s contentstring
contentFile content encoded as a base64 stringstring

Example successful response:

{
  "file_name": "PHHPIR93821-20250312014308",
  "hash": "e56fa2611cb6409c5df93758c89869d5b60eaa086e637a67bb3b8287694ffd35",
  "content": "SERSMDAyICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgMDUwMzI1ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgClBJUjAxODAyMzA2OTkzOCAgICAgICAgICAgICAgICAgQyAgICAgICAgQSAgMDExMDIyQU9DTi1DTFQgICAgICAgIE4gICAgICBETkEgICAgICAgICAgICAgICAgIEdDICAgICAgICBCICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIEQgIApQSVIwMjgwMjMwNjk5MzggICAgICAgIFlZTk5OTk5OWSAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIEw0M04gICAgICAgICAgVSAgICAgICAgICBVICAgICAgICAgIFUgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKUElSMDM4MDIzMDY5OTM4ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgMDAwMDAwMCAgClBJUjA0ODAyMzA2OTkzOCAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIApQSVIwNTgwMjMwNjk5MzggICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKUElSMDY4MDIzMDY5OTM4ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCkZFRTAxODAyMzA2OTkzOCAgICAgICAgICAgICAgICAgICAgICAgICAgICAgMDAwMDAwMTQgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDAwMDAwMDAwICAgICAgICAwMDAwMDAwMDAwMDAwMDE0ICAgICAgICAgIApUUkwwMTAwMjcxLTEwMTUyNDEgICAwMDAwMDAwMCAgICAgICAgICAgICAgICAgICAgICAgIDAwMDAwMDE0ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKVFJMMDIgICAgICAgICAgICAgICAgICAgICAgICAwMDAwMDAxNDAwMDAwMTAwMDAwMDAwMDAwMCAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCg=="
}

Errors

Error TypeDescriptionStatus Code
access_deniedAccess token is invalid or expired401
scope_invalidClient app does not have the required OAuth scope403
autoimport_invalidautoimport_id is invalid400
auto_import_inactiveAuto import is not active400
export_not_supportAuto import does not support export action400
export_date_requiredExport date is required for the export action400
export_date_invalidExport date is invalid400
pir_not_foundPIR not found for the given Export Date. Applicate to only INS auto imports400