Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

JobGroups

Gets currently active flags for all jobs in the specified group

Retrieve the current active job flag for each job in the group (required scope jobs:read)

get/v1/jobGroups/{groupId}/jobFlags

Path parameters

groupIdinteger required

The unique identifier of the job group

Query parameters

pageNumberinteger

The page number being requested. (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested. (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "historyId": 123456,
      "flagId": 789,
      "flagName": "High Priority",
      "jobId": 654321,
      "appliedAt": "2024-01-15T10:30:00.0000000+00:00",
      "ownerName": "John Doe",
      "comments": "Urgent issue requires immediate attention"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}