An operation to delete unified AP and third party AP by IDs.
Since Product Version: 3.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
DevNet Discussions
Resource URL
/webacs/api/v3/op/apService/deleteById UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description |
---|---|
apID Long[] |
Access point ID |
Response Parameters
Attribute | Description |
---|---|
A list of access point names that fail in the operation |
|
operation AccessPointOperationEnum |
The name of the performed operation Allowed values: |
A list of access point names 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://localhost/webacs/api/v3/op/apService/deleteById
<?xml version="1.0" ?>
<apCandidateId>
<apIDs>
<apID>15</apID>
<apID>25</apID>
</apIDs>
</apCandidateId>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/apService/deleteById.json
{
"apCandidateId" : {
"apIDs" : {
"apID" : [ 15, 25 ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/apService/deleteById
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/apService/deleteById" rootUrl="https://localhost/webacs/api/v3/op">
<apOperationResult>
<failure>
<failure>
<id>15</id>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</failure>
<failure>
<id>15</id>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</failure>
</failure>
<operation>DELETEAP</operation>
<success>
<success>
<id>15</id>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</success>
<success>
<id>15</id>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</success>
</success>
</apOperationResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/apService/deleteById.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/apService/deleteById",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"apOperationResult" : [ {
"failure" : {
"failure" : [ {
"id" : 15,
"message" : "String value",
"name" : "String value",
"status" : "String value"
}, {
"id" : 15,
"message" : "String value",
"name" : "String value",
"status" : "String value"
} ]
},
"operation" : "DELETEAP",
"success" : {
"success" : [ {
"id" : 15,
"message" : "String value",
"name" : "String value",
"status" : "String value"
}, {
"id" : 15,
"message" : "String value",
"name" : "String value",
"status" : "String value"
} ]
}
} ]
}
}