Seer deivice service (seer-device:v.2.10.6.3b1419fe)

Download OpenAPI specification:Download

Seer deivice service.

devices

DevicesController_updateWithReqFilter

Authorizations:

JWT

Responses

Retrieve multiple Devices

Authorizations:

JWT

query Parameters

fields	Array of strings Selects resource fields. Docs
s	string Adds search condition. Docs
filter	Array of strings Adds filter condition. Docs
or	Array of strings Adds OR condition. Docs
sort	Array of strings Adds sort by field. Docs
join	Array of strings Adds relational resources. Docs
limit	integer Limit amount of resources. Docs
offset	integer Offset amount of resources. Docs
page	integer Page portion of resources. Docs
cache	integer [ 0 .. 1 ] Reset cache (if was enabled). Docs

Responses

Response Schema: application/json

One of

required	Array of objects (Device)
count required	number
total required	number
page required	number
pageCount required	number

Response samples

200

Content type

application/json

Example

GetManyDeviceResponseDto

{"data": [{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}
],
"count": 0,
"total": 0,
"page": 0,
"pageCount": 0
}

Create a single Device

Authorizations:

JWT

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Response Schema: application/json

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

DevicesController_deleteWithReq

Authorizations:

JWT

Responses

Delete a single Device

Authorizations:

JWT

path Parameters

id

required

string

Responses

Retrieve a single Device

Authorizations:

JWT

path Parameters

id

required

string

query Parameters

fields	Array of strings Selects resource fields. Docs
join	Array of strings Adds relational resources. Docs
cache	integer [ 0 .. 1 ] Reset cache (if was enabled). Docs

Responses

Response Schema: application/json

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Response samples

200

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Update a single Device

Authorizations:

JWT

path Parameters

id

required

string

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Response Schema: application/json

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Replace a single Device

Authorizations:

JWT

path Parameters

id

required

string

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Response Schema: application/json

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

DevicesController_restoreId

Authorizations:

JWT

path Parameters

required

object (deviceIdDto)

Responses

DevicesController_exportWSZones

Authorizations:

JWT

path Parameters

workspaceId

required

string

Responses

DevicesController_batchCreate

Authorizations:

JWT

path Parameters

workspaceId

required

string

Responses

DevicesController_createWithApiKey

Authorizations:

JWT

header Parameters

apikey

required

string

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

default

Content type

application/json

{"id": "workspace-id-string"
}

DevicesController_insertWithDefaultWS[0]

Authorizations:

JWT

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

default

Content type

application/json

{"id": "workspace-id-string"
}

DevicesController_insertWithDefaultWS[1]

Authorizations:

JWT

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

default

Content type

application/json

{"id": "workspace-id-string"
}

DevicesController_insertWithWorkspace[0]

Authorizations:

JWT

path Parameters

required

object (workspaceDto)

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

default

Content type

application/json

{"id": "workspace-id-string"
}

DevicesController_insertWithWorkspace[1]

Authorizations:

JWT

path Parameters

required

object (workspaceDto)

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

Response samples

default

Content type

application/json

{"id": "workspace-id-string"
}

DevicesController_patchWithWorkspace[0]

Authorizations:

JWT

path Parameters

required

object (workspaceDto)

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

DevicesController_patchWithWorkspace[1]

Authorizations:

JWT

path Parameters

required

object (workspaceDto)

Request Body schema: application/json
required

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}

DevicesController_paginate

Authorizations:

JWT

query Parameters

excludeFields required	Array of strings
req	any please ref to this link

Responses

DevicesController_getMappingData

Authorizations:

JWT

query Parameters

extName required	string Example: extName=extName-id-string
id	string Example: id=device-id-string

Responses

Response samples

default

Content type

application/json

{ }

DevicesController_getIdListwithJWT

Authorizations:

JWT

Responses

Create multiple Devices

Authorizations:

JWT

Request Body schema: application/json
required

required

Array of objects (Device)

Array

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Responses

Response Schema: application/json

Array

id required	string
shortName required	string
name required	string
type required	string
visible required	boolean
extra required	object
decoder required	string
extName required	string
enableAlert required	boolean
timeout required	number
stateRef required	Array of strings
workspace required	string

Request samples

Payload

Content type

application/json

{"bulk": [{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}
]
}

Response samples

201

Content type

application/json

[{"id": "string",
"shortName": "string",
"name": "string",
"type": "string",
"visible": true,
"extra": { },
"decoder": "string",
"extName": "string",
"enableAlert": true,
"timeout": 0,
"stateRef": ["string"
],
"workspace": "string"
}
]

realtime

RealtimeController_deleteRealtimeData

Authorizations:

JWT

query Parameters

id required	string
type required	string

Responses

RealtimeController_resetRealtimeData

Authorizations:

JWT

path Parameters

id

required

string

Responses

RealtimeController_getOverallData

Authorizations:

JWT

path Parameters

required

object (buildIdDto)

Responses

RealtimeController_getZoneOverallData

Authorizations:

JWT

path Parameters

required

object (zoneIdDto)

Responses

RealtimeController_getLatestDeviceData

Authorizations:

JWT

query Parameters

id

required

Array of strings

Array of device id.

Responses

RealtimeController_getDeviceControlConfig

Authorizations:

JWT

query Parameters

zoneId required	string
deviceId required	string

Seer deivice service (seer-device:v.2.10.6.3b1419fe)

devices

DevicesController_updateWithReqFilter

Authorizations:

Responses

Retrieve multiple Devices

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Create a single Device

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

DevicesController_deleteWithReq

Authorizations:

Responses

Delete a single Device

Authorizations:

path Parameters

Responses

Retrieve a single Device

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Update a single Device

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Replace a single Device

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

DevicesController_restoreId

Authorizations:

path Parameters

Responses

DevicesController_exportWSZones

Authorizations:

path Parameters

Responses

DevicesController_batchCreate

Authorizations:

path Parameters

Responses

DevicesController_createWithApiKey

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DevicesController_insertWithDefaultWS[0]

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DevicesController_insertWithDefaultWS[1]

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DevicesController_insertWithWorkspace[0]

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required