GET AssetGroups?parentGroupId={parentGroupId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves asset groups for the given parameters. All parameters are optional.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
parentGroupId

Id of the parent group, to only fetch groups within that parent group. Set to 00000000-0000-0000-0000-000000000000 to fetch only top level groups.

globally unique identifier

None.

take

Number of groups to retrieve. Default is all groups

integer

None.

skip

Number of groups to skip before retrieval

integer

Default value is 0

sort

List of sorting rules to describe how to sort the groups before retrieval

Collection of Sort

None.

Operator

string

None.

Field

string

None.

Value

string

None.

Logic

string

None.

Filters

Collection of DataFilter

None.

Body Parameters

None.

Response Information

Resource Description

On success, a list of groups.

NameDescriptionTypeAdditional information
Data

Collection of AssetGroup

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "AssetGroupId": "fb949e78-8f4e-44f5-a3bd-ddcff28d9769",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2021-04-17T07:20:28.4584643-07:00",
      "MeasurementValueNeededDate": "2021-04-17T07:20:28.4584643-07:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "341a382f-9d3e-4fa5-acc0-eb3e106e27ce",
      "CreateDate": "2021-04-17T07:20:28.4584643-07:00",
      "CreateUser": "sample string 5",
      "CreateMachine": "sample string 6",
      "LastModifiedDate": "2021-04-17T07:20:28.4584643-07:00",
      "LastModifiedUser": "sample string 7",
      "LastModifiedMachine": "sample string 8"
    },
    {
      "AssetGroupId": "fb949e78-8f4e-44f5-a3bd-ddcff28d9769",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2021-04-17T07:20:28.4584643-07:00",
      "MeasurementValueNeededDate": "2021-04-17T07:20:28.4584643-07:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "341a382f-9d3e-4fa5-acc0-eb3e106e27ce",
      "CreateDate": "2021-04-17T07:20:28.4584643-07:00",
      "CreateUser": "sample string 5",
      "CreateMachine": "sample string 6",
      "LastModifiedDate": "2021-04-17T07:20:28.4584643-07:00",
      "LastModifiedUser": "sample string 7",
      "LastModifiedMachine": "sample string 8"
    }
  ],
  "Total": 1,
  "Message": "sample string 1"
}