Jobs

Gets currently active flag for the specified job

Retrieve the current active flag for a job (required scope jobs:read)

get/v1/jobs/{jobId}/flags

Request

Base URL
https://api.bigchange.com
URL
https://api.bigchange.com/v1/jobs/{jobId}/flags
Auth
HTTP bearer

Path parameters

jobIdinteger required

The unique identifier of the job

Headers

Customer-Idinteger required

The customer identifier

Response

historyIdinteger

The unique identifier of the flag history entry

flagIdinteger

The unique identifier of the flag

flagNamestring

The name of the flag

jobIdinteger

The unique identifier of the job

appliedAtstring date-time

The UTC timestamp of when this flag was applied

ownerNamestring

The name of the owner who applied the flag

commentsstring

Additional comments about the flag

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.