Create a Group

Use this API to create groups that can be used to manage your fleet. Different groups have different configurations and each group has an administrator. Nesting of groups is also possible. Default Group is considered as the parent of all groups.

📘

Sample Request

https://services.azuga.com/azuga-ws-oauth/v3/groups/create.json

{
    "groupName": "Test_Group",
    "description": "This is a test group",
    "administrators": "0bfc3854-4a74-11e7-bd1f-03fd1cd47229,176c004b-530f-11ea-9b6d-c1c71f2dceeb",
    "bgColor": "#361010",
    "parentGroupName": "2175-Group",
    "configName": "testb",
    "textColor": "#b57272"
}

OR

{
    "groupName": "Test_Group11111",
    "description": "This is a test group",
    "useParentDefaultGroup": true,
    "useDefaultAdmin": true,
    "useDefaultConfig": true
}

API Response Explanation

Field

Description

Data Type

generatedAtInMillis

Time in UTC milliseconds when the API request is made

Long

data

The object consists of metadata of the group.

Object

groupId

Unique identifier representing the group

String

customerId

Unique identifier representing the customer

Long

parentId

Unique identifier representing the parent group

String

parentName

Name of the parent group

String

name

Name of the group

String

description

Brief description of the group

String

userIds

Unique identifiers(in comma-separated) denoting the administrators of the group

List<String>

configId

Unique identifier of the configuration

String

parentGroup

For internal use

GroupLiteVO

configName

Name of the configuration

String

createdBy

Unique identifier of the user created the group

String

createdAt

Created time of the group in UTC milliseconds

Timestamp

lastModifiedBy

The unique identifier of the user updated the group information last

String

lastModifiedAt

Modified time of the group in UTC milliseconds

Timestamp

deleted

Boolean value representing whether the group is deleted.
True = Deleted
False = Not Deleted

boolean

deletedAt

Deleted time in UTC milliseconds

Timestamp

color

Text color of the map icon

String

bgColor

Background color of the map icon

String

adminUsers

For internal use

String

userList

For internal use

List<JobUserVO>

configuration

For internal use

ConfigurationVO

ssodefault

For internal use

boolean

error

Error description - if any

List<Error>

Language
Credentials
Header
Click Try It! to start a request and see the response here!