Targets

Targets subsystem

Get all Targets 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 Targets in Target List

401

Target List get error

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

Create a target for 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_id
required
string <uuid>
device_alias
string
device_name
required
string
is_active
boolean
Responses
200

All Targets in Target List

401

Target List get error

post/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/
Request samples
application/json
{
  • "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  • "device_alias": "string",
  • "device_name": "string",
  • "is_active": true
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get one target from 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

target_id
required
string <uuid>

ID of the Target

Responses
200

Target from Target List

401

Target List device delete error

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

Update a target in the 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

target_id
required
string <uuid>

ID of the Target

Request Body schema: application/json
device_name
string
is_active
boolean
Responses
200

Updated Target from Target List

401

Target List device delete error

put/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/
Request samples
application/json
{
  • "device_name": "string",
  • "is_active": true
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Delete a Target or Device 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

target_id
required
string <uuid>

ID of the Target

Responses
200

Deleted Target from Target List

401

Target List device delete error

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