v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB

CSV Export Job

Create a CSV export job

Create and return a CSV export job for the specified business id and branch id

post/api/business/{businessId}/branch/{branchId}/csvexportjob

Path parameters

businessIdstring required

branchIdstring required

Request body

jobIdstring

jobStatus'SCHEDULED' | 'RUNNING' | 'FAILED' | 'DONE'

startedstring date-time

Job start time

finishedstring date-time

Job end time

startFilterstring date

finishFilterstring date

filterExpressionstring

totalRowsinteger

succeededRowsinteger

tempCsvExternalUrlstring

Url to csv file generated

failureReasonstring

Example request

{
  "jobId": "abc-12345678",
  "filterExpression": "updated=<2018-01-31T23:59:59.999Z&updated=>2018-01-01T00:0:00.000Z",
  "totalRows": 530,
  "succeededRows": 492,
  "tempCsvExternalUrl": "https://eu1-mem.s3-eu-west-1.amazonaws.com/mem-prd/business/eTC3QY5W3p_HmGHezKfxJw/csvexport",
  "failureReason": "No records found"
}

Response

CSV export job created successfully