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
Name | Description | Type | Additional 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 Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of groups.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of AssetGroup |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AssetGroupId": "64490aa2-01c8-4dba-a44e-69373e1bdff3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-08T08:24:17.3678199-08:00", "MeasurementValueNeededDate": "2024-12-08T08:24:17.3678199-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ce02faae-189a-412d-97a1-42a348669ab0", "CreateDate": "2024-12-08T08:24:17.3678199-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T08:24:17.3678199-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "64490aa2-01c8-4dba-a44e-69373e1bdff3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-08T08:24:17.3678199-08:00", "MeasurementValueNeededDate": "2024-12-08T08:24:17.3678199-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ce02faae-189a-412d-97a1-42a348669ab0", "CreateDate": "2024-12-08T08:24:17.3678199-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T08:24:17.3678199-08:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }