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

GET compliance/check

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Checks status of Compliance Check Job

Since Product Version: 3.1

Resource URL

/webacs/api/v1/op/compliance/check

Request Parameters

Type Attribute Name Source Description

String

jobName required

query

Name of check compliance job

Response Parameters

Type Attribute Name Description

ComplianceCheckDevice[]

devices

Devices details.

boolean

isSuccess

If true, the action was successfully performed. If false, it ended in some failure condition.

String

message

The action status message.

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/compliance/check

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <complianceCheckResult>
    <devices>
      <devices>
        <deviceIp>String value</deviceIp>
        <hostName>String value</hostName>
        <owningEntityId>String value</owningEntityId>
        <reason>String value</reason>
        <status>String value</status>
      </devices>
    </devices>
    <isSuccess>true</isSuccess>
    <message>String value</message>
  </complianceCheckResult>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/compliance/check.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/compliance\/check",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "complianceCheckResult" : {
      "devices" : {
        "devices" : {
          "deviceIp" : "String value",
          "hostName" : "String value",
          "owningEntityId" : "String value",
          "reason" : "String value",
          "status" : "String value"
        }
      },
      "isSuccess" : true,
      "message" : "String value"
    }
  }
}