Internal API-Guide

GET api/WorkOrderQueue/WorkGroups

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RequireTotalCount

boolean None.
RequireGroupCount

boolean None.
IsCountQuery

boolean None.
Skip

integer None.
Take

integer None.
Sort

Collection of SortingInfo None.
Group

Collection of GroupingInfo None.
Filter

Collection of Object None.
TotalSummary

Collection of SummaryInfo None.
GroupSummary

Collection of SummaryInfo None.
Select

Collection of string None.
RemoteGrouping

boolean None.
PrimaryKey

Collection of string None.
DefaultSort

string None.

Body Parameters

None

Response Information

Resource Description

ListResultOfWorkGroupListitem
NameDescriptionTypeAdditional information
TotalCount

integer None.
Data

Collection of WorkGroupListitem None.

Response Formats

application/json, text/json

Sample: 
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "exclude": true,
      "holdOnTime": "00:00:00.1234567",
      "timeZoneRule": true,
      "isPrimary": true,
      "isSpecial": true,
      "groupByProperty": 0,
      "lastUpdated": "2025-01-06T08:46:58.0948554Z",
      "isPublished": true,
      "isValidSchedule": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "exclude": true,
      "holdOnTime": "00:00:00.1234567",
      "timeZoneRule": true,
      "isPrimary": true,
      "isSpecial": true,
      "groupByProperty": 0,
      "lastUpdated": "2025-01-06T08:46:58.0948554Z",
      "isPublished": true,
      "isValidSchedule": true
    }
  ]
}

application/xml, text/xml

Sample: 
<ListResultOfWorkGroupListitemOunioVRd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fmPilot.API.Internal.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/fmPilot.API.Internal.Areas.WorkOrderQueue.Models">
    <d2p1:WorkGroupListitem>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Exclude>true</d2p1:Exclude>
      <d2p1:GroupByProperty>None</d2p1:GroupByProperty>
      <d2p1:HoldOnTime>PT0.1234567S</d2p1:HoldOnTime>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:IsPublished>true</d2p1:IsPublished>
      <d2p1:IsSpecial>true</d2p1:IsSpecial>
      <d2p1:IsValidSchedule>true</d2p1:IsValidSchedule>
      <d2p1:LastUpdated>2025-01-06T08:46:58.0948554+00:00</d2p1:LastUpdated>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:TimeZoneRule>true</d2p1:TimeZoneRule>
    </d2p1:WorkGroupListitem>
    <d2p1:WorkGroupListitem>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Exclude>true</d2p1:Exclude>
      <d2p1:GroupByProperty>None</d2p1:GroupByProperty>
      <d2p1:HoldOnTime>PT0.1234567S</d2p1:HoldOnTime>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:IsPublished>true</d2p1:IsPublished>
      <d2p1:IsSpecial>true</d2p1:IsSpecial>
      <d2p1:IsValidSchedule>true</d2p1:IsValidSchedule>
      <d2p1:LastUpdated>2025-01-06T08:46:58.0948554+00:00</d2p1:LastUpdated>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:TimeZoneRule>true</d2p1:TimeZoneRule>
    </d2p1:WorkGroupListitem>
  </Data>
  <TotalCount>1</TotalCount>
</ListResultOfWorkGroupListitemOunioVRd>