Skip to content

ViewModel Service API & Model Documentation (1.0.41)

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
License

TBD

Terms of Service

Languages
Servers
Generated server url

http://localhost/

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 Wi-Fi Profile

View Wi-Fi Service & Policy information

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 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

AP SNMP Agents

Operations

Get AP SNMP AgentsDeprecated

Request

Get data for a list of AP SNMP agents.

Bodyapplication/jsonrequired
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
application/json
{
  "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

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