Update Work Order status

PUT 
/organizations/:organizationId/work-orders/:workOrderId/status

Update work order

Request

Path Parameters

organizationId stringrequired

The ID of organization.

workOrderId stringrequired

The ID of work order.

application/json

Body

required

status stringrequired

The status of work order.

reason string

The reason for status change (required for Skipped/Cancelled).

attachments string[]

Supporting attachments for status change.

responses object

Optional SOP form responses (only when completing with SOP).

startedAt number

Timestamp when form was started.

deviceInfo object

Device information for submission.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the work order.
id stringrequired
organizationId stringrequired
locationId stringrequired
location objectrequired
id stringrequired
name stringrequired
description stringrequired
workRequestId stringrequired
type stringrequired
subject stringrequired
description stringrequired
workTime numberrequired
scheduleType stringrequired
aheadOfTime numberrequired
assignee objectrequired
priority stringrequired
procedures stringrequired
files string[]required
partIds string[]required
assetIds string[]required
status stringrequired
timeTracking objectrequired
display booleanrequired
type stringrequired
enableNotify booleanrequired
images string[]required
notifiedAt stringrequired
expiredAt stringrequired
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "organizationId": "string",
    "locationId": "string",
    "location": {
      "id": "string",
      "name": "string",
      "description": "string"
    },
    "workRequestId": "string",
    "type": "string",
    "subject": "string",
    "description": "string",
    "workTime": 0,
    "scheduleType": "string",
    "aheadOfTime": 0,
    "assignee": {},
    "priority": "string",
    "procedures": "string",
    "files": [
      "string"
    ],
    "partIds": [
      "string"
    ],
    "assetIds": [
      "string"
    ],
    "status": "string",
    "timeTracking": {
      "display": true,
      "type": "string"
    },
    "enableNotify": true,
    "images": [
      "string"
    ],
    "notifiedAt": "string",
    "expiredAt": "string",
    "createdBy": "string",
    "createdAtDateString": "string",
    "createdAt": 0
  }
}

Example

{
  "data": {
    "id": "o-organizationId-wo-workOrderId",
    "organizationId": "o-organizationId",
    "locationId": "l-locationId",
    "location": {
      "id": "l-locationId",
      "name": "Location ",
      "description": "Location-Description"
    },
    "workRequestId": "wr-workRequestId",
    "type": "Normal",
    "subject": "IDT-WorkOrder",
    "description": "IDT-WorkOrder-Description",
    "workTime": 3600000,
    "scheduleType": "Daily",
    "aheadOfTime": 3600,
    "assignee": [
      {
        "type": "Team",
        "id": "6d708f0e-xxxx-xxxx-xxxx-f0d9c59488ef"
      },
      {
        "type": "User",
        "id": "593b34c0-xxxx-xxxx-xxxx-a454c6f9f50d"
      }
    ],
    "priority": "Low",
    "procedures": [],
    "files": [
      "Infodeck-Bot-0001.pdf"
    ],
    "partIds": [],
    "assets": [],
    "assetIds": [],
    "status": "InProgress",
    "timeTracking": {
      "display": true,
      "type": "automatic"
    },
    "enableNotify": true,
    "images": [
      "Asset-Image.png"
    ],
    "notifiedAt": "2024-01-30T00:00:00.000Z",
    "expiredAt": "2024-02-01T00:00:00.000Z",
    "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
    "createdAtDateString": "2024-01-01T00:00:00.000Z",
    "createdAt": 1704067200000
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...