Salesforce

Go API endpoint: ProcessAPI

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

All URIs are relative to https://api.aiware.com/edge/v1

MethodHTTP requestDescription
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
11/21/2024 10:01 PM
11/21/2024 10:01 PM
11/21/2024 10:01 PM
Documentation
Documentation
000004338
Translation Information
English

Powered by