CRcrunchtime
Scheduled Export Service

downloadScheduledExportV2

Changed on

Download Scheduled Exports.

get/scheduledexport/v2/downloadScheduledExport

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/scheduledexport/v2/downloadScheduledExport
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

batchNumberstring

Batch Number of the export file to download. Obtained from ‘getAllScheduledExports’.

exportTypestring

Export file type of the export file to download. Obtained from ‘getAllScheduledExports’. Required when "include" parameter is EXPORT or BOTH.

extractHistoryIdstring required

Unique file identifier of the export file to download. Obtained from ‘getAllScheduledExports’.

include'EXPORT' | 'ATTACHMENT' | 'BOTH'

Type of data to include in the response.

includeFileContentboolean

Include export file content in the response when true.

includeFileJsonboolean

Include export file content parsed as a structured JSON in the response when true.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

extractHistoryIdinteger

"extractHistoryId" from scheduled export

exportType'EMPLOYEE_MAINTENANCE' | 'EPICOR_PLATINUM' | 'INVENTORY_TOTALS' | 'MAPPABLE_AP_TRANS_TYPE' | 'MAPPABLE_AR_TRANS_TYPE' | 'MAPPABLE_CUSTOM_TRANS_TYPE' | 'MAPPABLE_EMPLOYEE_POS_TYPE' | 'MAPPABLE_INVENTORY_DELTA_TYPE' | 'MAPPABLE_INVENTORY_TOTALS_TYPE' | 'MAPPABLE_LABOR_SCHEDULE_TYPE' | 'MAPPABLE_LOC_TRANSFERS_TYPE' | 'MAPPABLE_PAYROLL_TYPE' | 'MAPPABLE_SALES_TYPE' | 'MAPPABLE_STANDARD_AP_TYPE' | 'PAYROLL' | 'SALES' | 'STANDARD_AP' | 'STANDARD_INVENTORY_DELTA' | 'STANDARD_LOCATION_TRANSFERS' | 'USER_DEFINED'

"exportType" from scheduled export

fileNamestring

"fileName" from scheduled export

fileJsonobject[]

Export file content parsed as a structured JSON. Returned when includeFileJson is true.

fileContentstring

"fileContent" from scheduled export. Returned when includeFileContent is true.

Example response

{
  "extractHistoryId": 1650348,
  "exportType": "MAPPABLE_AP_TRANS_TYPE",
  "fileName": "NSAPSUPERSET,06302023,052420.txt",
  "attachments": [
    {
      "fileName": "IMG_6717.JPG",
      "fileDescription": "TEST",
      "vendorInvoiceNumber": "91",
      "vendorCode": "KATSIR",
      "locationExportCode": "0409",
      "vendorExportCode": "VREIN15"
    }
  ],
  "fileContent": "Ww0KICAgIHs"
}

Changes