GET groups

Gets the groups from environment.

Remarks

C4M Error Code returned:

  • null

    The groups has been retrieved from environment successfully.

  • GroupNotFound

    The requested group does not exist.

HTTP Status returned:
  • 403 - Forbidden

    The authenticated user doesn't have permission to access the resource.

Response Information

The groups of given environment.

Response body formats

application/json, text/json

Sample:
[
  {
    "devices": [
      {
        "activeApplicationId": null,
        "alias": "MyDevice",
        "creationDate": "0001-01-01T00:00:00",
        "enabled": false,
        "groupId": null,
        "hardwareId": "0123456789012345",
        "id": 0,
        "lastCommunication": null,
        "lastGroupChangeDate": null,
        "lockPassword": null,
        "platform": 0
      },
      {
        "activeApplicationId": null,
        "alias": "MyDevice",
        "creationDate": "0001-01-01T00:00:00",
        "enabled": false,
        "groupId": null,
        "hardwareId": "0123456789012345",
        "id": 0,
        "lastCommunication": null,
        "lastGroupChangeDate": null,
        "lockPassword": null,
        "platform": 0
      }
    ],
    "profiles": [
      {
        "composedProfileType": 0,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 11,
        "certificateSettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 10,
        "telephonySettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 12,
        "wifiSettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 9,
        "settings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 3,
        "blacklist": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 8,
        "settings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 7,
        "settings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 6,
        "policy": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 4,
        "launcherSettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 5,
        "policy": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "applicationSettings": null,
        "composedProfileType": 2,
        "policy": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "applicationUsage": null,
        "battery": null,
        "composedProfileType": 0,
        "dataUsage": null,
        "location": null,
        "locationHistory": null,
        "memory": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      }
    ],
    "subgroups": [
      {
        "devices": null,
        "profiles": null,
        "subgroups": null,
        "enrollCode": null,
        "fullName": null,
        "id": 0,
        "name": null,
        "parentFullName": null,
        "parentGroupId": null
      },
      {
        "devices": null,
        "profiles": null,
        "subgroups": null,
        "enrollCode": null,
        "fullName": null,
        "id": 0,
        "name": null,
        "parentFullName": null,
        "parentGroupId": null
      }
    ],
    "enrollCode": "sample string 1",
    "fullName": "sample string 2",
    "id": 3,
    "name": "sample string 4",
    "parentFullName": "sample string 5",
    "parentGroupId": 1
  },
  {
    "devices": [
      {
        "activeApplicationId": null,
        "alias": "MyDevice",
        "creationDate": "0001-01-01T00:00:00",
        "enabled": false,
        "groupId": null,
        "hardwareId": "0123456789012345",
        "id": 0,
        "lastCommunication": null,
        "lastGroupChangeDate": null,
        "lockPassword": null,
        "platform": 0
      },
      {
        "activeApplicationId": null,
        "alias": "MyDevice",
        "creationDate": "0001-01-01T00:00:00",
        "enabled": false,
        "groupId": null,
        "hardwareId": "0123456789012345",
        "id": 0,
        "lastCommunication": null,
        "lastGroupChangeDate": null,
        "lockPassword": null,
        "platform": 0
      }
    ],
    "profiles": [
      {
        "composedProfileType": 0,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 11,
        "certificateSettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 10,
        "telephonySettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 12,
        "wifiSettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 9,
        "settings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 3,
        "blacklist": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 8,
        "settings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 7,
        "settings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 6,
        "policy": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 4,
        "launcherSettings": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "composedProfileType": 5,
        "policy": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "applicationSettings": null,
        "composedProfileType": 2,
        "policy": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      },
      {
        "applicationUsage": null,
        "battery": null,
        "composedProfileType": 0,
        "dataUsage": null,
        "location": null,
        "locationHistory": null,
        "memory": null,
        "groups": null,
        "isReadOnly": false,
        "description": "Sample profile description.",
        "id": 0,
        "name": "Sample profile"
      }
    ],
    "subgroups": [
      {
        "devices": null,
        "profiles": null,
        "subgroups": null,
        "enrollCode": null,
        "fullName": null,
        "id": 0,
        "name": null,
        "parentFullName": null,
        "parentGroupId": null
      },
      {
        "devices": null,
        "profiles": null,
        "subgroups": null,
        "enrollCode": null,
        "fullName": null,
        "id": 0,
        "name": null,
        "parentFullName": null,
        "parentGroupId": null
      }
    ],
    "enrollCode": "sample string 1",
    "fullName": "sample string 2",
    "id": 3,
    "name": "sample string 4",
    "parentFullName": "sample string 5",
    "parentGroupId": 1
  }
]