Salesforce

Bash API endpoint: ProcessAPI

« Go Back
Information
Bash API endpoint: ProcessAPI
000006257
Public
Product Selection
aiWare - API
Article Details

All URIs are relative to /edge/v1

addTaskPOST /proc/job/{JobID}/addtaskAdds a Task to a current job
addTaskRoutePOST /proc/job/{JobID}/addtaskrouteAdds a Task Route to a current job
cancelJobsPOST /proc/jobs/cancelThis cancels jobs
createJobPOST /proc/job/createThis creates a new Job
deleteJobPOST /proc/job/{JobID}/deleteThis API deletes the specified job
deleteScheduledJobPOST /proc/scheduled_job/{ScheduledJobID}/deleteThis deletes a scheduled job
deleteTaskPOST /proc/task/{TaskID}/deleteThis API deletes the specified task
getEngineErrorTimeRangesGET /proc/tasks/error/engine_error_time_rangesThis gets engine error count by error tasks grouped by time ranges and sorted by a range start time
getJobDetailGET /proc/job/{JobID}/detailGets Job Detail
getJobDownloadGET /proc/job/{JobID}/download/{JobOutputName}Returns the contents of the job's output
getJobOutputGET /proc/job/{JobID}/output/{JobOutputName}Returns the contents of the job's output
getJobOutputsGET /proc/job/{JobID}/outputsReturns a list of output information about this job
getJobPerformanceGET /proc/job/{JobID}/performanceThis gets cpu/gpu, memory state of the hosts grouped by time ranges and sorted by a range start time
getJobStatusGET /proc/job/{JobID}/statusGets Job Status
getJobWorkRequestsGET /proc/job/{JobID}/workrequestsThis provides a list of workrequests of a job
getJobsGET /proc/jobsThis gets a list of jobs
getJobsOrganizationStatsGET /proc/jobs/stats/organizationThis gets processing stats of the jobs by organization
getJobsPerformanceGET /proc/jobs/performanceThis gets cpu/gpu, memory state of the hosts grouped by time ranges and sorted by a range start time
getJobsStatsGET /proc/jobs/statsThis gets processing stats of the jobs
getJobsTimeRangesStatsGET /proc/jobs/stats/time_rangesThis gets processing stats of the jobs grouped by time ranges and sorted by a range start time
getRatePendingScheduledJobsGET /proc/scheduled_jobs/rate_pending_time_rangesThis gets the rate of pending scheduled jobs by time ranges
getScheduledJobDetailGET /proc/scheduled_job/{ScheduledJobID}/detailThis gets scheduled job detail
getScheduledJobsGET /proc/scheduled_jobsThis gets a list of scheduled jobs
getServerErrorCountsGET /proc/tasks/error/server_error_countsGet server error counts in a time-range
getTaskDetailGET /proc/task/{TaskID}/detailGets Task Detail
getTaskDownloadGET /proc/task/{TaskID}/download/{TaskOutputName}Returns the contents of the task's output
getTaskLogsGET /proc/task/{TaskID}/logsGets logs associated with a task
getTaskOutputGET /proc/task/{TaskID}/output/{TaskOutputName}Returns the contents of the task's output
getTaskOutputsGET /proc/task/{TaskID}/outputsGets Task Output
getTaskReportsGET /proc/task/reportsGets task reports
getTaskReportsPerMonthGET /proc/task/reports/{ReportMonth}Gets task reports for the month
getTaskSyncBacklogGET /proc/tasks/sync_backlogGets task sync backlog in a time-range
getTaskTimingsGET /proc/task/{TaskID}/timingsReturns the timings associated with a task as collected by engine toolkit.
getTasksGET /proc/tasksThis gets a list of tasks based on the provided criteria
getTasksErrorTypeCountByEngineGET /proc/tasks/error/count_type_by_engineThis gets error type count by engines
getTasksErrorsGET /proc/tasks/errorsThis provides a error list in a time range
getTasksInstancesGET /proc/tasks/instances/by_category_hostThis gets processing stats of the tasks
getTasksStatsGET /proc/tasks/statsThis gets processing stats of the tasks
getTasksStatsCategoriesGET /proc/tasks/stats/categoriesThis gets processing stats of the tasks grouped by engine categories
getTasksStatsEnginesGET /proc/tasks/stats/enginesThis gets processing stats of the tasks grouped by engine
getTasksStatsOrganizationsGET /proc/tasks/stats/organizationsThis gets processing stats of the tasks grouped by engine, filter by organizations
getTasksStatsTimeRangesGET /proc/tasks/stats/time_rangesThis gets processing stats of the tasks grouped by time ranges and sorted by a range start time
getTotalPendingScheduledJobsGET /proc/scheduled_jobs/total_pending_time_rangesThis gets the total pending scheduled jobs by time ranges
getWorkRequestGET /proc/workrequest/{WorkRequestID}/detailThis provides detail of workrequest
launchJobTemplatePOST /proc/template/{TemplateID}/launchThis launch a job based on the given job template
listTaskReportsGET /proc/task/listreportsGets a list of task report links
pushContentToEndpointPOST /proc/endpoint/{Endpoint}Whatever is posted to this endpoint will be added to the child input folder(s) for the task_routes that have this endpoint. If more than one task_routes have this endpoint, it will be added to all child input folders.
recheckJobStatusGET /proc/job/{JobID}/recheck_statusForce a recalculation of job status from tasks
tasksStatusExportGET /proc/tasks/stats/exportExport a task status report as a excel file
updateTaskStatusPOST /proc/tasks/update_statusThis updates the status for a bulk of tasks by taskID
Additional Technical Documentation Information
Properties
2/7/2025 10:46 PM
2/7/2025 10:47 PM
2/7/2025 10:47 PM
Documentation
Documentation
000006257
Translation Information
English

Powered by