Skip to content
/
Get Activity Devices

Activities API (v0.0.1)

Download OpenAPI description
Download PDF
Languages
Servers
Generated server url

http://localhost/

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

Update Activity Notification Options

Request

Update activity notification options.

Path
activityIdstringrequired
Bodyapplication/jsonrequired
enabledboolean
endpointstring
typestring
Enum"email""sms""push"
application/json
{
  "enabled": true,
  "endpoint": "string",
  "type": "email"
}

Responses

Successful operation

Body*/*
tenantIdstring
requestIdstring
statusstring
Enum"PENDING""INPROGRESS""SUCCESS""FAIL"
useCasestring
notificationobject(NotificationData)
adminobject(AdminDto)
errorstring
suggestionstring
stepsArray of objects(StepDto)
productstring
serialNumberstring
startDatetimestring(date-time)
endDatetimestring(date-time)
eventIdstring
descriptionTemplatestring
descriptionDataArray of objects(NameValuePairDto)
severitystring

Get Activity Devices

Request

Get the list of activity devices.

Path
activityIdstringrequired
Bodyapplication/jsonrequired
fieldsArray of strings
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
pageinteger(int32)>= 1
pageSizeinteger(int32)>= 1
filtersobject
application/json
{
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 1,
  "pageSize": 1,
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

Successful operation

Body*/*
fieldsArray of strings
totalCountinteger(int64)
pageinteger(int32)
dataArray of objects(DeviceDto)

Get Activities

Request

Get the list of activities.

Bodyapplication/jsonrequired
fieldsArray of strings
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
pageinteger(int32)>= 1
pageSizeinteger(int32)>= 1
filtersobject
application/json
{
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 1,
  "pageSize": 1,
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

Successful operation

Body*/*
fieldsArray of strings
totalCountinteger(int64)
pageinteger(int32)
dataArray of objects(ActivityDto)

Get Activity Details

Request

Get activity details.

Path
activityIdstringrequired
No request payload

Responses

Successful operation

Body*/*
tenantIdstring
requestIdstring
statusstring
Enum"PENDING""INPROGRESS""SUCCESS""FAIL"
useCasestring
notificationobject(NotificationData)
adminobject(AdminDto)
errorstring
suggestionstring
stepsArray of objects(StepDto)
productstring
serialNumberstring
startDatetimestring(date-time)
endDatetimestring(date-time)
eventIdstring
descriptionTemplatestring
descriptionDataArray of objects(NameValuePairDto)
severitystring

deleteSchedule

Request

No request payload

Responses

OK

Body*/*
object