Update Work Request

PUT 
/organizations/:organizationId/work-requests/:workRequestId

Update work request

Request

Path Parameters

organizationId stringrequired

The ID of organization.

workRequestId stringrequired

The ID of work request.

application/json

Body

required

isTemplate boolean

The work request is template.

subject string

The subject of work request.

description string

The description of work request.

locationId string

The location ID of work order.

images string[]

The images of work request.

priority string

The priority of work order.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the updated work request.
subject stringrequired
description stringrequired
locationId stringrequired
priority stringrequired
isTemplate booleanrequired
assetIds string[]required
images string[]required
files string[]required
createdBy stringrequired
createdAtDateString stringrequired
createdAt stringrequired

Example (from schema)

{
  "data": {
    "subject": "string",
    "description": "string",
    "locationId": "string",
    "priority": "string",
    "isTemplate": true,
    "assetIds": [
      "string"
    ],
    "images": [
      "string"
    ],
    "files": [
      "string"
    ],
    "createdBy": "string",
    "createdAtDateString": "string",
    "createdAt": "string"
  }
}

Example

{
  "data": {
    "subject": "IDT-WorkRequest",
    "description": "IDT-WorkRequest-Description",
    "locationId": "l-locationId",
    "priority": "Medium",
    "isTemplate": false,
    "assetIds": [
      "a-assetId"
    ],
    "images": [
      "Asset-Image.png"
    ],
    "files": [
      "Infodeck-Bot-0001.pdf"
    ],
    "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...