Searching:
0 results found
BackGroups/Get (List)
Description
Gets a list of all the Groups of the Applications assigned to the requesting user. A Tenant user gets a list of all the Groups of all the Applications that belong to the Tenant and its Sub-tenants.
To get the details of a specific Group, refer to Groups/Get (Specific).
See the following for request and response details ‒
See Also
Request ‒ Groups/Get (List)
| Property | Type | Description | Mandatory |
| appId | String | A unique Application identifier that is automatically generated by Axonize. This is the identifier of the Application to which this Group is assigned.
This identifier is automatically generated by Axonize when the Applications/Post endpoint is used. |
Y |
Example JSON Groups/Get (List) Request
curl -X GET \
https://api.stg.axonize.com/odata/groups \
-H ‘Authorization: Token’ \
-H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’
Response ‒ Groups/Get (List)
For each user, the response provides the properties in Request ‒ Groups/Post and Response ‒ Groups/Post.
Example JSON Groups/Get (List) Response
Status 200 ‒ OK
{
“@odata.context”: “https://stg-axonizeapi-axonize.stg-ase-axonize.p.azurewebsites.net/odata/$metadata#Groups”,
“value”: [
{
“info”: “south-west-depot”,
“active”: true,
“diagram”: null,
“parentId”: null,
“name”: “south-west-depot”,
“id”: “585b9db666701d07a8381234”,
“appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E”,
“createDate”: “0001-01-01T00:00:00Z”,
“createUser”: null,
“updateDate”: “0001-01-01T00:00:00Z”,
“updateUser”: null,
“deleted”: false,
“users”: [],
“devices”: [
{
“id”: “5859af31983df8100836ab8e”,
“name”: “truck 205471501”
},
{
“id”: “5859b13a983df8100836aba8”,
“name”: “truck 205952793”
}
],
“defaultLocation”: null,
“ancestors”: []
},
{
“info”: “Chichester”,
“active”: true,
“diagram”: null,
“parentId”: null,
“name”: “Chichester”,
“id”: “585bbbff66701d07a8381234”,
“appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E”,
“createDate”: “0001-01-01T00:00:00Z”,
“createUser”: null,
“updateDate”: “0001-01-01T00:00:00Z”,
“updateUser”: null,
“deleted”: false,
“users”: [],
“devices”: [
{
“id”: “585a4898983df8100836ac65”,
“name”: “truck V24TJT”
},
{
“id”: “5859af02983df8100836ab86”,
“name”: “truck V14TJT”
}
],
“defaultLocation”: {
“address”: null,
“lat”: 38.081068106724146,
“lng”: -122.4041748046875,
“updateDate”: “0001-01-01T00:00:00Z”
},
“ancestors”: []
}
]
}