Salesforce

Bash API endpoint: getScheduledJobs

« Go Back
Information
Bash API endpoint: getScheduledJobs
000007496
Public
Product Selection
aiWare - API
Article Details

This gets a list of scheduled jobs

Example

aiware getScheduledJobs X-Correlation-Id:value  startTime=value  endTime=value  offset=value  limit=value  direction=value  scheduledJobID=value  internalOrganizationID=value  coreID=value  startStartTime=value  endStartTime=value  startStopTime=value  endStopTime=value  isActive=value  runMode=value  sourceID=value  sourceType=value  orderBy=value  scheduledJobName=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]
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]
directionstringthe sort order. ASC or DESC.[optional] [default to DESC]
scheduledJobIDstringFilter by internal scheduled Job ID(uuid) or core scheduled Job ID (integer)[optional] [default to null]
internalOrganizationIDstringFilter by internal organization id[optional] [default to null]
coreIDstringFilter by coreID[optional] [default to null]
startStartTimeinteger[optional] [default to null]
endStartTimeinteger[optional] [default to null]
startStopTimeinteger[optional] [default to null]
endStopTimeinteger[optional] [default to null]
isActiveboolean[optional] [default to null]
runModeScheduleRunModeEnumFilter by runMode[optional] [default to null]
sourceIDinteger[optional] [default to null]
sourceTypestring[optional] [default to null]
orderBystringThe value should be in [organizationID, runMode, createdTime, startTime, stopTime][optional] [default to null]
scheduledJobNamestring[optional] [default to null]

Return type

GetScheduledJobsResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json
Additional Technical Documentation Information
Properties
2/6/2025 4:53 PM
2/6/2025 4:54 PM
2/6/2025 4:54 PM
Documentation
Documentation
000007496
Translation Information
English

Powered by