Cisco Cisco MediaSense Release 9.0(1) Developer's Guide
Job Query
Job Query
Use these APIs to retrieve the status and results for jobs created using the
APIs.
Add a New API
getJobById
getJobById
Description:
Use this API to retrieve existing jobs using the jobId.
In successful JSON response fields, the jobstate, operationsCompleted, and operationsRemaining parameter values
are retrieved at the time the API is called. Subsequent calls to this API may display different values.
In successful JSON response fields, the jobstate, operationsCompleted, and operationsRemaining parameter values
are retrieved at the time the API is called. Subsequent calls to this API may display different values.
API URI:
https://<host>:<port>/ora/queryService/query/getJobById
Supported
Response
Formats:
Response
Formats:
JSON
HTTP Method:
GET
Request
Parameters:
Parameters:
{
:
}
"jobId"
"<replace with your string>"
Header
Parameters:
Parameters:
JSESSIONID
Parameter
Description:
Description:
Go to the Go to the
.
Successful JSON
Response
Response
Schema:
{
: 2000
"responseCode"
:
”
"responseMessage"
"Successful"
: {
"responseBody"
:[{
"jobs"
:
,
"jobType" "<
is a string>"
this
:<
is an integer>,
"jobDuration"
this
:<
is an integer>,
"jobStartTime"
this
:
,
"jobId" "<
is a string>"
this
:
,
"jobState" "<
is a string>"
this
:<
is an integer>,
"operationsCompleted"
this
:<
is an integer>
"operationsRemaining"
this
}]
}
}
62