Query the past run instances of a job. All request parameters are optional.
If no parameters are specified, If no parameters are specified, no run instances will be returned.. NBI filtering can be applied to the parameters to customize the query. Please refer the filtering page for the details of how to use filtering
Examples :
- get the run history of the job 123 --/jobService/runhistory?jobId=123
- get the run history of job 123 and job 456 between 2013-04-26T14:00:00 and 2013-04-26T16:00:00 -- /jobService/runhistory?jobId=in(123,456)&startTime=between("2013-04-26T14:00:00","2013-04-26T16:00:00")
- get all run history of jobs with job name starting with "BulkImport" -- jobService/runhistory?jobName=startsWith("BulkImport")
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v1/op/jobService/runhistory
Request Parameters
jobId
String
|
query
|
OptionalA job id to uniquely identify a job
|
jobType
String
|
query
|
OptionalA job type
|
jobName
String
|
query
|
OptionalA job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs
|
startTime
String
|
query
|
OptionalThe time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.
|
Response Parameters
description
String
|
|
jobId
long
|
The id of a job to uniquely identify a job
|
jobName
String
|
The name of a job. Job name and job type together should be unique.
|
jobStatus
JobSpecState
|
The status of a job
Allowed values:
SCHEDULED
COMPLETED
SUSPENDED
CANCELLED
PENDINGAPPROVAL
EXPIREDBEFOREAPPROVAL
UNDEFINED
|
jobType
String
|
|
nextRunTime
Date
|
The time when the job will be trigger next time
|
runInstances
RunInstance[]
|
A list of run instances of the job
|
completionTime
Date
|
|
lastStartTime
Date
|
|
resultStatus
ResultState
|
Allowed values:
UNKNOWN
SUCCESS
PARTIALSUCCESS
FAILURE
ROLLBACKED
CANCELFAILED
CANCELLED
PENDINGEXECUTION
|
results
PropertyAndValue[]
|
|
property
String
|
|
value
String
|
|
|
runId
long
|
|
runStatus
WorkState
|
Allowed values:
UNKNOWN
CREATED
RUNNING
COMPLETED
ABORTED
INTERRUPTED
CANCELLED
PENDING_EXECUTION
PAUSING
PAUSED
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/jobService/runhistory?jobType="Wireless System"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/jobService/runhistory?jobType=&quot;Wireless System&quot;" rootUrl="https://localhost/webacs/api/v1/op">
<job>
<description>String value</description>
<jobId>2</jobId>
<jobName>String value</jobName>
<jobStatus>SCHEDULED</jobStatus>
<jobType>String value</jobType>
<nextRunTime>2017-07-13T13:21:19.843-07:00</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2017-07-13T13:21:19.845-07:00</completionTime>
<lastStartTime>2017-07-13T13:21:19.846-07:00</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
</runInstances>
</job>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/jobService/runhistory.json?jobType="Wireless System"
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/jobService\/runhistory?jobType="Wireless System"",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"job" : {
"description" : "String value",
"jobId" : 2,
"jobName" : "String value",
"jobStatus" : "SCHEDULED",
"jobType" : "String value",
"nextRunTime" : "2017-07-13T13 : 21 : 19.843-07 : 00",
"runInstances" : {
"runInstance" : {
"completionTime" : "2017-07-13T13 : 21 : 19.845-07 : 00",
"lastStartTime" : "2017-07-13T13 : 21 : 19.846-07 : 00",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : {
"property" : "String value",
"value" : "String value"
}
},
"runId" : 2,
"runStatus" : "UNKNOWN"
}
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/jobService/runhistory
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobId
String
|
query
|
OptionalA job id to uniquely identify a job
|
jobType
String
|
query
|
OptionalA job type
|
jobName
String
|
query
|
OptionalA job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs
|
startTime
String
|
query
|
OptionalThe time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.
|
Response Parameters
description
String
|
|
jobId
long
|
The id of a job to uniquely identify a job
|
jobName
String
|
The name of a job. Job name and job type together should be unique.
|
jobStatus
JobSpecState
|
The status of a job
Allowed values:
SCHEDULED
COMPLETED
SUSPENDED
CANCELLED
PENDINGAPPROVAL
EXPIREDBEFOREAPPROVAL
UNDEFINED
|
jobType
String
|
|
nextRunTime
Date
|
The time when the job will be trigger next time
|
runInstances
RunInstance[]
|
A list of run instances of the job
|
completionTime
Date
|
|
lastStartTime
Date
|
|
resultStatus
ResultState
|
Allowed values:
UNKNOWN
SUCCESS
PARTIALSUCCESS
FAILURE
ROLLBACKED
CANCELFAILED
CANCELLED
PENDINGEXECUTION
|
results
PropertyAndValue[]
|
|
property
String
|
|
value
String
|
|
|
runId
long
|
|
runStatus
WorkState
|
Allowed values:
UNKNOWN
CREATED
RUNNING
COMPLETED
ABORTED
INTERRUPTED
CANCELLED
PENDING_EXECUTION
PAUSING
PAUSED
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/jobService/runhistory?jobType="Wireless System"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/jobService/runhistory?jobType=&quot;Wireless System&quot;" rootUrl="https://localhost/webacs/api/v2/op">
<job>
<description>String value</description>
<jobId>2</jobId>
<jobName>String value</jobName>
<jobStatus>SCHEDULED</jobStatus>
<jobType>String value</jobType>
<nextRunTime>2017-07-13T13:21:19.852-07:00</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2017-07-13T13:21:19.854-07:00</completionTime>
<lastStartTime>2017-07-13T13:21:19.854-07:00</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
</runInstances>
</job>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/jobService/runhistory.json?jobType="Wireless System"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/jobService/runhistory?jobType="Wireless System"",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"job" : [ {
"description" : "String value",
"jobId" : 2,
"jobName" : "String value",
"jobStatus" : "SCHEDULED",
"jobType" : "String value",
"nextRunTime" : 1499977279852,
"runInstances" : {
"runInstance" : [ {
"completionTime" : 1499977279854,
"lastStartTime" : 1499977279854,
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/jobService/runhistory
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobId
String
|
query
|
OptionalA job id to uniquely identify a job
|
jobType
String
|
query
|
OptionalA job type
|
jobName
String
|
query
|
OptionalA job name. Note: the system ensures the uniqueness of the combinatoin of job name and job type. There may be jobs with the same job name and differnt job types. Querying by a job name may result in run instances of multiple jobs
|
startTime
String
|
query
|
OptionalThe time when a job run instance starts. You must specify the date in in ISO-8601 format. Please refer the filtering page on how to using filtering based on dates.
|
Response Parameters
description
String
|
|
jobId
long
|
The id of a job to uniquely identify a job
|
jobName
String
|
The name of a job. Job name and job type together should be unique.
|
jobStatus
JobSpecState
|
The status of a job
Allowed values:
SCHEDULED
COMPLETED
SUSPENDED
CANCELLED
PENDINGAPPROVAL
EXPIREDBEFOREAPPROVAL
UNDEFINED
|
jobType
String
|
|
nextRunTime
Date
|
The time when the job will be trigger next time
|
runInstances
RunInstance[]
|
A list of run instances of the job
|
completionTime
Date
|
|
lastStartTime
Date
|
|
resultStatus
ResultState
|
Allowed values:
UNKNOWN
SUCCESS
PARTIALSUCCESS
FAILURE
ROLLBACKED
CANCELFAILED
CANCELLED
PENDINGEXECUTION
|
results
PropertyAndValue[]
|
|
property
String
|
|
value
String
|
|
|
runId
long
|
|
runStatus
WorkState
|
Allowed values:
UNKNOWN
CREATED
RUNNING
COMPLETED
ABORTED
INTERRUPTED
CANCELLED
PENDING_EXECUTION
PAUSING
PAUSED
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/jobService/runhistory?jobType="Wireless System"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/jobService/runhistory?jobType=&quot;Wireless System&quot;" rootUrl="https://localhost/webacs/api/v3/op">
<job>
<description>String value</description>
<jobId>2</jobId>
<jobName>String value</jobName>
<jobStatus>SCHEDULED</jobStatus>
<jobType>String value</jobType>
<nextRunTime>2017-07-13T13:21:19.862-07:00</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2017-07-13T13:21:19.866-07:00</completionTime>
<lastStartTime>2017-07-13T13:21:19.866-07:00</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
</runInstances>
</job>
<job>
<description>Another string value</description>
<jobId>12</jobId>
<jobName>Another string value</jobName>
<jobStatus>COMPLETED</jobStatus>
<jobType>Another string value</jobType>
<nextRunTime>2017-07-12T13:21:19.870-07:00</nextRunTime>
<runInstances>
<runInstance>
<completionTime>2017-07-13T13:21:19.873-07:00</completionTime>
<lastStartTime>2017-07-13T13:21:19.873-07:00</lastStartTime>
<resultStatus>UNKNOWN</resultStatus>
<results>
<result>
<property>String value</property>
<value>String value</value>
</result>
</results>
<runId>2</runId>
<runStatus>UNKNOWN</runStatus>
</runInstance>
</runInstances>
</job>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/jobService/runhistory.json?jobType="Wireless System"
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/jobService/runhistory?jobType="Wireless System"",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"job" : [ {
"description" : "String value",
"jobId" : 2,
"jobName" : "String value",
"jobStatus" : "SCHEDULED",
"jobType" : "String value",
"nextRunTime" : "2017-07-13T20:21:19.862Z",
"runInstances" : {
"runInstance" : [ {
"completionTime" : "2017-07-13T20:21:19.866Z",
"lastStartTime" : "2017-07-13T20:21:19.866Z",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
} ]
}
}, {
"description" : "Another string value",
"jobId" : 12,
"jobName" : "Another string value",
"jobStatus" : "COMPLETED",
"jobType" : "Another string value",
"nextRunTime" : "2017-07-12T20:21:19.870Z",
"runInstances" : {
"runInstance" : [ {
"completionTime" : "2017-07-13T20:21:19.873Z",
"lastStartTime" : "2017-07-13T20:21:19.873Z",
"resultStatus" : "UNKNOWN",
"results" : {
"result" : [ {
"property" : "String value",
"value" : "String value"
} ]
},
"runId" : 2,
"runStatus" : "UNKNOWN"
} ]
}
} ]
}
}