Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Work Orders

Update work order status

patch/workorders/{id}/status

Path parameters

idinteger required

ID of the workOrder

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Request body

status'OPEN' | 'IN_PROGRESS' | 'ON_HOLD' | 'DONE' | 'CANCELED'

<br /><em>Note:</em> It is also possible to register a webhook to get notified when the status of any work order changes. Please see the <a href="#tag/Subscriptions">Subscriptions</a> section for more information.

Response

Successfully updated work order's status

Example response

{
  "workOrder": {
    "assetId": 42,
    "attachments": [
      {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      }
    ],
    "categories": [
      "Cleaning"
    ],
    "completedAt": "2022-01-01T00:00:00.000Z",
    "createdAt": "2022-01-01T00:00:00.000Z",
    "deletedAt": "2022-01-01T00:00:00.000Z",
    "description": "A work order sample description",
    "dueDate": "2022-01-01T00:00:00.000Z",
    "estimatedTime": 3600,
    "externalData": {
      "popularErpSolutionId": "asd732da"
    },
    "lastMessageSentAt": "2022-01-01T00:00:00.000Z",
    "startDate": "2022-01-01T00:00:00.000Z",
    "locationId": 611,
    "priority": "MEDIUM",
    "recurrenceInfo": {
      "automationMeterTrigger": {
        "newDueDateOffsetSeconds": 86400
      }
    },
    "thumbnail": {
      "id": 12345,
      "mimeType": "image/png",
      "fileName": "image.png",
      "url": "http://example.com/image.png",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "width": 220,
      "height": 100
    },
    "updatedAt": "2022-01-01T00:00:00.000Z",
    "extraFields": {
      "Estimated Time Allotted": "24 Hours"
    },
    "vendorIds": [
      1
    ],
    "customerId": 128,
    "procedure": {
      "id": 1234,
      "templateIds": [
        1234,
        1235
      ],
      "title": "Control dashboard audit",
      "maxScore": 2,
      "score": 1,
      "fields": [
        {
          "id": 1234,
          "parentId": 1233,
          "procedureTemplateId": 1234,
          "procedureTemplateFieldId": 5678,
          "description": "Number of green lights",
          "type": "NUMBER",
          "label": "Number of green lights",
          "maxScore": 2,
          "score": 1,
          "value": {
            "text": "12",
            "attachment": {
              "id": 12345,
              "mimeType": "image/png",
              "fileName": "image.png",
              "url": "http://example.com/image.png",
              "createdAt": "2022-01-01T00:00:00.000Z",
              "width": 220,
              "height": 100
            },
            "attachments": [
              {
                "id": 12345,
                "mimeType": "image/png",
                "fileName": "image.png",
                "url": "http://example.com/image.png",
                "createdAt": "2022-01-01T00:00:00.000Z",
                "width": 220,
                "height": 100
              }
            ],
            "notes": {
              "text": "1 light bulb is burned out."
            }
          },
          "meter": {
            "id": 123
          }
        }
      ]
    },
    "progress": {
      "openCount": 1,
      "inProgressCount": 1,
      "onHoldCount": 1,
      "doneCount": 1
    },
    "workOrderSummary": {
      "content": "Replaced the motor bearings and aligned the shaft.",
      "summary": "Motor bearing replacement and shaft alignment completed.",
      "authorId": 963
    }
  }
}