Introduction
APIs and Models to initiate, monitor, and control your automation jobs
API
Here are the list of APIs existing under Jobs category.
| API | Description |
|---|---|
| DeleteJobAsync | The API deletes an existing Job from the connected Control Room. |
| ExecuteJobAsync | The Smart Buddy executes an existing Job with provided job details from the connected Control Room. |
| GetAllAssistantBuddyJobsAsync | Gets the list of all Assistant Buddy JobsList information from the connected Control Room. |
| GetAllSmartBuddyJobsAsync | Gets the list of all Smart Buddy JobsList information from the connected Control Room. |
| GetJobInfoAsync | Gets the Job information with the specified Id from the connected Control Room. |
| GetJobStatusAsync | The API gets the job status with a specified Id from the connected Control Room. |
| GetJobsByAssistantBuddyIdAsync | The API gets the list of all jobs with specified Assistant Buddy Id from the connected Control Room. |
| GetJobsByBotIdAsync | The API gets the list of all jobs with specified Smart Buddy Id from the connected Control Room. |
| SubmitJobAsync | The API submits the job for execution with specified Smart or Assistant Buddy Id and other job details from the connected Control Room. |
| SuspendJobAsync | Suspends the job with specified SuspendedJobInfo details from the connected Control Room. |
Models
Here are list of Models used in Jobs APIs.
| Models | Description |
|---|---|
| JobInfo | The structure represents an instance of the Job entity. |
| JobsList | The structure represents an instance of the JobsList entity. |
| NewJobInfo | The structure represents an instance of the New Job entity. |
| SuspendedJobInfo | The structure represents an instance of Suspend Job entity. |
| ViewJobInfo | The structure represents an instance of the View Job entity. |
| JobDetails | The structure represents an instance of the Job detail entity. |
| JobStartInfo | The structure represents an instance of the Job Start entity. |