Get Work Order

GET 
/organizations/:organizationId/work-orders/:workOrderId

Get work order

Request

Path Parameters

organizationId stringrequired

The ID of organization.

workOrderId stringrequired

The ID of work order.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the work order.
type stringrequired
subject stringrequired
description stringrequired
expiredAt stringrequired
workTime numberrequired
scheduleType stringrequired
daysOfWeek boolean[]required
everyWeeks numberrequired
dayOfMonth numberrequired
everyMonths numberrequired
everyYears numberrequired
aheadOfTime numberrequired
assignee objectrequired
priority stringrequired
workRequestId stringrequired
locationId stringrequired
procedures stringrequired
images string[]required
files string[]required
partIds string[]required
assetIds string[]required
enableNotify booleanrequired
status stringrequired
timeTrackingType stringrequired
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired

Example (from schema)

{
  "data": {
    "type": "string",
    "subject": "string",
    "description": "string",
    "expiredAt": "string",
    "workTime": 0,
    "scheduleType": "string",
    "daysOfWeek": [
      true
    ],
    "everyWeeks": 0,
    "dayOfMonth": 0,
    "everyMonths": 0,
    "everyYears": 0,
    "aheadOfTime": 0,
    "assignee": {},
    "priority": "string",
    "workRequestId": "string",
    "locationId": "string",
    "procedures": "string",
    "images": [
      "string"
    ],
    "files": [
      "string"
    ],
    "partIds": [
      "string"
    ],
    "assetIds": [
      "string"
    ],
    "enableNotify": true,
    "status": "string",
    "timeTrackingType": "string",
    "createdBy": "string",
    "createdAtDateString": "string",
    "createdAt": 0,
    "updatedAtDateString": "string",
    "updatedAt": 0
  }
}

Example

{
  "data": {
    "subject": "IDT-WorkOrder",
    "description": "IDT-WorkOrder-Description",
    "locationId": "l-locationId",
    "type": "Normal",
    "priority": "Low",
    "scheduleType": "Daily",
    "aheadOfTime": 3600,
    "enableNotify": true,
    "files": [
      "Infodeck-Bot-0001.pdf"
    ],
    "images": [
      "Asset-Image.png"
    ],
    "assignee": [
      {
        "type": "Team",
        "id": "6d708f0e-xxxx-xxxx-xxxx-f0d9c59488ef"
      },
      {
        "type": "User",
        "id": "593b34c0-xxxx-xxxx-xxxx-a454c6f9f50d"
      }
    ],
    "expiredAt": "2024-02-01T00:00:00.000Z",
    "status": "Open",
    "timeTrackingType": "automatic",
    "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
    "createdAtDateString": "2024-01-01T00:00:00.000Z",
    "createdAt": 1704067200000,
    "updatedAtDateString": "2024-01-31T00:00:00.000Z",
    "updatedAt": 1706659200000
  }
}

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...