Update Work Order

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

Update work order

Request

Path Parameters

organizationId stringrequired

The ID of organization.

workOrderId stringrequired

The ID of work order.

application/json

Body

required

subject string

The subject of work order.

description string

The description of work order.

expiredAt number

The expired time of work order.

workTime number

The workTime of work order, when type is template.

scheduleType string

The schedule type of work order.

daysOfWeek boolean[]

Days of week, ex: [false, true, false, false, false, true, false] is monday and friday of week.

everyWeeks number

How many weeks interval, ex: 1 is every week, 2 is interval of one week.

dayOfMonth number

Day of month, ex: 22 is 22th day of every month.

everyMonths number

How many months interval, ex: 1 is every month, 2 is interval of one month(1/22, 3/22, 5/22 etc...).

everyYears number

How many years interval, ex: 1 is every year, 2 is interval of one year(2023/01/22, 2025/01/22, 2027/01/22 etc...).

aheadOfTime number

Ahead of time(seconds) to available in the list.

assignee object

The assignee of work order.

priority string

The priority of work order.

workRequestId string

The ID of work request.

locationId string

The location ID of work order.

procedures string

The procedures of work order.

images string[]

The images of work order.

files string[]

The files of work order.

partIds string[]

The ID list of part.

assetIds string[]

The ID list of asset.

enableNotify boolean

Enable/Disable notification.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the work order.
type stringrequired
subject stringrequired
description string
expiredAt stringrequired
workTime number
scheduleType string
daysOfWeek boolean[]
everyWeeks number
dayOfMonth number
everyMonths number
everyYears number
aheadOfTime number
assignee object
priority stringrequired
workRequestId string
locationId string
procedures string
images string[]
files string[]
partIds string[]
assetIds string[]
enableNotify boolean
status stringrequired
timeTrackingType stringrequired
createdBy stringrequired
createdAtDateString numberrequired
createdAt 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": 0,
    "createdAt": 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
  }
}

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