Group
POST /groups
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Body Parameters
Parameters indicated with a * are mandatory
| Name | Data Type |
Description |
|---|---|---|
| ExternalId* | string (64) | External Id, shown as "Organisation ID" in Cirrus Edit Hierarchy screen.. Should be unique. Alpha-Numeric. |
| ParentExternalId | string (64) | ExternalId (OrganisationID) of parent group. By default(null or empty) it uses root hierarchy. |
| SynchronizationKey | string guid (64) | Deprecated: SynchronizationKey is no longer in use (and only kept for backward compatibility) example: 0c824cc1-8294-4857-81cb-8327d83df554 |
| Title* | string (100) | example: cirrus_user@gmail.com |
| AllowRelationshipWithSchedules | boolean | "Allow relationship with Scheduled assessments" in Cirrus Edit Hierarchy screen. This allows users belonging to this hierarchy to schedule assessments belonging to this hierarchy. True by default. |
| IsOrganization | boolean | Mark hierarchy as organisation, shown as "Root level" in Cirrus Edit Hierarchy screen. False by default. |
"Root level"=isOrganization, "Organisation ID"=ExternalId
Confusingly: The "Organisation ID" is the ExternalId of a Hierarchy. "Root level" in Cirrus Edit Hierarchy screen is called isOrganization in the API.
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/groups
Sample Request
{
"ExternalId": "NewGroup",
"Title": "New_Group",
"ParentExternalId": "R014",
"AllowRelationshipWithSchedules": false,
"IsOrganization": true
}
Sample Response
{
"Content": {
"ExternalId": "NewGroup"
},
"Success": true,
"Errors": null
}
Response codes
| Code | Description |
|---|---|
| 201 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible errors: Request body can not be null or empty External id must not be null or empty ExternalId must be alpha-numeric(a-z 0-9) ExternalId must be less than 500 symbols ParentExternalId must be less than 500 symbols Group cannot be parent for itself SynchronizationKey must be valid GUID Title must not be null or empty Title must be less than 500 symbols ExternalId [{externalId}] is used Parent group with ParentExternalId [{parentExternalId}] is not found Organization below or above other organization is not allowed SynchronizationKey Parent hierarchy is archived. [{synchronizationKey}] is used |
| 500 | Internal server error |