Sign in

v1

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

<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>load (upsert) a dictionary into the SDZ using 1) POST with JSON body with dictionary and emailResultsTo (optional); or 2) MULTIPART POST with dictionary file and emailResultsTo (optional) as form fields

post/api/jobs/dictionary

Query parameters

emailResultsTostring[]

Request body

emailResultsTostring[]

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
originalFilenamestring
keystring
dictNamestring