Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET compliance/check

Checks status of Compliance Check Job

Since Product Version: 3.1

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v2/op/compliance/check

Unmodified

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

Request Parameters

Attribute Source Description

jobName String

query

RequiredName of check compliance job

Response Parameters

Attribute Description

devices Arrow image ComplianceCheckDevice[]

Devices details.

isSuccess boolean

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

message String

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://localhost/webacs/api/v2/op/compliance/check

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/compliance/check" rootUrl="https://localhost/webacs/api/v2/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://localhost/webacs/api/v2/op/compliance/check.json

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