List Work Requests By User

GET 
/organizations/:organizationId/users/:userId/work-requests

List work requests by user

Request

Path Parameters

organizationId stringrequired

The ID of organization.

userId stringrequired

The ID of user.

Query Parameters

filterStatus string[]

The status of work order. (Default: optional ; Options: Open, Accept, InProgress, OnHold, Complete, Close)

maxResults number

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

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

Example (from schema)

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

Example

{
  "data": [
    {
      "id": "wr-workRequestId",
      "organizationId": "o-organizationId",
      "assetIds": "a-assetId",
      "locationId": "l-locationId",
      "workflowId": "er_eventRuleId",
      "subject": "IDT-WorkRequest",
      "description": "IDT-WorkRequest-Description",
      "images": [
        "Asset-Image.png"
      ],
      "isTemplate": false,
      "reason": "test",
      "status": "Reject",
      "priority": "Medium",
      "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...