v2

latestOpenAPI 3.1.0raw.githubusercontent.com2024-07-03641679.9 KB
Assignments

Update status of assignment

Allow the user to update the status of the asssignment even if they are monitors but not creators of the assignment. Monitors can perform on hold to open and open to on hold status change. Creators can perform all status changes.

patch/v3/gfw/assignments/{assignmentId}/status

Request body

status'open' | 'completed' | 'on hold' required

Response

Single assignment

Example response

{
  "data": {
    "attributes": {
      "name": "string",
      "location": "string",
      "priority": 0,
      "monitors": [
        "string"
      ],
      "notes": "string",
      "status": "string",
      "alert": "string",
      "areaId": "string",
      "templateIds": [
        "string"
      ],
      "teamIds": [
        "string"
      ],
      "createdAt": 0,
      "createdBy": "string",
      "areaName": "string"
    }
  }
}