
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager 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

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/data/JobSummary

Deprecated

This version has been deprecated. Please use v4.

## 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://10.64.88.203/webacs/api/v1/data/JobSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="JobSummary" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/JobSummary/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="jobSummaryDTO" type="JobSummary" url="https://10.64.88.203/webacs/api/v1/data/JobSummary/15">
        <jobSummaryDTO displayName="String value" id="15" uuid="String value">
          <completionTime>1986-07-24T00:00:00+05:30</completionTime>
          <description>String value</description>
          <jobName>String value</jobName>
          <jobStatus>SCHEDULED</jobStatus>
          <jobType>String value</jobType>
          <lastStartTime>1986-07-24T00:00:00+05:30</lastStartTime>
          <nextRunTime>1986-07-24T00:00:00+05:30</nextRunTime>
          <resultStatus>UNKNOWN</resultStatus>
          <runStatus>UNKNOWN</runStatus>
          <username>String value</username>
          <duration>String value</duration>
          <runId>String value</runId>
        </jobSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/JobSummary/15.json

    {
      "queryResponse" : {
        "@type" : "JobSummary",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/JobSummary/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "jobSummaryDTO",
          "@type" : "JobSummary",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/JobSummary/15",
          "jobSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "completionTime" : "1986-07-24T00 : 00 : 00+05 : 30",
            "description" : "String value",
            "jobName" : "String value",
            "jobStatus" : "SCHEDULED",
            "jobType" : "String value",
            "lastStartTime" : "1986-07-24T00 : 00 : 00+05 : 30",
            "nextRunTime" : "1986-07-24T00 : 00 : 00+05 : 30",
            "resultStatus" : "UNKNOWN",
            "runStatus" : "UNKNOWN",
            "username" : "String value",
            "duration" : "String value",
            "runId" : "String value"
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/JobSummary

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## 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://10.64.88.203/webacs/api/v2/data/JobSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="JobSummary" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/JobSummary/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="jobSummaryDTO" type="JobSummary" url="https://10.64.88.203/webacs/api/v2/data/JobSummary/15">
        <jobSummaryDTO displayName="String value" id="15" uuid="String value">
          <completionTime>1986-07-24T00:00:00+05:30</completionTime>
          <description>String value</description>
          <jobName>String value</jobName>
          <jobStatus>SCHEDULED</jobStatus>
          <jobType>String value</jobType>
          <lastStartTime>1986-07-24T00:00:00+05:30</lastStartTime>
          <nextRunTime>1986-07-24T00:00:00+05:30</nextRunTime>
          <resultStatus>UNKNOWN</resultStatus>
          <runStatus>UNKNOWN</runStatus>
          <username>String value</username>
          <duration>String value</duration>
          <runId>String value</runId>
        </jobSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/JobSummary/15.json

    {
      "queryResponse" : {
        "@type" : "JobSummary",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/JobSummary/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "jobSummaryDTO",
          "@type" : "JobSummary",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/JobSummary/15",
          "jobSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "completionTime" : 522527400000,
            "description" : "String value",
            "duration" : "String value",
            "jobName" : "String value",
            "jobStatus" : "SCHEDULED",
            "jobType" : "String value",
            "lastStartTime" : 522527400000,
            "nextRunTime" : 522527400000,
            "resultStatus" : "UNKNOWN",
            "runId" : "String value",
            "runStatus" : "UNKNOWN",
            "username" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/JobSummary

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## 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://10.64.88.203/webacs/api/v3/data/JobSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="JobSummary" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/JobSummary/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="jobSummaryDTO" type="JobSummary" url="https://10.64.88.203/webacs/api/v3/data/JobSummary/15">
        <jobSummaryDTO displayName="String value" id="15" uuid="String value">
          <completionTime>1986-07-24T00:00:00+05:30</completionTime>
          <description>String value</description>
          <jobName>String value</jobName>
          <jobStatus>SCHEDULED</jobStatus>
          <jobType>String value</jobType>
          <lastStartTime>1986-07-24T00:00:00+05:30</lastStartTime>
          <nextRunTime>1986-07-24T00:00:00+05:30</nextRunTime>
          <resultStatus>UNKNOWN</resultStatus>
          <runStatus>UNKNOWN</runStatus>
          <username>String value</username>
          <duration>String value</duration>
          <runId>String value</runId>
        </jobSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "JobSummary",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/JobSummary/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "jobSummaryDTO",
          "@type" : "JobSummary",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/JobSummary/15",
          "jobSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "completionTime" : "1986-07-23T18:30:00.000Z",
            "description" : "String value",
            "duration" : "String value",
            "jobName" : "String value",
            "jobStatus" : "SCHEDULED",
            "jobType" : "String value",
            "lastStartTime" : "1986-07-23T18:30:00.000Z",
            "nextRunTime" : "1986-07-23T18:30:00.000Z",
            "resultStatus" : "UNKNOWN",
            "runId" : "String value",
            "runStatus" : "UNKNOWN",
            "username" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/JobSummary

Updated

Types of attributes runId and duration are changed in version 4.

## Response Parameters

Attribute | Description
--- | ---
completionTime Date | The time when the latest job run instance finishes
description String | The job description.
duration Long | 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 Long | 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://10.64.88.203/webacs/api/v4/data/JobSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="JobSummary" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/JobSummary/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="jobSummaryDTO" type="JobSummary" url="https://10.64.88.203/webacs/api/v4/data/JobSummary/15">
        <jobSummaryDTO displayName="String value" id="15" uuid="String value">
          <completionTime>1986-07-24T00:00:00+05:30</completionTime>
          <description>String value</description>
          <jobName>String value</jobName>
          <jobStatus>SCHEDULED</jobStatus>
          <jobType>String value</jobType>
          <lastStartTime>1986-07-24T00:00:00+05:30</lastStartTime>
          <nextRunTime>1986-07-24T00:00:00+05:30</nextRunTime>
          <resultStatus>UNKNOWN</resultStatus>
          <runStatus>UNKNOWN</runStatus>
          <username>String value</username>
          <duration>15</duration>
          <runId>15</runId>
        </jobSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/JobSummary/15.json

    {
      "queryResponse" : {
        "@type" : "JobSummary",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/JobSummary/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "jobSummaryDTO",
          "@type" : "JobSummary",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/JobSummary/15",
          "jobSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "completionTime" : "1986-07-23T18:30:00.000Z",
            "description" : "String value",
            "duration" : 15,
            "jobName" : "String value",
            "jobStatus" : "SCHEDULED",
            "jobType" : "String value",
            "lastStartTime" : "1986-07-23T18:30:00.000Z",
            "nextRunTime" : "1986-07-23T18:30:00.000Z",
            "resultStatus" : "UNKNOWN",
            "runId" : 15,
            "runStatus" : "UNKNOWN",
            "username" : "String value"
          }
        } ]
      }
    }