Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET JobSummary

Provides a consolidated view of the latest status of all scheduled jobs. Use this resource to get a quick job status check. To query system jobs , specify username=SYSTEM

Since Product Version: 2.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v3/data/JobSummary

Unmodified

This resource has not been modified since the previous API version.

Response Parameters

Attribute Description

completionTime Date

The time when the latest job run instance finishes

description String

The job description.

duration String

The timespan of the latest run instance in seconds

jobName String

The job name. The job name and job type should be unique.

jobStatus JobSpecState

The job status

Allowed values:

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

jobType String

The job type

lastStartTime Date

The time when the latest job run instance starts

nextRunTime Date

The time when the next job run instance starts

resultStatus ResultState

The result of the latest job run instance

Allowed values:

  • UNKNOWN
  • SUCCESS
  • PARTIALSUCCESS
  • FAILURE
  • ROLLBACKED
  • CANCELFAILED
  • CANCELLED
  • PENDINGEXECUTION
  • PAUSED
  • PARTIALFAILURE

runId String

The latest run instance id of the job

runStatus WorkState

The run status of the latest job run instance

Allowed values:

  • UNKNOWN
  • CREATED
  • RUNNING
  • COMPLETED
  • ABORTED
  • INTERRUPTED
  • CANCELLED
  • PENDING_EXECUTION
  • PAUSING
  • PAUSED

username String

Who creates the job. For system jobs the value is SYSTEM

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 Payload

https://localhost/webacs/api/v3/data/JobSummary/15

<?xml version="1.0" ?>
<queryResponse type="JobSummary" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/JobSummary/15" rootUrl="https://localhost/webacs/api/v3/data">
  <entity dtoType="jobSummaryDTO" type="JobSummary" url="https://localhost/webacs/api/v3/data/JobSummary/15">
    <jobSummaryDTO displayName="String value" id="15" uuid="String value">
      <completionTime>2017-11-22T16:16:28.894Z</completionTime>
      <description>String value</description>
      <duration>String value</duration>
      <jobName>String value</jobName>
      <jobStatus>SCHEDULED</jobStatus>
      <jobType>String value</jobType>
      <lastStartTime>2017-11-22T16:16:28.894Z</lastStartTime>
      <nextRunTime>2017-11-22T16:16:28.894Z</nextRunTime>
      <resultStatus>UNKNOWN</resultStatus>
      <runId>String value</runId>
      <runStatus>UNKNOWN</runStatus>
      <username>String value</username>
    </jobSummaryDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v3/data/JobSummary/15.json

{
  "queryResponse" : {
    "@type" : "JobSummary",
    "@requestUrl" : "https://localhost/webacs/api/v3/data/JobSummary/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "jobSummaryDTO",
      "@type" : "JobSummary",
      "@url" : "https://localhost/webacs/api/v3/data/JobSummary/15",
      "jobSummaryDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "completionTime" : "2017-11-22T16:16:28.894Z",
        "description" : "String value",
        "duration" : "String value",
        "jobName" : "String value",
        "jobStatus" : "SCHEDULED",
        "jobType" : "String value",
        "lastStartTime" : "2017-11-22T16:16:28.894Z",
        "nextRunTime" : "2017-11-22T16:16:28.894Z",
        "resultStatus" : "UNKNOWN",
        "runId" : "String value",
        "runStatus" : "UNKNOWN",
        "username" : "String value"
      }
    } ]
  }
}