GET api/v1/appgroups

List app group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Filter

Filter records

 ListAppGroupV1Filter

None.
Select

Select columns

 Collection of ListAppGroupV1Select

Default value: All

Example value: Name, Description

Unique items

Sort

Sort records Sort by the first column, then by the second column, and so on

 Collection of ListAppGroupV1Sort

Default value: Name

Example value: Name

Max items: 3

Unique items

PageNumber

Page number

 integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647
PageSize

Number of records per page

 integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of app groups

ListAppGroupV1Response
NameDescriptionTypeAdditional information
AppGroups

List of app groups

 Collection of ListAppGroupV1ResponseAppGroup

None.
Total

Total number of records matching the request

 integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample: 
{
  "AppGroups": [
    {
      "AppGroupId": "078c75c2-1fcc-4070-a8ea-30146bf6e652",
      "Name": "Inspectors",
      "Description": "Inspectors",
      "BusinessGroupId": "59b89b9e-1286-40c1-9c3c-5722292c2691",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "AppGroupId": "078c75c2-1fcc-4070-a8ea-30146bf6e652",
      "Name": "Inspectors",
      "Description": "Inspectors",
      "BusinessGroupId": "59b89b9e-1286-40c1-9c3c-5722292c2691",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}