List Components

GET

/v0/entities/{entity_id}/sites/{site_id}/data-sources/{data_source_id}/components

List all components for a given data source id

Authorizations

• APIKeyHeader

Parameters

Path Parameters

entity_id

required

string

site_id

required

string

data_source_id

required

string

Query Parameters

include_core

boolean

map_column_ids

boolean

Responses

200

Successful Response

object

components

required

Array

Any of:

EcoPhiDeviceComponentSerial

object

created_at

required

string format: date-time

created_by

required

string

updated_at

Any of:

string

string format: date-time

null

null

updated_by

Any of:

string

string

null

null

_id

string

name

required

string

component_type

required

string

Allowed values: core serial analog digital

value_config

object

column_ids

Any of:

Array<object>

Array<object>

object

_id

required

string

name

required

string

description

required

string

unit

required

string

data_type

required

string

Allowed values: INT BIGINT REAL BOOL TEXT

value_type

required

string

Allowed values: CONTINUOUS TEXT BINARY STATE CUMULATIVE RESETTABLE_CUMULATIVE

Array<string>

Array<string>

updated_by_device_at

Any of:

string

string format: date-time

null

null

ems

Any of:

EcoPhiDeviceComponentEMS

object

use_component

boolean

null

null

metadata

Any of:

object

object

null

null

read_interval

required

integer

modbus_id

required

integer

connected_equipment

required

object

_id

required

string

protocol_id

required

string

manufacturer

required

string

model

required

string

series

required

string

category

required

string

Allowed values: serial

sub_category

required

string

type

required

string

sub_category_id

required

string

type_id

required

string

labels

Any of:

object

object

key

additional properties

string

null

null

ip_address

required

Any of:

string

string

null

null

port

integer

default: -1

role

object

_id

integer

description

Any of:

string

string

null

null

EcoPhiDeviceComponentAnalog

object

created_at

required

string format: date-time

created_by

required

string

updated_at

Any of:

string

string format: date-time

null

null

updated_by

Any of:

string

string

null

null

_id

string

name

required

string

component_type

required

string

Allowed values: core serial analog digital

value_config

object

column_ids

Any of:

Array<object>

Array<object>

object

_id

required

string

name

required

string

description

required

string

unit

required

string

data_type

required

string

Allowed values: INT BIGINT REAL BOOL TEXT

value_type

required

string

Allowed values: CONTINUOUS TEXT BINARY STATE CUMULATIVE RESETTABLE_CUMULATIVE

Array<string>

Array<string>

updated_by_device_at

Any of:

string

string format: date-time

null

null

ems

Any of:

EcoPhiDeviceComponentEMS

object

use_component

boolean

null

null

metadata

Any of:

object

object

null

null

socket_number

required

string

connected_equipment

required

object

_id

required

string

protocol_id

required

string

manufacturer

required

string

model

required

string

series

required

string

category

required

string

Allowed values: analog

sub_category

required

string

type

required

string

specification

required

object

measurement

required

object

output

required

object

unit

required

string

range_start

required

number

range_end

required

number

input

required

object

signal_type

required

string

Allowed values: 1 2

sub_category_id

required

string

type_id

required

string

read_interval

required

integer

labels

Any of:

object

object

key

additional properties

string

null

null

EcoPhiDeviceComponentDigital

object

created_at

required

string format: date-time

created_by

required

string

updated_at

Any of:

string

string format: date-time

null

null

updated_by

Any of:

string

string

null

null

_id

string

name

required

string

component_type

required

string

Allowed values: core serial analog digital

value_config

object

column_ids

Any of:

Array<object>

Array<object>

object

_id

required

string

name

required

string

description

required

string

unit

required

string

data_type

required

string

Allowed values: INT BIGINT REAL BOOL TEXT

value_type

required

string

Allowed values: CONTINUOUS TEXT BINARY STATE CUMULATIVE RESETTABLE_CUMULATIVE

Array<string>

Array<string>

updated_by_device_at

Any of:

string

string format: date-time

null

null

ems

Any of:

EcoPhiDeviceComponentEMS

object

use_component

boolean

null

null

metadata

Any of:

object

object

null

null

socket_number

required

string

connected_equipment

required

object

_id

required

string

protocol_id

required

string

manufacturer

required

string

model

required

string

series

required

string

category

required

string

Allowed values: digital

sub_category

required

string

type

required

string

specification

required

object

measurement

required

object

output

required

object

unit

required

string

input

required

object

pulse

required

boolean

boolean

required

boolean

pulse_multiplier

required

integer

sub_category_id

required

string

type_id

required

string

read_interval

required

integer

labels

Any of:

object

object

key

additional properties

string

null

null

EcoPhiDeviceComponentCore

object

uid

string

name

required

string

component_type

required

string

Allowed values: core serial analog digital

value_config

object

column_ids

Any of:

Array<object>

Array<object>

object

_id

required

string

name

required

string

description

required

string

unit

required

string

data_type

required

string

Allowed values: INT BIGINT REAL BOOL TEXT

value_type

required

string

Allowed values: CONTINUOUS TEXT BINARY STATE CUMULATIVE RESETTABLE_CUMULATIVE

Array<string>

Array<string>

updated_by_device_at

Any of:

string

string format: date-time

null

null

ems

Any of:

EcoPhiDeviceComponentEMS

object

use_component

boolean

null

null

metadata

Any of:

object

object

null

null

entity_id

required

string

site_id

required

string

data_source_id

required

string

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string