Job

Returns jobs by business unit

This call will return a list of jobs for the specified business unit.

Securitybearer
Request
query Parameters
businessUnitId
string <uuid>

Filter by business unit id. If omitted, returns all jobs.

jobStatus
string (JobStatus)

Filter by job status. If omitted, returns all jobs.

Enum: "undefined" "active" "completed" "discontinued" "inactive"
Responses
get/api/v1/jobs
Request samples 
Response samples 
application/json
[
  • {
    }
]
Upserts multiple jobs
This call will add a list of jobs to update/insert to a queue to be ultimately processed.


Securitybearer 
Request 
Request Body schema: 
required
Set of parameters for the jobs request. The source job must have less than 100 cost codes.


businessUnitId
string or null <uuid> 
Business Unit ID


 
canOverwrite
boolean or null
Can overwrite flag


 
Array of objects or null (CopyJobSetupOption) 
The options for what setups to copy from the source job


 
sourceJobId
string or null <uuid> 
The source job id to copy.


 
sourceFile
string or null
Name of the file used for upload.


 
Array of objects or null (ApiJobWrite)   <= 10000 items 
List of jobs to be created.


 
Responses 
patch/api/v1/jobs
Request samples 
{
  • "sourceFile": "Myfile.txt",
  • "jobs": [
    ],
  • "businessUnitId": "5e9ac81e-91bc-45ff-b9af-5a4680d48a37",
  • "canOverwrite": true
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
Returns jobs by jobs or job tags
This call will return a list of jobs for the specified jobs or job tags.


Securitybearer 
Request 
Request Body schema: 
Set of filters for the request.


jobIds
Array of strings or null <uuid> 
List of Job Ids.


 
jobTagIds
Array of strings or null <uuid> 
List of Job Tag Ids.


 
isDeleted
boolean or null
Filter for deleted flag.


 
isIncludeHBCodeList
boolean
Flag to include/exclude HBCode list.


 
jobStatuses
Array of strings or null (JobStatus) 
Filter on job status.


 Enum: "undefined" "active" "completed" "discontinued" "inactive"  
Responses 
post/api/v1/jobs/advanced
Request samples 
{
  • "jobIds": [
    ],
  • "jobTagIds": [
    ],
  • "isIncludeHBCodeList": false
}
Response samples 
application/json
[
  • {
    }
]