Skip to main content
GET
The maintenance plans one asset is on, however it got there.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

asset_id
string
asset_number
string
maintenance_plan_id
string
plan_number
string
plan_name
string
plan_description
string
applied_via
string
named_directly
string
applied_by_category
string
via_parent_category
string
category_codes
string
category_names
string
status_id
string
plan_status
string
plan_status_label
string
plan_status_category
string
plan_is_active
string
work_order_type_id
string
maintenance_type
string
maintenance_type_name
string
raises_inspection
string
trigger_combination
string
frequency
string
trigger_count
string
assigned_team_id
string
assigned_team_name
string
preferred_worker_id
string
preferred_worker_name
string
preferred_vendor_id
string
preferred_vendor_name
string
applies_from
string
applies_to
string
schedule_anchor_date
string
is_covered
string
not_covered_reason
string
suppressed_by
string
suppression_reason
string
suppressed_from
string
suppressed_to
string
next_occurrence_id
string
next_due_at
string
next_is_overdue
string
next_work_order_id
string
next_work_order_number
string
open_occurrence_count
string
last_completed_at
string
rounds_completed
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

applied_by_category
boolean<boolean>
applied_via
string<text>
applies_from
string<date>
applies_to
string<date>
asset_id
string<uuid>
asset_number
string<character varying>
Maximum string length: 80
assigned_team_id
string<uuid>

Note: This is a Foreign Key to teams.id.

assigned_team_name
string<character varying>
Maximum string length: 200
category_codes
string<text>
category_names
string<text>
frequency
string<text>
is_covered
boolean<boolean>
last_completed_at
string<timestamp with time zone>
maintenance_plan_id
string<uuid>
maintenance_type
string<character varying>
Maximum string length: 40
maintenance_type_name
string<character varying>
Maximum string length: 150
named_directly
boolean<boolean>
next_due_at
string<timestamp with time zone>
next_is_overdue
boolean<boolean>
next_occurrence_id
string<uuid>

Note: This is a Primary Key.

next_work_order_id
string<uuid>

Note: This is a Primary Key.

next_work_order_number
string<character varying>
Maximum string length: 60
not_covered_reason
string<text>
open_occurrence_count
integer<bigint>
plan_description
string<text>
plan_is_active
boolean<boolean>
plan_name
string<character varying>
Maximum string length: 250
plan_number
string<character varying>
Maximum string length: 60
plan_status
string<character varying>
Maximum string length: 60
plan_status_category
string<character varying>
Maximum string length: 20
plan_status_label
string<character varying>
Maximum string length: 150
preferred_vendor_id
string<uuid>

Note: This is a Foreign Key to assignable_vendors.id.

preferred_vendor_name
string<character varying>
Maximum string length: 200
preferred_worker_id
string<uuid>

Note: This is a Foreign Key to assignable_workers.id.

preferred_worker_name
string<character varying>
Maximum string length: 200
raises_inspection
boolean<boolean>
rounds_completed
integer<bigint>
schedule_anchor_date
string<date>
status_id
string<uuid>

Note: This is a Foreign Key to my_work.status_id.

suppressed_by
string<character varying>
Maximum string length: 20
suppressed_from
string<date>
suppressed_to
string<date>
suppression_reason
string<text>
trigger_combination
string<character varying>
Maximum string length: 10
trigger_count
integer<bigint>
via_parent_category
boolean<boolean>
work_order_type_id
string<uuid>

Note: This is a Foreign Key to work_order_types.id.