List Work Orders By Location Id

GET 
/organizations/:organizationId/locations/:locationId/work-orders

List Work Orders By Location Id

Request

Path Parameters

organizationId stringrequired

The ID of organization.

locationId stringrequired

The ID of location.

Query Parameters

startDate numberrequired

The start date number of timestamp. (Default: 1700000000000)

endDate numberrequired

The end date number of timestamp. (Default: 1700000000000)

statuses string[]

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

priorities string[]

The status of work order. (Default: optional ; Options: Low, Medium, High, None)

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the work order.
workOrderId stringrequired
workRequestId stringrequired
organizationId stringrequired
locationId stringrequired
subject stringrequired
description stringrequired
type stringrequired
priority stringrequired
scheduleType stringrequired
assignee objectrequired
images string[]required
files string[]required
status stringrequired
timeTrackingType stringrequired
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
nextToken required

To retrieve the next set of results.

Example (from schema)

{
  "data": {
    "workOrderId": "string",
    "workRequestId": "string",
    "organizationId": "string",
    "locationId": "string",
    "subject": "string",
    "description": "string",
    "type": "string",
    "priority": "string",
    "scheduleType": "string",
    "assignee": {},
    "images": [
      "string"
    ],
    "files": [
      "string"
    ],
    "status": "string",
    "timeTrackingType": "string",
    "createdBy": "string",
    "createdAtDateString": "string",
    "createdAt": 0,
    "updatedAtDateString": "string",
    "updatedAt": 0
  }
}

Example

{
  "data": [
    {
      "workOrderId": "wo-workOrderId",
      "workRequestId": "wr-workRequestId",
      "organizationId": "o-organizationId",
      "locationId": "l-locationId",
      "subject": "IDT-WorkOrder",
      "description": "IDT-WorkOrder-Description",
      "type": "Normal",
      "priority": "Low",
      "scheduleType": "Daily",
      "assignee": [
        {
          "type": "Team",
          "id": "6d708f0e-xxxx-xxxx-xxxx-f0d9c59488ef"
        },
        {
          "type": "User",
          "id": "593b34c0-xxxx-xxxx-xxxx-a454c6f9f50d"
        }
      ],
      "images": [
        "Asset-Image.png"
      ],
      "files": [
        "Infodeck-Bot-0001.pdf"
      ],
      "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...