Skip to content
Activities/
/
Access Activity by ID

Activities (0.0.4)

Ruckus Network Technical Documents

Overview

Rate Limit

For the REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

View Activities

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

Operations

Replace Activity Notification

Request

Update activity notification options.

Path
activityIdstringrequired
Body
required
enabledboolean

Checked if its enabled.

endpointstring

Notification endpoint

typestring
Enum"email""sms""push"
{
  "enabled": true,
  "endpoint": "string",
  "type": "email"
}

Responses

Successful operation

Body
tenantIdstring

Operation tenant identifier

requestIdstring

Operation request identifier

statusstring
Enum"PENDING""INPROGRESS""SUCCESS""FAIL""CANCELLED""PARTIAL_SUCCESS""SKIPPED"
useCasestring

Use case

notificationobject(NotificationData)

Notification details

adminobject(AdminDto)

Admin details

errorstring

Activity error message

suggestionstring

Suggestion

stepsArray of objects(StepDto)

Activity steps

productstring

Product

serialNumberstring

Serial number

startDatetimestring(date-time)

Start datetime

endDatetimestring(date-time)

End datetime

descriptionTemplatestring

Description template

descriptionDataArray of objects(NameValuePairDto)

Description variables

severitystring

Severity

entityIdsArray of strings

Entity identifier list

entityDataobject

Entity details

linkTemplatestring

Link template

linkDataArray of objects(NameValuePairDto)

Link variables

isBulkOperationboolean

Checked if its bulk operation.

viewInModalboolean

Checked if its view in modal.

errorsArray of objects

Activity error messages

eventIdstringDeprecated

Event identifier

Response
{
  "tenantId": "string",
  "requestId": "string",
  "status": "PENDING",
  "useCase": "string",
  "notification": {
    "enabled": true,
    "endpoint": "string",
    "type": "email"
  },
  "admin": {
    "name": "string",
    "email": "string",
    "ip": "string",
    "id": "string",
    "interface": "string"
  },
  "error": "string",
  "suggestion": "string",
  "steps": [
    { … }
  ],
  "product": "string",
  "serialNumber": "string",
  "startDatetime": "2019-08-24T14:15:22Z",
  "endDatetime": "2019-08-24T14:15:22Z",
  "eventId": "string",
  "descriptionTemplate": "string",
  "descriptionData": [
    { … }
  ],
  "severity": "string",
  "entityIds": [
    "string"
  ],
  "entityData": {
    "property1": null,
    "property2": null
  },
  "linkTemplate": "string",
  "linkData": [
    { … }
  ],
  "isBulkOperation": true,
  "viewInModal": true,
  "errors": [
    null
  ]
}

Query Device Activities

Request

Get device activities by query criteria.

Path
activityIdstringrequired
Body
required
searchTargetFieldsArray of strings

Target fields for search

searchStringstring

Target string for search

fieldsArray of strings

Available fields

sortFieldstring

Sort fields

sortOrderstring

Sort order

Enum"ASC""DESC"
pageinteger(int32)>= 1
pageSizeinteger(int32)>= 1

Page size

filtersobject

Filters

{
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 1,
  "pageSize": 1,
  "filters": {
    "property1": null,
    "property2": null
  }
}

Responses

Successful operation

Body
fieldsArray of strings

Available fields

totalCountinteger(int64)

Total count

pageinteger(int32)
dataArray of objects(DeviceDto)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Query Activities

Request

Get activities by query criteria.

Headers
rks-scopesstring
Body
required
searchTargetFieldsArray of strings

Target fields for search

searchStringstring

Target string for search

fieldsArray of strings

Available fields

sortFieldstring

Sort fields

sortOrderstring

Sort order

Enum"ASC""DESC"
pageinteger(int32)>= 1
pageSizeinteger(int32)>= 1

Page size

filtersobject

Filters

{
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 1,
  "pageSize": 1,
  "filters": {
    "property1": null,
    "property2": null
  }
}

Responses

Successful operation

Body
fieldsArray of strings

Available fields

totalCountinteger(int64)

Total count

pageinteger(int32)
dataArray of objects(ActivityDto)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Access Activity by ID

Request

Get activity details.

Path
activityIdstringrequired
Headers
rks-scopesstring
No request payload

Responses

Successful operation

Body
tenantIdstring

Operation tenant identifier

requestIdstring

Operation request identifier

statusstring
Enum"PENDING""INPROGRESS""SUCCESS""FAIL""CANCELLED""PARTIAL_SUCCESS""SKIPPED"
useCasestring

Use case

notificationobject(NotificationData)

Notification details

adminobject(AdminDto)

Admin details

errorstring

Activity error message

suggestionstring

Suggestion

stepsArray of objects(StepDto)

Activity steps

productstring

Product

serialNumberstring

Serial number

startDatetimestring(date-time)

Start datetime

endDatetimestring(date-time)

End datetime

descriptionTemplatestring

Description template

descriptionDataArray of objects(NameValuePairDto)

Description variables

severitystring

Severity

entityIdsArray of strings

Entity identifier list

entityDataobject

Entity details

linkTemplatestring

Link template

linkDataArray of objects(NameValuePairDto)

Link variables

isBulkOperationboolean

Checked if its bulk operation.

viewInModalboolean

Checked if its view in modal.

errorsArray of objects

Activity error messages

eventIdstringDeprecated

Event identifier

Response
{
  "tenantId": "string",
  "requestId": "string",
  "status": "PENDING",
  "useCase": "string",
  "notification": {
    "enabled": true,
    "endpoint": "string",
    "type": "email"
  },
  "admin": {
    "name": "string",
    "email": "string",
    "ip": "string",
    "id": "string",
    "interface": "string"
  },
  "error": "string",
  "suggestion": "string",
  "steps": [
    { … }
  ],
  "product": "string",
  "serialNumber": "string",
  "startDatetime": "2019-08-24T14:15:22Z",
  "endDatetime": "2019-08-24T14:15:22Z",
  "eventId": "string",
  "descriptionTemplate": "string",
  "descriptionData": [
    { … }
  ],
  "severity": "string",
  "entityIds": [
    "string"
  ],
  "entityData": {
    "property1": null,
    "property2": null
  },
  "linkTemplate": "string",
  "linkData": [
    { … }
  ],
  "isBulkOperation": true,
  "viewInModal": true,
  "errors": [
    null
  ]
}