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

PUT jobService/suspend

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

Disable the trigger temporarily. The job will no longer run when suspended. To re-enable the job trigger, use 'Resume A Job' service. Suspending a job in running status dose not impact the running instance.

Since Product Version: 2.2

Resource URL

/webacs/api/v1/op/jobService/suspend

Request Payload Parameters

Type Attribute Name Description

Long[]

jobId

The id of a job on which the operation will be performed

Response Parameters

Type Attribute Name Description

OperationResultStatus[]

failure

A list of job ids that fail in the operation

String

message

A system generated message

OperationEnum

operation

The service name

Allowed values:

  • SUSPEND
  • RESUME
  • CANCEL
  • CANCELRUNNING

OperationResultStatus[]

success

A list of job ids that succeed in the operation

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 Request Payload

https://172.25.123.114/webacs/api/v1/op/jobService/suspend

<?xml version="1.0" ?>
<jobOperationPayload>
  <jobIds>
    <jobId>15</jobId>
  </jobIds>
</jobOperationPayload>

Sample JSON Request Payload

https://172.25.123.114/webacs/api/v1/op/jobService/suspend.json

{
  "jobOperationPayload" : {
    "jobIds" : {
      "jobId" : 15
    }
  }
}

Sample XML Response Payload

https://172.25.123.114/webacs/api/v1/op/jobService/suspend

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <operationResult>
    <failure>
      <failure>
        <id>2</id>
        <message>String value</message>
        <status>String value</status>
      </failure>
    </failure>
    <message>String value</message>
    <operation>SUSPEND</operation>
    <success>
      <success>
        <id>2</id>
        <message>String value</message>
        <status>String value</status>
      </success>
    </success>
  </operationResult>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/jobService/suspend.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/jobService\/suspend",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "operationResult" : {
      "failure" : {
        "failure" : {
          "id" : 2,
          "message" : "String value",
          "status" : "String value"
        }
      },
      "message" : "String value",
      "operation" : "SUSPEND",
      "success" : {
        "success" : {
          "id" : 2,
          "message" : "String value",
          "status" : "String value"
        }
      }
    }
  }
}