Sign in

v1

latestOpenAPI 3.1.0BurstIQ, Inc.2026-08-04171112158.2 KB
Job Manager APIs

<b>Allowed user roles:</b><br/><ul><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>queries data and produces a file; can be SFTP'ed or for downloaded as an async job. Supported file formats are CSV, PIPE, TAB, XLSX, and JSON. Warning: Care is needed when using CSV as there can be issues when the data is variable, complex and/or not fixed columns

post/api/jobs/download

Request body

titlestring
descriptionstring
filePasswordstring
sftpUrlstring
sftpUsernamestring
sftpPasswordstring
emailResultsTostring[]
fileType'CSV' | 'PIPE' | 'TAB' | 'XLS' | 'XLSX' | 'XLSM' | 'EDI' | 'JSON' | 'XML' | 'PARQUET' | 'SPSS'
tqlstring required

Response

OK

jobIdstring uuid required
namestring required
status'NEW' | 'QUEUED' | 'RUNNING' | 'CANCELLED' | 'COMPLETED_ERROR' | 'COMPLETED_SUCCESS' | 'INCOMPLETE_ERROR' required
jobCreatedstring date-time required
jobQueuedstring date-time
jobStartedstring date-time
jobCompletedstring date-time
emailRecipientsstring[]
timeoutinteger
timeoutUnit'NANOSECONDS' | 'MICROSECONDS' | 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS' required
customerNamestring required
sdzNamestring required
effectiveIdstring uuid required
loggedInIdstring uuid required
mdcobject required
fileType'CSV' | 'PIPE' | 'TAB' | 'XLS' | 'XLSX' | 'XLSM' | 'EDI' | 'JSON' | 'XML' | 'PARQUET' | 'SPSS'
titlestring
descriptionstring
passwordstring
sftpUrlstring
sftpUsernamestring
sftpPasswordstring
keystring
tqlstring