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
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
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/op/compliance/check
Request Parameters
jobName
String
|
query
|
Required
Name of check compliance job
|
Response Parameters
devices
ComplianceCheckDevice[]
|
|
deviceIp
String
|
Device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
|
hostName
String
|
|
owningEntityId
String
|
Device owningEntityId. Internal use only
|
reason
String
|
Compliance check failure reason
|
status
String
|
|
|
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/v1/op/compliance/check
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/compliance/check" rootUrl="https://localhost/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://localhost/webacs/api/v1/op/compliance/check.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/compliance\/check",
"@rootUrl" : "https : \/\/localhost\/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"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/compliance/check
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobName
String
|
query
|
Required
Name of check compliance job
|
Response Parameters
devices
ComplianceCheckDevice[]
|
|
deviceIp
String
|
Device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
|
hostName
String
|
|
owningEntityId
String
|
Device owningEntityId. Internal use only
|
reason
String
|
Compliance check failure reason
|
status
String
|
|
|
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"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/compliance/check
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobName
String
|
query
|
Required
Name of check compliance job
|
Response Parameters
devices
ComplianceCheckDevice[]
|
|
deviceIp
String
|
Device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
|
hostName
String
|
|
owningEntityId
String
|
Device owningEntityId. Internal use only
|
reason
String
|
Compliance check failure reason
|
status
String
|
|
|
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/v3/op/compliance/check
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/compliance/check" rootUrl="https://localhost/webacs/api/v3/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>
<deviceIp>Another string value</deviceIp>
<hostName>Another string value</hostName>
<owningEntityId>Another string value</owningEntityId>
<reason>Another string value</reason>
<status>Another string value</status>
</devices>
</devices>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceCheckResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/compliance/check.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/compliance/check",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"complianceCheckResult" : [ {
"devices" : {
"devices" : [ {
"deviceIp" : "String value",
"hostName" : "String value",
"owningEntityId" : "String value",
"reason" : "String value",
"status" : "String value"
}, {
"deviceIp" : "Another string value",
"hostName" : "Another string value",
"owningEntityId" : "Another string value",
"reason" : "Another string value",
"status" : "Another string value"
} ]
},
"isSuccess" : true,
"message" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/compliance/check
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
jobName
String
|
query
|
Required
Name of check compliance job
|
Response Parameters
devices
ComplianceCheckDevice[]
|
|
deviceIp
String
|
Device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
|
hostName
String
|
|
owningEntityId
String
|
Device owningEntityId. Internal use only
|
reason
String
|
Compliance check failure reason
|
status
String
|
|
|
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/v4/op/compliance/check
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/compliance/check" rootUrl="https://localhost/webacs/api/v4/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>
<deviceIp>Another string value</deviceIp>
<hostName>Another string value</hostName>
<owningEntityId>Another string value</owningEntityId>
<reason>Another string value</reason>
<status>Another string value</status>
</devices>
</devices>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceCheckResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/compliance/check.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/compliance/check",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"complianceCheckResult" : [ {
"devices" : {
"devices" : [ {
"deviceIp" : "String value",
"hostName" : "String value",
"owningEntityId" : "String value",
"reason" : "String value",
"status" : "String value"
}, {
"deviceIp" : "Another string value",
"hostName" : "Another string value",
"owningEntityId" : "Another string value",
"reason" : "Another string value",
"status" : "Another string value"
} ]
},
"isSuccess" : true,
"message" : "String value"
} ]
}
}