GOgooddata
UserGroups - Entity APIs

Post User Group entities

User Group - creates tree-like structure for categorizing users

post/api/v1/entities/userGroups

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Query parameters

includestring[]

Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

Request body

Example request

{
  "data": {
    "id": "id1",
    "type": "userGroup"
  }
}

Response

Request successfully processed

Example response

{
  "data": {
    "id": "id1",
    "type": "userGroup"
  },
  "included": [
    {
      "id": "id1",
      "type": "userGroup"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.