Cisco MediaSense Developer Guide, Release 11.0(1)
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- August 10, 2015
Chapter: Job Management APIs
Job Management APIs
Introduction
A job can contain one or more operations and takes a significant amount of time to complete. Each result is provided on a per-operation basis. The purpose of a job is to allow the system to accept and act on the job request without requiring a persistent client connection to the server until the job is completed.
You can create a MediaSense job by using the deleteSessions API, which creates a job in response to a bulk delete operation, where you may delete multiple sessions at the same time.
You can only delete a job that has already been completed, canceled, or in an error state. If the job is in the RUNNING state, use the cancelJob API to first stop the job and then use the deleteJob API to delete that job.
A job may not eventually be acted upon, as it might be disallowed during the processing phase. Use the Job Query APIs to retrieve the job status and operation results.
createJob
Use this API to create a batch process for jobs which take a significant amount of time to complete. The results are provided for each operation.
URI
https://<host>:<port>/ora/managementService/manage/createJob
HTTP Method
POST
Parameters
-
jobType— It is an input string. The type of the job. See Shared Parameters.
-
jobParameters— It is a system-generated identifier for a session. See Shared Parameters.
 Note | See Job States. |
cancelJob
Use this API to cancel a job that is already in progress. This API only stops the execution of a job. To delete the job from the database, use the deleteJob API.
URI
https://<host>:<port>/ora/managementService/manage/cancelJob
Parameter
jobId— It is an output string. This is a system-generated job ID. See Shared Parameters.
HTTP Method
POST
Example
HTTPS POST:
https://10.194.118.1:8440/ora/managementService/manage/cancelJob
Headers:
Content-Type: application/json JSESSIONID: <the jsessionId received from a signIn request>
Body:
{
"requestParameters": {
"jobId": "123456789"
}
}
Response:
{
"responseMessage": "Success: Your request was successfully completed.",
"responseCode": 2000,
"jobId": "123456789"
}
deleteJob
Use this API to delete a job from the database. This API is only applicable to a job that is already completed, canceled, or in an error state. If the job is in the RUNNING state, use the cancelJob API to first stop the job, and then use the deleteJob API to delete that job. This API deletes job details and all job results from the database.
URI
https://<host>:<port>/ora/managementService/manage/deleteJob
HTTP Method
POST
Parameter
jobId— It is an output string. This is a system-generated job ID. See Shared Parameters.
Example
HTTPS POST:
https://10.194.118.1:8440/ora/managementService/manage/deleteJob
Headers:
Content-Type: application/json JSESSIONID: <the jsessionId received from a signIn request>
Body:
{
"requestParameters": { "jobId": "JobId_1" }
}
Response:
{ "responseMessage": "Success: Your request was successfully
completed.", "responseCode": 2000, "jobId": "JobId_1" }
Feedback