Returns a list of AP onboarding profiles
Since Product Version: 3.4
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/data/ApOnboardingProfileResponse Parameters
Attribute | Description |
---|---|
apName String |
Access point name. If the AP name is not configured the field will be equal 'Not Configured' |
apTemplateOne String |
Name of the first lightweight access point template. If the profile hasn't got an first template this field will be equal 'NONE' |
apTemplateThree String |
Name of the third lightweight access point template. If the profile hasn't got an third template this field will be equal 'NONE' |
apTemplateTwo String |
Name of the second lightweight access point template. If the profile hasn't got an second template this field will be equal 'NONE' |
associatedControllerName String |
WLAN controller name associated with the profile. If the profile hasn't got an associated controller this field will be equal 'ANY' |
instanceOrigin InstanceOriginEnum |
Allowed values:
|
instanceTenantId Integer |
This is a tenant id for this instance. |
macAddress MacAddress |
MAC Address. A serial number or MAC address should be specified for the profile |
nextStage ProfileNextStep |
Next stage Allowed values:
|
profileGroup String |
Name of the profile group |
profileMode ProfileMode |
Profile mode Allowed values:
|
profileStatus ProfileStatus |
Profile status Allowed values:
|
reason String |
Status reason |
serialNumber String |
Serial number. Serial number is a sequence of 11 letters/digits. Either serial number or MAC address should be specified for the profile |
updateTime Date |
Time of the last update. Note: The date has an incorrect UTC offset. Add the appliance UTC offset to get the correct date. |
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 Payload
https://localhost/webacs/api/v4/data/ApOnboardingProfile/15
<?xml version="1.0" ?>
<queryResponse type="ApOnboardingProfile" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/ApOnboardingProfile/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="apOnboardingProfileDTO" type="ApOnboardingProfile" url="https://localhost/webacs/api/v4/data/ApOnboardingProfile/15">
<apOnboardingProfileDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
<apName>String value</apName>
<apTemplateOne>String value</apTemplateOne>
<apTemplateThree>String value</apTemplateThree>
<apTemplateTwo>String value</apTemplateTwo>
<associatedControllerName>String value</associatedControllerName>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<nextStage>NONE</nextStage>
<profileGroup>String value</profileGroup>
<profileMode>ENABLE</profileMode>
<profileStatus>NOT_INITIATED</profileStatus>
<reason>String value</reason>
<serialNumber>String value</serialNumber>
<updateTime>2018-12-21T12:09:16.291+07:00</updateTime>
</apOnboardingProfileDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/ApOnboardingProfile/15.json
{
"queryResponse" : {
"@type" : "ApOnboardingProfile",
"@requestUrl" : "https://localhost/webacs/api/v4/data/ApOnboardingProfile/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "apOnboardingProfileDTO",
"@type" : "ApOnboardingProfile",
"@url" : "https://localhost/webacs/api/v4/data/ApOnboardingProfile/15",
"apOnboardingProfileDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"apName" : "String value",
"apTemplateOne" : "String value",
"apTemplateThree" : "String value",
"apTemplateTwo" : "String value",
"associatedControllerName" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"nextStage" : "NONE",
"profileGroup" : "String value",
"profileMode" : "ENABLE",
"profileStatus" : "NOT_INITIATED",
"reason" : "String value",
"serialNumber" : "String value",
"updateTime" : "2018-12-21T05:09:16.291Z"
}
} ]
}
}