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

PUT apService/deleteById

An operation to delete unified AP and third party AP by IDs.

Since Product Version: 3.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

Resource URL

/webacs/api/v2/op/apService/deleteById

Unmodified

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

Request Payload Parameters

Attribute Description

apID Long[]

Required

ID of unified AP or third party AP

Response Parameters

Attribute Description

failure Arrow image ApOperationResultStatus[]

A list of access point names that fail in the operation

operation AccessPointOperationEnum

The name of the performed operation

  • DELETEAP

success Arrow image ApOperationResultStatus[]

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://10.64.88.203/webacs/api/v2/op/apService/deleteById

<?xml version="1.0" ?>
<apCandidateId>
  <apIDs>
    <apID>15</apID>
    <apID>25</apID>
  </apIDs>
</apCandidateId>

Sample JSON Request Payload

https://10.64.88.203/webacs/api/v2/op/apService/deleteById.json

{
  "apCandidateId" : {
    "apIDs" : {
      "apID" : [ 15, 25 ]
    }
  }
}

Sample XML Response Payload

https://10.64.88.203/webacs/api/v2/op/apService/deleteById

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
  <apOperationResult>
    <failure>
      <failure>
        <id>15</id>
        <message>String value</message>
        <name>String value</name>
        <status>String value</status>
      </failure>
      <failure>
        <id>25</id>
        <message>Another string value</message>
        <name>Another string value</name>
        <status>Another 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>25</id>
        <message>Another string value</message>
        <name>Another string value</name>
        <status>Another string value</status>
      </success>
    </success>
  </apOperationResult>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/apService/deleteById.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
    "apOperationResult" : [ {
      "failure" : {
        "failure" : [ {
          "id" : 15,
          "message" : "String value",
          "name" : "String value",
          "status" : "String value"
        }, {
          "id" : 25,
          "message" : "Another string value",
          "name" : "Another string value",
          "status" : "Another string value"
        } ]
      },
      "operation" : "DELETEAP",
      "success" : {
        "success" : [ {
          "id" : 15,
          "message" : "String value",
          "name" : "String value",
          "status" : "String value"
        }, {
          "id" : 25,
          "message" : "Another string value",
          "name" : "Another string value",
          "status" : "Another string value"
        } ]
      }
    } ]
  }
}