Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
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/data/ApOnboardingProfile
Response Parameters
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'
|
macAddress
MacAddress
|
MAC Address.
A serial number or MAC address should be specified for the profile
|
nextStage
ProfileNextStep
|
|
profileGroup
String
|
Name of the profile group
|
profileMode
ProfileMode
|
|
profileStatus
ProfileStatus
|
|
reason
String
|
|
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
|
Deprecated. Time of the last updated.
This attribute may provide time in a wrong timezone. Please, don't use this attribute.
|
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://10.78.83.125/webacs/api/v1/data/ApOnboardingProfile/15
<?xml version="1.0" ?>
<queryResponse type="ApOnboardingProfile" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v1/data/ApOnboardingProfile/15" rootUrl="https://10.78.83.125/webacs/api/v1/data">
<entity dtoType="apOnboardingProfileDTO" type="ApOnboardingProfile" url="https://10.78.83.125/webacs/api/v1/data/ApOnboardingProfile/15">
<apOnboardingProfileDTO displayName="String value" id="15" 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>1986-07-24T00:00:00Z</updateTime>
</apOnboardingProfileDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v1/data/ApOnboardingProfile/15.json
{
"queryResponse" : {
"@type" : "ApOnboardingProfile",
"@responseType" : "getEntity",
"@requestUrl" : "https : //10.78.83.125/webacs/api/v1/data/ApOnboardingProfile/15",
"@rootUrl" : "https : //10.78.83.125/webacs/api/v1/data",
"entity" : {
"@dtoType" : "apOnboardingProfileDTO",
"@type" : "ApOnboardingProfile",
"@url" : "https : //10.78.83.125/webacs/api/v1/data/ApOnboardingProfile/15",
"apOnboardingProfileDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@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" : "1986-07-24T00 : 00 : 00Z"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/ApOnboardingProfile
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
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'
|
macAddress
MacAddress
|
MAC Address.
A serial number or MAC address should be specified for the profile
|
nextStage
ProfileNextStep
|
|
profileGroup
String
|
Name of the profile group
|
profileMode
ProfileMode
|
|
profileStatus
ProfileStatus
|
|
reason
String
|
|
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
|
Deprecated. Time of the last updated.
This attribute may provide time in a wrong timezone. Please, don't use this attribute.
|
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://10.78.83.125/webacs/api/v2/data/ApOnboardingProfile/15
<?xml version="1.0" ?>
<queryResponse type="ApOnboardingProfile" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v2/data/ApOnboardingProfile/15" rootUrl="https://10.78.83.125/webacs/api/v2/data">
<entity dtoType="apOnboardingProfileDTO" type="ApOnboardingProfile" url="https://10.78.83.125/webacs/api/v2/data/ApOnboardingProfile/15">
<apOnboardingProfileDTO displayName="String value" id="15" 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>1986-07-24T00:00:00Z</updateTime>
</apOnboardingProfileDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v2/data/ApOnboardingProfile/15.json
{
"queryResponse" : {
"@type" : "ApOnboardingProfile",
"@requestUrl" : "https://10.78.83.125/webacs/api/v2/data/ApOnboardingProfile/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "apOnboardingProfileDTO",
"@type" : "ApOnboardingProfile",
"@url" : "https://10.78.83.125/webacs/api/v2/data/ApOnboardingProfile/15",
"apOnboardingProfileDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@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" : 522547200000
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/ApOnboardingProfile
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
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'
|
macAddress
MacAddress
|
MAC Address.
A serial number or MAC address should be specified for the profile
|
nextStage
ProfileNextStep
|
|
profileGroup
String
|
Name of the profile group
|
profileMode
ProfileMode
|
|
profileStatus
ProfileStatus
|
|
reason
String
|
|
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
|
Deprecated. Time of the last updated.
This attribute may provide time in a wrong timezone. Please, don't use this attribute.
|
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://10.78.83.125/webacs/api/v3/data/ApOnboardingProfile/15
<?xml version="1.0" ?>
<queryResponse type="ApOnboardingProfile" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v3/data/ApOnboardingProfile/15" rootUrl="https://10.78.83.125/webacs/api/v3/data">
<entity dtoType="apOnboardingProfileDTO" type="ApOnboardingProfile" url="https://10.78.83.125/webacs/api/v3/data/ApOnboardingProfile/15">
<apOnboardingProfileDTO displayName="String value" id="15" 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>1986-07-24T00:00:00Z</updateTime>
</apOnboardingProfileDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v3/data/ApOnboardingProfile/15.json
{
"queryResponse" : {
"@type" : "ApOnboardingProfile",
"@requestUrl" : "https://10.78.83.125/webacs/api/v3/data/ApOnboardingProfile/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "apOnboardingProfileDTO",
"@type" : "ApOnboardingProfile",
"@url" : "https://10.78.83.125/webacs/api/v3/data/ApOnboardingProfile/15",
"apOnboardingProfileDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@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" : "1986-07-24T00:00:00.000Z"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/ApOnboardingProfile
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
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'
|
macAddress
MacAddress
|
MAC Address.
A serial number or MAC address should be specified for the profile
|
nextStage
ProfileNextStep
|
|
profileGroup
String
|
Name of the profile group
|
profileMode
ProfileMode
|
|
profileStatus
ProfileStatus
|
|
reason
String
|
|
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
|
Deprecated. Time of the last updated.
This attribute may provide time in a wrong timezone. Please, don't use this attribute.
|
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://10.78.83.125/webacs/api/v4/data/ApOnboardingProfile/15
<?xml version="1.0" ?>
<queryResponse type="ApOnboardingProfile" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v4/data/ApOnboardingProfile/15" rootUrl="https://10.78.83.125/webacs/api/v4/data">
<entity dtoType="apOnboardingProfileDTO" type="ApOnboardingProfile" url="https://10.78.83.125/webacs/api/v4/data/ApOnboardingProfile/15">
<apOnboardingProfileDTO displayName="String value" id="15" 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>1986-07-24T00:00:00Z</updateTime>
</apOnboardingProfileDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v4/data/ApOnboardingProfile/15.json
{
"queryResponse" : {
"@type" : "ApOnboardingProfile",
"@requestUrl" : "https://10.78.83.125/webacs/api/v4/data/ApOnboardingProfile/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "apOnboardingProfileDTO",
"@type" : "ApOnboardingProfile",
"@url" : "https://10.78.83.125/webacs/api/v4/data/ApOnboardingProfile/15",
"apOnboardingProfileDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@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" : "1986-07-24T00:00:00.000Z"
}
} ]
}
}