GET api/OperatorGroups/GetOperatorGroups?pageIndex={pageIndex}&pageSize={pageSize}

Gets a list of all operator groups. Only the role of administrator has access. Pagination is supported.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageIndex

Optional page index (default is 0).

integer

None.

pageSize

Optional page size (default is 200).

integer

None.

Body Parameters

None.

Response Information

Resource Description

GetOperatorGroupsResult
NameDescriptionTypeAdditional information
PagedEvents

A page with operator group rows.

OperatorGroupRow

None.

Response Formats

application/json, text/json

Sample:
{
  "PagedEvents": {
    "PageIndex": 0,
    "PageSize": 10,
    "TotalItems": 1,
    "TotalPages": 1,
    "Items": [
      {
        "Id": 1,
        "Name": "Operator group",
        "Description": null
      }
    ]
  }
}

application/xml, text/xml

Sample:
<GetOperatorGroupsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedEvents>
    <Items>
      <GetOperatorGroupsResult.OperatorGroupRow>
        <Description i:nil="true" />
        <Id>1</Id>
        <Name>Operator group</Name>
      </GetOperatorGroupsResult.OperatorGroupRow>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
    <TotalItems>1</TotalItems>
    <TotalPages>1</TotalPages>
  </PagedEvents>
</GetOperatorGroupsResult>