List Work Orders

This endpoint lists work orders.

GET /v1/work_order/list

cURL

curl --location --request GET 'https://api.stateset.com/v1/work_order' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "limit": 10,
    "offset": 0,
    "order_direction": "asc"
}'

Response

{
  "bill_of_materials_number": "123",
  "created_at": "2021-01-01T00:00:00.000Z",
  "created_by": "John Doe",
  "expected_completion_date": "2021-01-01T00:00:00.000Z",
  "id": "wo_123",
  "issue_date": "2021-01-01T00:00:00.000Z",
  "location": "123",
  "manufacture_order": "123",
  "memo": "123",
  "number": "123",
  "order_number": "123",
  "part": "123",
  "priority": "123",
  "site": "123",
  "status": "123",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "work_order_line_items": [
    {
      "id": "wo_123",
      "line_status": "123",
      "line_type": "123",
      "part_name": "123",
      "part_number": "123",
      "total_quantity": "123",
      "unit_quantity": "123",
      "work_order_number": "123"
    }
  ]
}

Body

limit · string · required

This is the limit of the work orders.

offset · string · required

This is the offset of the work orders.

order_direction · string · required

This is the order direction of the work orders.

Response

id · uuid

Unique identifier for the work order (primary key)

number · integer

Number associated with the work order

site · string

Site or location where the work order is being executed

work_order_type · string

Type of the work order

location · string

Location or site where the work order is applicable

part · string

Part or item associated with the work order

order_number · string

Identifier or reference to the order associated with the work order

manufacture_order · string

Identifier or reference to the manufacturing order associated with the work order

status · string

Current status or state of the work order

created_by · string

Name or identifier of the person who created the work order

created_at · string

Date and time when the work order was created

updated_at · string

Date and time when the work order was last updated

issue_date · string

Date when the work order was issued

expected_completion_date · string

Expected completion date for the work order

priority · string

Priority level or urgency of the work order

memo · string

Memo or additional notes related to the work order

bill_of_materials_number · integer

Number associated with the bill of materials related to the work order

actual_labor_hours · number

Actual labor hours spent on the work order

standard_labor_hours · number

Standard labor hours for the work order

capacity_utilization_id · uuid

Identifier for related capacity utilization data

bill_of_materials_id · uuid

Identifier for related bill of materials

cogs_data_id · uuid

Identifier for related COGS (Cost of Goods Sold) data

work_order_line_items · string

Show Show child attributes

id · string

Unique identifier for the line item

line_status · string

Status or state of the line item

line_type · string

Type or category of the line item

part_name · string

Name of the part or item included in the line Item

part_number · string

Number or code associated with the part or Item

total_quantity · string

Total quantity of the part or item required or used in the work order

unit_quantity · string

Quantity of the part or item required or used per unit in the work order

work_order_number · string

Number associated with the work order to which the line item belongs

cURL

curl --location --request GET 'https://api.stateset.com/v1/work_order' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "limit": 10,
    "offset": 0,
    "order_direction": "asc"
}'

Response

{
  "bill_of_materials_number": "123",
  "created_at": "2021-01-01T00:00:00.000Z",
  "created_by": "John Doe",
  "expected_completion_date": "2021-01-01T00:00:00.000Z",
  "id": "wo_123",
  "issue_date": "2021-01-01T00:00:00.000Z",
  "location": "123",
  "manufacture_order": "123",
  "memo": "123",
  "number": "123",
  "order_number": "123",
  "part": "123",
  "priority": "123",
  "site": "123",
  "status": "123",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "work_order_line_items": [
    {
      "id": "wo_123",
      "line_status": "123",
      "line_type": "123",
      "part_name": "123",
      "part_number": "123",
      "total_quantity": "123",
      "unit_quantity": "123",
      "work_order_number": "123"
    }
  ]
}

Work Order

Name	Type	Description
bill_of_materials_number	Text	Number associated with the bill of materials related to the work order
created_at	Date/Time	Date and time when the work order was created
created_by	Text	Name or identifier of the person who created the work order
expected_completion_date	Date	Expected completion date for the work order
id	Text	Unique identifier for the work order
issue_date	Date	Date when the work order was issued
location	Text	Location or site where the work order is applicable
manufacture_order	Text	Identifier or reference to the manufacturing order associated with the work order
memo	Text	Memo or additional notes related to the work order
number	Text	Number associated with the work order
order_number	Text	Identifier or reference to the order associated with the work order
part	Text	Part or item associated with the work order
priority	Text	Priority level or urgency of the work order
site	Text	Site or location where the work order is being executed
status	Text	Current status or state of the work order
updated_at	Date/Time	Date and time when the work order was last updated

Work Order Line Items

Name	Type	Description
id	Text	Unique identifier for the line item
line_status	Text	Status or state of the line item
line_type	Text	Type or category of the line item
part_name	Text	Name of the part or item included in the line item
part_number	Text	Number or code associated with the part or item
total_quantity	Numeric	Total quantity of the part or item required or used in the work order
unit_quantity	Numeric	Quantity of the part or item required or used per unit in the work order
work_order_number	Text	Number associated with the work order to which the line item belongs