Cancel Work Request

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

Cancel work request

Request

Path Parameters

organizationId stringrequired

The ID of organization.

workRequestId stringrequired

The ID of work request.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the work request.
id stringrequired
organizationId stringrequired
assetIds string[]required
locationId stringrequired
isTemplate booleanrequired
subject stringrequired
description stringrequired
workflowId stringrequired
images string[]required
priority stringrequired
reason stringrequired
status stringrequired
createdAtDateString stringrequired
createdAt numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "organizationId": "string",
    "assetIds": [
      "string"
    ],
    "locationId": "string",
    "isTemplate": true,
    "subject": "string",
    "description": "string",
    "workflowId": "string",
    "images": [
      "string"
    ],
    "priority": "string",
    "reason": "string",
    "status": "string",
    "createdAtDateString": "string",
    "createdAt": 0
  }
}

Example

{
  "data": {
    "id": "wr-workRequestId",
    "organizationId": "o-organizationId",
    "assetIds": [
      "a-24e124535b312345"
    ],
    "locationId": "l-locationId",
    "isTemplate": false,
    "subject": "Work Request",
    "description": "Cancel Wokr Request",
    "workflowId": "er_eventRuleId",
    "images": [],
    "priority": "None",
    "reason": "test",
    "status": "Cancel",
    "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...