Salesforce

Bash API endpoint: getJobs

« Go Back
Information
Bash API endpoint: getJobs
000007485
Public
Product Selection
aiWare - API
Article Details

This gets a list of jobs

Example

aiware getJobs X-Correlation-Id:value  startTime=value  endTime=value  status=value  offset=value  limit=value  orderBy=value  direction=value  coreID=value  organizationID=value  recordingID=value  jobID=value  coreJobID=value  scheduledJobID=value  modifiedBefore=value  modifiedAfter=value  CreatedBefore=value  CreatedAfter=value

Parameters

NameTypeDescriptionNotes
xCorrelationIdstringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request[optional] [default to null]
startTimeintegerThe unix timestamp, describing the start time for the stats[optional] [default to null]
endTimeintegerThe unix timestamp, describing the end time for the stats[optional] [default to null]
statusJobStatusEnumIf specified, this limits the jobs or tasks to follow status[optional] [default to null]
offsetintegerthe number of data to skip before getting the result set[optional] [default to null]
limitintegerthe number of items to return.[optional] [default to 10]
orderBystringthe field to sort[optional] [default to createdDateTime]
directionstringthe sort order. ASC or DESC.[optional] [default to DESC]
coreIDstringFilter by coreID[optional] [default to null]
organizationIDstringFilter by organizationID[optional] [default to null]
recordingIDstringFilter by recordingID[optional] [default to null]
jobIDstringFilter by jobID[optional] [default to null]
coreJobIDstringFilter by coreJobID[optional] [default to null]
scheduledJobIDstringFilter by scheduledJobID(s) separated by commas[optional] [default to null]
modifiedBeforeintegerFilter by items modified before expressed as timestamp[optional] [default to null]
modifiedAfterintegerFilter by items modified after expressed as timestamp[optional] [default to null]
createdBeforeintegerFilter items where created date is before this date[optional] [default to null]
createdAfterintegerFilter items where created date is after this date[optional] [default to null]

Return type

GetJobListResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json
Additional Technical Documentation Information
Properties
2/5/2025 11:52 PM
2/5/2025 11:54 PM
2/5/2025 11:54 PM
Documentation
Documentation
000007485
Translation Information
English

Powered by