Target Lists

APIs to modify Target List

Get all Target Lists in Pipeline

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Responses
200

All Target Lists in Pipeline

401

Target List get error

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

Create a Target List

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Request Body schema: application/json
name
required
string
target_list_type
required
string
Enum: "DEVICES" "GROUPS" "COLLECTIONS"
Responses
200

All Targets in Target List

401

Target List get error

post/v0/pipelines/{pipeline_id}/targetlists/
Request samples
application/json
{
  • "name": "string",
  • "target_list_type": "DEVICES"
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get a Pipeline 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

Get target list

401

Target list attach error

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

Update a Pipeline 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
pipeline_id
string
name
string
target_list_type
string
created_by
number <int32>
updated_by
number <int32>
created_at
string <date-time>
updated_at
string <date-time>
Responses
200

Updated Target List Information

400

Target List update error

401

Target List update error

put/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/
Request samples
application/json
{
  • "pipeline_id": "string",
  • "name": "string",
  • "target_list_type": "string",
  • "created_by": 0,
  • "updated_by": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Delete a Pipeline 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

Delete target list

401

Target list delete error

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