Skip to main content
GET
The maintenance plan register.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

inspection_template_id
string
inspection_template_code
string
inspection_template_name
string
raises_inspection
string
id
string
plan_number
string
name
string
description
string
work_order_type_id
string
maintenance_type
string
maintenance_type_name
string
status
string
status_label
string
status_category
string
site_id
string
site_code
string
work_order_priority_id
string
priority_code
string
priority_name
string
criticality
string
trigger_combination
string
estimated_duration_minutes
string
lead_time_days
string
tolerance_days
string
sla_response_minutes
string
sla_resolution_minutes
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
assigned_to_user_id
string
assigned_to_user_name
string
end_date
string
reminder_days
string
use_contract_visits
string
requires_permit
string
requires_shutdown
string
safety_instructions
string
instructions
string
auto_generate_work_order
string
current_version_number
string
last_generated_at
string
is_active
string
asset_count
string
asset_category_count
string
place_count
string
scope_names
string
asset_category_codes
string
asset_category_names
string
asset_names
string
place_names
string
task_count
string
requirement_count
string
trigger_count
string
frequency
string
next_due_at
string
work_orders_generated
string
custom_fields
string
row_version
string
created_at
string
created_by_id
string
created_by_name
string
created_source
string
updated_at
string
updated_by_id
string
updated_by_name
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

asset_category_codes
string[]
asset_category_count
integer<bigint>
asset_category_names
string<text>
asset_count
integer<bigint>
asset_names
string<text>
assigned_team_id
string<uuid>

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

assigned_team_name
string<character varying>
Maximum string length: 200
assigned_to_user_id
string<uuid>

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

assigned_to_user_name
string<character varying>
Maximum string length: 200
auto_generate_work_order
boolean<boolean>
created_at
string<timestamp with time zone>
created_by_id
string<uuid>

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

created_by_name
string<character varying>
Maximum string length: 200
created_source
string<text>
criticality
string<character varying>
Maximum string length: 40
current_version_number
integer<integer>
custom_fields
string<jsonb>
description
string<text>
end_date
string<date>
estimated_duration_minutes
integer<integer>
frequency
string<text>
id
string<uuid>

Note: This is a Primary Key.

inspection_template_code
string<character varying>
Maximum string length: 60
inspection_template_id
string<uuid>

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

inspection_template_name
string<character varying>
Maximum string length: 250
instructions
string<text>
is_active
boolean<boolean>
last_generated_at
string<timestamp with time zone>
lead_time_days
integer<integer>
maintenance_type
string<character varying>
Maximum string length: 40
maintenance_type_name
string<character varying>
Maximum string length: 150
name
string<character varying>
Maximum string length: 250
next_due_at
string<timestamp with time zone>
place_count
integer<bigint>
place_names
string<text>
plan_number
string<character varying>
Maximum string length: 60
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
priority_code
string<character varying>
Maximum string length: 40
priority_name
string<character varying>
Maximum string length: 150
raises_inspection
boolean<boolean>
reminder_days
integer<integer>
requirement_count
integer<bigint>
requires_permit
boolean<boolean>
requires_shutdown
boolean<boolean>
row_version
integer<bigint>
safety_instructions
string<text>
scope_names
string[]
site_code
string<character varying>
Maximum string length: 50
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

sla_resolution_minutes
integer<integer>
sla_response_minutes
integer<integer>
status
string<character varying>
Maximum string length: 60
status_category
string<character varying>
Maximum string length: 20
status_label
string<text>
task_count
integer<bigint>
tolerance_days
integer<integer>
trigger_combination
string<character varying>
Maximum string length: 10
trigger_count
integer<bigint>
updated_at
string<timestamp with time zone>
updated_by_id
string<uuid>

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

updated_by_name
string<character varying>
Maximum string length: 200
use_contract_visits
boolean<boolean>
work_order_priority_id
string<uuid>

Note: This is a Foreign Key to request_severity_priorities.work_order_priority_id.

work_order_type_id
string<uuid>

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

work_orders_generated
integer<bigint>