Help Center> ROMA Connect> API Reference> Device Integration APIs> Device Group Management> Creating a Device Group
View PDF

Creating a Device Group

Function

This API is used to create a device group.

URI

POST /v2/{project_id}/link/instances/{instance_id}/device-groups

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

Minimum: 0

Maximum: 32

instance_id

Yes

String

Instance ID.

Minimum: 0

Maximum: 36

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

parent_id

Yes

Integer

Parent group ID. The value is automatically rounded down.

Minimum: 0

Maximum: 99999999999999999

name

Yes

String

Group name, which is a string of 2 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).

Minimum: 2

Maximum: 64

description

No

String

Group description.

Minimum: 0

Maximum: 200

app_id

Yes

String

ID of the application to which the group belongs.

Minimum: 0

Maximum: 36

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

permissions

Array of strings

Permission.

parent_id

Integer

Parent group ID.

Minimum: 1

Maximum: 99999999999999999

id

Integer

Group ID

Minimum: 1

Maximum: 99999999999999999

name

String

Group name, which is a string of 2 to 64 characters containing letters, digits, underscores (_), and hyphens (-).

Minimum: 2

Maximum: 64

description

String

Group description, which contains a maximum of 200 characters.

Minimum: 0

Maximum: 200

app_id

String

ID of the application to which the group belongs.

Minimum: 0

Maximum: 36

created_user

CreatedUser object

Name of the user who created the attribute.

last_updated_user

LastUpdatedUser object

User who performed the last update.

created_datetime

String

Time when the group was created.

Minimum: 0

Maximum: 50

last_updated_datetime

String

Last modification time.

Minimum: 0

Maximum: 50

app_name

String

Application name.

Minimum: 0

Maximum: 50
Table 4 CreatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

Minimum: 0

Maximum: 64

user_name

String

Username.

Minimum: 0

Maximum: 64
Table 5 LastUpdatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

Minimum: 0

Maximum: 64

user_name

String

Username.

Minimum: 0

Maximum: 64

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

Minimum: 0

Maximum: 64

error_msg

String

Error description.

Minimum: 0

Maximum: 200

request_id

String

Message ID.

Minimum: 0

Maximum: 64

Example Requests

{
  "parent_id" : 10001,
  "name" : "device_group",
  "description" : "device group",
  "app_id" : "ef3845be-091a-4ab5-869a-9de0025e2165"
}

Example Responses

Status code: 200

Created

{
  "permissions" : [ "read", "access", "delete", "modify" ],
  "parent_id" : 0,
  "id" : 1,
  "name" : "group1",
  "description" : "group",
  "app_id" : "fe382523-cf76-4152-9fc6-f772d4427302",
  "created_user" : {
    "user_id" : "6546435432432",
    "user_name" : "user1"
  },
  "last_updated_user" : {
    "user_id" : "6546435432432",
    "user_name" : "user1"
  },
  "created_datetime" : "2020-12-11",
  "last_updated_datetime" : "2020-12-11",
  "app_name" : "app-link"
}

Status code: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-device-groups.save]. Parameter is [request]. Processor is [body].",
  "requestId" : "4946aac3-6f8f-46b8-8b06-513f4084196c-1619602488278-cnnorth7a-P-romalink-service01"
}

Status code: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
  "requestId" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

Status code: 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

Status Codes

Status Code

Description

200

Created

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Device Group Management