GET workorders/{workOrderNumber}

Retrieves a specific work order and associated items

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workOrderNumber

string

Required

Body Parameters

None.

Response Information

Resource Description

WorkOrderDetailView
NameDescriptionTypeAdditional information
Items

Work order items

Collection of WorkOrderItem

None.

WorkOrderNumber

Third-party vendor's order number

string

Required

Max length: 20

Status

Work order status

string

Required

Max length: 30

CompletionDate

Work order completion date

date

None.

RequestDate

Work order request date

date

Required

TypeOfIssue

Type of issue: Unit vs. Community

string

Required

UnitId

Unit Id. Onlty required if TypeOfIssue is Unit

string

None.

WorkorderId

Pivotal Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "ItemId": 1,
      "Area": "sample string 2",
      "Asset": "sample string 3",
      "Issue": "sample string 4",
      "Details": "sample string 5",
      "WorkOrderId": 6
    },
    {
      "ItemId": 1,
      "Area": "sample string 2",
      "Asset": "sample string 3",
      "Issue": "sample string 4",
      "Details": "sample string 5",
      "WorkOrderId": 6
    }
  ],
  "WorkOrderNumber": "sample string 1",
  "Status": "sample string 2",
  "CompletionDate": "2025-05-19T03:05:31.6100226-07:00",
  "RequestDate": "2025-05-19T03:05:31.6100226-07:00",
  "TypeOfIssue": "sample string 4",
  "UnitId": "sample string 5",
  "WorkorderId": 6
}