2026-10-23 12.00 UTC - There are currently no active events. All systems operational.

Get device group details

Prev Next
Get
/devicegroups/{id}/

Operation is used to retrieve full details of given device group id. Available from product version 3.4.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of device group

Responses
200

Device Group

{
  "clazz": {
    "availability_end_ts": null,
    "availability_start_ts": null,
    "available": true,
    "groupname": "DEVICE",
    "id": 14690,
    "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DEVICE/",
    "logical_txt": "Kanavointilaite",
    "num_value": 2.0,
    "num_value2": null,
    "num_value3": null,
    "num_value4": null,
    "txt": "Conduiting device"
  },
  "comments": "test",
  "devices": [
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DEVICE",
        "id": 236390,
        "list_url": "https://keycom.example.com/v2/txt_constants/groupname/DEVICE/",
        "logical_txt": "DSL-Laitepaikka",
        "num_value": 9.0,
        "num_value2": 1.0,
        "num_value3": 1.0,
        "num_value4": 251970.0,
        "txt": "DSL port"
      },
      "connectors": 128,
      "fcode": "1111",
      "id": 35210,
      "insertOnlyAsGroup": true,
      "listUrl": "https://keycom.example.com/api/v2/types/",
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 230,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Kuitu",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Fiber"
      },
      "type": "DSL-laitepaikka"
    },
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DEVICE",
        "id": 232390,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DEVICE/",
        "logical_txt": "Hylly",
        "num_value": 5.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Shelf"
      },
      "connectors": 0,
      "fcode": "2222",
      "id": 35290,
      "insertOnlyAsGroup": true,
      "listUrl": "https://keycom.example.com/api/v2/types/",
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 250,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Hybridi",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Hybrid"
      },
      "type": "Hylly"
    },
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DEVICE",
        "id": 232390,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DEVICE/",
        "logical_txt": "Hylly",
        "num_value": 5.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Shelf"
      },
      "connectors": 0,
      "fcode": "3333",
      "id": 35290,
      "insertOnlyAsGroup": true,
      "listUrl": "https://keycom.example.com/api/v2/types/",
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 250,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Hybridi",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Hybrid"
      },
      "type": "Hylly"
    },
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": null,
      "connectors": 40,
      "fcode": "44444",
      "id": 2010,
      "insertOnlyAsGroup": true,
      "listUrl": "https://keycom.example.com/api/v2/types/",
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 210,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Kupari",
        "num_value": 0.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Copper"
      },
      "type": "Pääte 40"
    },
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": null,
      "connectors": 40,
      "fcode": "55555",
      "id": 2010,
      "insertOnlyAsGroup": true,
      "listUrl": "https://keycom.example.com/api/v2/types/",
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 210,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Kupari",
        "num_value": 0.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Copper"
      },
      "type": "Pääte 40"
    },
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": null,
      "connectors": 40,
      "fcode": "666666",
      "id": 2010,
      "insertOnlyAsGroup": true,
      "listUrl": "https://keycom.example.com/api/v2/types/",
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 210,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Kupari",
        "num_value": 0.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Copper"
      },
      "type": "Pääte 40"
    },
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DEVICE",
        "id": 14730,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DEVICE/",
        "logical_txt": "Räkki",
        "num_value": 4.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Rack"
      },
      "connectors": 0,
      "fcode": "777777",
      "id": 35270,
      "insertOnlyAsGroup": true,
      "listUrl": "https://keycom.example.com/api/v2/types/",
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 250,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Hybridi",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Hybrid"
      },
      "type": "19\" räkki 42U"
    }
  ],
  "id": 1,
  "name": "xyz"
}
Expand All
object
clazz
object (TerminalTypeClass)

Terminal type class

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DEVICE, CTV_DEVICE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

comments
string

comments

createdBy
string

User who created the device group

createdTs
string (date-time)

Timestamp when the device group was created

devices
Array of object (TerminalType)
object

Terminal type

availabilityEnd
string (date-time)

Availability end date and time

availabilityStart
string (date-time)

Availability start date and time

clazz
object (TerminalTypeClass)

Terminal type class

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DEVICE, CTV_DEVICE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

connectors
integer

Connectors

fcode
integer

Feature code

id
integer

Primary key

insertOnlyAsGroup
boolean | null

Type can be inserted only as part of a device group. Null means false. To list types insertable as a single device, filter with not__insertOnlyAsGroup=true (keeps false and null). Available from product version 2026.4.

listUrl
string (url)

Url to fetch all constants from terminal types

technology
object (TerminalTech)

Terminal type technology

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "TERMINAL_TECH" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

type
string

Type

id
integer

Primary key

name
string

name

updatedBy
string

User who last updated the device group

updatedTs
string (date-time)

Timestamp when the device group was last updated

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object

Standard error response payload

details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object

Standard error response payload

details
string

Detailed description of error