Skip to content

ViewModel Service API & Model Documentation (1.0.42)

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
License

TBD

Terms of Service

Languages
Servers
Generated server url

http://localhost/

View MSP

View MSP and VAR information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View VLAN Pool Profiles

Manage VLAN Pool Profile.

Operations

View Switch

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Venue

View venue information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Venue Template

View Venue Template information. Use /rec/templates for REC templates.

Operations

View Wi-Fi Profile

View Wi-Fi Service & Policy information

Operations

View Portal Service Profiles

Manage Portal Service Profile.

Operations

View Portal Service Template

View Portal Service Template information. Use /rec/templates for REC templates.

Operations

View Client Isolation Profiles

Manage Client Isolation Profile.

Operations

View Venue Topology

View Venue Topology information.

Operations

Quality of Service

View the information of Quality of Service

Operations

Edge SD-LAN Status

Edge SD-LAN Status API

Operations

View Platform

View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View SNMP Agent Profiles

Manage SNMP Agent Profile.

Operations

View SoftGRE Profile

SoftGRE Profile API

Operations

View Wi-Fi

View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Wi-Fi Template

View Wi-Fi Template information. Use /rec/templates for REC templates.

Operations

Get Wi-Fi Network Template data

Request

Get Wi-Fi Network Template Information

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
namestring
idstring
vlaninteger(int32)
nwTypestring
nwSubTypestring
captiveTypestring
crtTimestring
lastUpdTimestring
ssidstring
ancillarySsidstring
descriptionstring
clientCountinteger(int32)
defaultGuestCountrystring
enableDhcpboolean
tunnelWlanEnablebooleanread-only
securityProtocolstring
dsaeOnboardNetworkobject(DsaeOnboardNetworkDto)
isOweMasterboolean
owePairNetworkIdstring
venueApGroupsArray of objects(VenueApGroupQueryData)
apCountinteger(int32)
isEnforcedboolean
isManagedByTemplateboolean
Response
{
  "name": "string",
  "id": "string",
  "vlan": 0,
  "nwType": "string",
  "nwSubType": "string",
  "captiveType": "string",
  "crtTime": "string",
  "lastUpdTime": "string",
  "ssid": "string",
  "ancillarySsid": "string",
  "description": "string",
  "clientCount": 0,
  "defaultGuestCountry": "string",
  "enableDhcp": true,
  "tunnelWlanEnable": true,
  "securityProtocol": "string",
  "dsaeOnboardNetwork": {
    "id": "string",
    "name": "string",
    "description": "string",
    "nwSubType": "string",
    "vlan": 0,
    "vlanPool": { … },
    "securityProtocol": "string"
  },
  "isOweMaster": true,
  "owePairNetworkId": "string",
  "venueApGroups": [
    { … }
  ],
  "apCount": 0,
  "isEnforced": true,
  "isManagedByTemplate": true
}

Get Wifi Calling Profile Templates

Request

Get data for a list of wifi calling service profile templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(WifiCallingServiceProfileQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Query VLAN Pool Profile Templates

Request

Query VLAN pool profile templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

Successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(VlanPoolProfileQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get AP Group Templates

Request

Get AP group template information.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(ApGroupQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Syslog Server Profile Templates

Request

Get data for a list of syslog server profile templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(SyslogServerProfileQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Rogue Policy Templates

Request

Get the list of rogue policy templates in this tenant.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

Successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(RoguePolicyQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get RADIUS Server Profile Templates

Request

Get data for a list of RADIUS server profile templates with enhanced query data.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(RadiusServerProfileQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Layer Three Policy Templates

Request

Get data for a list of layer 3 policy templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(L3AclPolicyQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Layer Two Policy Templates

Request

Get data for a list of layer 2 policy templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(L2AclPolicyQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Ethernet Port Profile Templates

Request

Get data for a list of ethernet port profile templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(EthernetPortProfileQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get DHCP Configuration Service Profile Templates

Request

Query DHCP configuration service profile templates for the list.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(DhcpConfigServiceProfileQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Device Policy Templates

Request

Get data for a list of device policy templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(DevicePolicyQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Application Policy Templates

Request

Get data for a list of application policy templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(ApplicationPolicyQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Access Control Profile Templates

Request

Get data for a list of access control profile templates.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(AccessControlProfileQueryData)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Client API

Client API

Operations

View Ethernet Port Profile

Ethernet Port Profile API

Operations

View Template

View Template information. Use /rec/templates for REC templates.

Operations

Network

Network API

Operations