Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET jobService/runhistory

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

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")

Since Product Version: 2.2

Resource URL

/webacs/api/v1/op/jobService/runhistory

Request Parameters

Type Attribute Name Source Description

String

jobId optional

query

A job id to uniquely identify a job

String

jobType optional

query

A job type

String

jobName optional

query

A 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

String

startTime optional

query

The 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

Type Attribute Name Description

String

description

The description of a job

long

jobId

The id of a job to uniquely identify a job

String

jobName

The name of a job. Job name and job type together should be unique.

JobSpecState

jobStatus

The status of a job

Allowed values:

  • SCHEDULED
  • COMPLETED
  • SUSPENDED
  • CANCELLED
  • PENDINGAPPROVAL
  • EXPIREDBEFOREAPPROVAL
  • UNDEFINED

String

jobType

The type of a job

Date

nextRunTime

The time when the job will be trigger next time

RunInstance[]

runInstances

A list of run instances of the job

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://172.25.123.114/webacs/api/v1/op/jobService/runhistory

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <job>
    <description>String value</description>
    <jobId>2</jobId>
    <jobName>String value</jobName>
    <jobStatus>SCHEDULED</jobStatus>
    <jobType>String value</jobType>
    <nextRunTime>2020-07-28T20:29:57.462Z</nextRunTime>
    <runInstances>
      <runInstance>
        <completionTime>2020-07-28T20:29:57.468Z</completionTime>
        <lastStartTime>2020-07-28T20:29:57.468Z</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://172.25.123.114/webacs/api/v1/op/jobService/runhistory.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/jobService\/runhistory",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "job" : {
      "description" : "String value",
      "jobId" : 2,
      "jobName" : "String value",
      "jobStatus" : "SCHEDULED",
      "jobType" : "String value",
      "nextRunTime" : "2020-07-28T20 : 29 : 57.462Z",
      "runInstances" : {
        "runInstance" : {
          "completionTime" : "2020-07-28T20 : 29 : 57.468Z",
          "lastStartTime" : "2020-07-28T20 : 29 : 57.468Z",
          "resultStatus" : "UNKNOWN",
          "results" : {
            "result" : {
              "property" : "String value",
              "value" : "String value"
            }
          },
          "runId" : 2,
          "runStatus" : "UNKNOWN"
        }
      }
    }
  }
}