Device Groups

APIs to modify Device Groups

Get all Device Groups in the Target List

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

targetlist_id
required
string

ID of the Target List

Responses
200

All Device Groups in Target List

401

Target List device group get error

get/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Add a Device Group to the Target List

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

targetlist_id
required
string

ID of the Target List

Request Body schema: application/json
device_group_id
string <uuid>

UUID of the Device Group

Responses
200

Added Device group

401

Target List Device Group add error

post/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/
Request samples
application/json
{
  • "device_group_id": "3b4f0cb7-4e98-4573-a42e-df126a0072f5"
}
Response samples
application/json
{
  • "id": "string",
  • "device_group_id": "string",
  • "target_list_id": "string",
  • "created_by": 0,
  • "updated_by": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Device Group from a Target List

Request
Security:
path Parameters
pipeline_id
required
string <uuid>

ID of the Pipeline

targetlist_id
required
string <uuid>

ID of the Target List

devicegroup_id
required
string <uuid>

ID of the Device Group

Responses
200

Deleted Device Group from Target List

401

Target List device delete error

delete/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{devicegroup_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": [
    ]
}

Get all Devices in the device group

Request
Security:
path Parameters
pipeline_id
required
string <uuid>

ID of the Pipeline

targetlist_id
required
string <uuid>

ID of the Target List

device_group_id
required
string <uuid>

ID of the Device Group

Responses
200

All Devices in Device group

401

Operation List get error

get/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{device_group_id}/devices
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}