getAllScheduledExportsV1

get

https://webservices-test.net-chef.com/scheduledexport/v1/getAllScheduledExports

Retrieve a list of individual export files generated through Event Scheduling (Scheduled Exports) or manually in Outbound Integrations. Does not include files associated with managed partner integrations. Results may be used with the downloadScheduledExport endpoint to retrieve file contents, and with the markScheduledExport endpoint to update export file records to indicate that they have been downloaded.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

exportDate

string

Export Date to retrieve in format DD-MMM-YY.

exportStatus

string

Export Status to retrieve. If null, all Exports meeting the criteria of the Query Params will be returned. Statuses are: (1) Returns records for manually created exports; (2) Returns records for Scheduled Export files ready for download; (3) Returns records for Scheduled Export files already downloaded by CDP or any files “marked” as downloaded; (5) Returns records Marked as not successfully downloaded.

extractName

string

Export file type name to explicitly retrieve. These file type names appear in parentheses in the “Transaction Type” column in Outbound Integrations.

fileName

string

Specific export file name to explicitly retrieve. Use 4 or more characters for wildcard search. Note that these file names are not visible in the Outbound Integrations screen.

postDate

string

Post Date to retrieve in format DD-MMM-YY.

userIdForDetails

string

required

All export files are associated with a particular Application User's User ID. This is the value displayed in the “User” column in Outbound Integrations for the relevant file or file batch.

includeNull

boolean

Specify 'true' to output null data elements.

exportType

string

General export file type to explicitly retrieve. File types are: MAPPABLE_AP_TRANS_TYPE (Accounts Payable), MAPPABLE_SALES_TYPE (Sales), MAPPABLE_INVENTORY_TOTALS_TYPE (Inventory Totals), MAPPABLE_INVENTORY_DELTA_TYPE (Inventory Delta), MAPPABLE_LOC_TRANSFERS_TYPE (Location Transfers), MAPPABLE_AR_TRANS_TYPE (Accounts Receivable), MAPPABLE_CUSTOM_TRANS_TYPE (Custom Transactions), EMPLOYEE_MAINTENANCE (Employee Maintenance), MAPPABLE_EMPLOYEE_POS_TYPE (Employee POS), MAPPABLE_LABOR_SCHEDULE_TYPE (Labor Schedule), MAPPABLE_PAYROLL_TYPE (Payroll), USER_DEFINED (User Defined)

Headers

authenticationtoken

string

required

Secure token for API authentication.

password

string

required

Password for the Crunchtime Application User.

sitename

string

required

Crunchtime site identifier. (test or production)

userid

string

required

User ID for the Crunchtime Application User.

X-B3-TraceId

string

Optional trace identifier for troubleshooting.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Validation Error

401Authorization

404Scheduled export not found

429Too Many Requests

500Unexpected Error

503System under maintenance

504Timeout