Adds AP Onboarding Profiles
Since Product Version: 3.4
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 |
POST |
Resource URL
/webacs/api/v4/op/apOnboarding/profileRequest Parameters
Attribute | Source | Description |
---|---|---|
overrideOption Boolean |
query |
Optional Override existing profiles |
Request Payload Parameters
Attribute | Description |
---|---|
Required AP Onboarding Profiles |
Response Parameters
Attribute | Description |
---|---|
operation ApOnboardingProfileOperation |
Operation type
|
Result list |
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/v4/op/apOnboarding/profile
<?xml version="1.0" ?>
<createApOnBoardingProfilesDTO>
<profiles>
<profile>
<apName>String value</apName>
<apTemplateOne>String value</apTemplateOne>
<apTemplateThree>String value</apTemplateThree>
<apTemplateTwo>String value</apTemplateTwo>
<associatedControllerName>String value</associatedControllerName>
<profileGroup>String value</profileGroup>
<profileMode>ENABLE</profileMode>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<serialNumber>String value</serialNumber>
</profile>
<profile>
<apName>Another string value</apName>
<apTemplateOne>Another string value</apTemplateOne>
<apTemplateThree>Another string value</apTemplateThree>
<apTemplateTwo>Another string value</apTemplateTwo>
<associatedControllerName>Another string value</associatedControllerName>
<profileGroup>Another string value</profileGroup>
<profileMode>DISABLE</profileMode>
<macAddress>
<octets>000a959d6817</octets>
</macAddress>
<serialNumber>Another string value</serialNumber>
</profile>
</profiles>
</createApOnBoardingProfilesDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/apOnboarding/profile.json
{
"createApOnBoardingProfilesDTO" : {
"profiles" : {
"profile" : [ {
"apName" : "String value",
"apTemplateOne" : "String value",
"apTemplateThree" : "String value",
"apTemplateTwo" : "String value",
"associatedControllerName" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"profileGroup" : "String value",
"profileMode" : "ENABLE",
"serialNumber" : "String value"
}, {
"apName" : "Another string value",
"apTemplateOne" : "Another string value",
"apTemplateThree" : "Another string value",
"apTemplateTwo" : "Another string value",
"associatedControllerName" : "Another string value",
"macAddress" : {
"octets" : "000a959d6817"
},
"profileGroup" : "Another string value",
"profileMode" : "DISABLE",
"serialNumber" : "Another string value"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/apOnboarding/profile
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/apOnboarding/profile" rootUrl="https://localhost/webacs/api/v4/op">
<apOnboardingProfileOpResults>
<operation>ADD_PROFILES</operation>
<results>
<result>
<key>String value</key>
<message>String value</message>
<success>true</success>
</result>
<result>
<key>Another string value</key>
<message>Another string value</message>
<success>false</success>
</result>
</results>
</apOnboardingProfileOpResults>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/apOnboarding/profile.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/apOnboarding/profile",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"apOnboardingProfileOpResults" : [ {
"operation" : "ADD_PROFILES",
"results" : {
"result" : [ {
"key" : "String value",
"message" : "String value",
"success" : true
}, {
"key" : "Another string value",
"message" : "Another string value",
"success" : false
} ]
}
} ]
}
}