Create new Group.

post https://qa.connect.calamp.com/connect/services/groups

Returns the created Group.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

schedules

array of objects

Schedules to which the Group is associated with.

schedules

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

name

string

required

Name of the Group

int64

Required for PUT requests with resource object in the request body. Forbidden for POST requests with resource object in the request body. Will result in an HTTP 400 - Bad Request response if provided in POST request.

members

string

URL to retrieve the group members

status

string

Defaults to 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

username

string

Name of the user who created the group. Read-only

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

inheritable

boolean

A flag indicating if the group is inheritable, making it accessible to all child accounts, irrespective of their depth in the account sub tree

true

deletedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

searchCriteria

object

Search Criteria

Has additional fields

notes

string

Group's description

membersCount

array of objects

List of Group's members count.

membersCount

object

type

string

Entity Type.

count

int64

Count of Entities.

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

400

Invalid request.

403

Not authorized for this operation.

500

Server error

Language

Credentials


xxxxxxxxxx
11
1
curl --request POST \
2
     --url 'https://qa.connect.calamp.com/connect/services/groups?v=2.1' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "group": {
8
    "version": 0
9
  }
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation