> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# The asset classification as a tree, with everything that leans on each node.
> Assets filed directly against it and assets anywhere beneath it, the maintenance plans scoped to it,
the contracts covering it, its models and its class bill of materials.
site_ids is the rule this category states itself; applies_at_site_ids is the one that governs it,
inherited from the nearest category above that states one. NULL there means everywhere, not
nowhere.
## OpenAPI
````yaml /api-reference/openapi.json get /asset_category_settings
openapi: 3.0.0
info:
description: ''
title: >-
The only schema PostgREST exposes. Reads are security_invoker views; writes
are SECURITY DEFINER functions. Rebuilt wholesale on every deploy — it holds
no data.
version: 12.2.3
servers:
- url: https://app.assetinfinity.ai/api
security: []
tags:
- name: Signing in
- name: Profile
- name: Assets
- name: Asset lifecycle
- name: Work lifecycle
- name: Maintenance
- name: Inventory
- name: Inventory detail
- name: Procurement
- name: Contracts
- name: Workforce
- name: Capacity
- name: Dispatch
- name: Tools
- name: Inspections
- name: Verification
- name: Reliability
- name: Parts demand
- name: Sensors and meters
- name: Map
- name: Floor plans
- name: Labels
- name: Lost and found
- name: Root cause analysis
- name: Reports
- name: Audit center
- name: Activity
- name: Notifications
- name: Channels
- name: Search
- name: Copilot
- name: Import
- name: Files
- name: Sync
- name: Support
- name: Admin
- name: Access
- name: Lookups
- name: Read models
- name: Branding
- name: Custom fields
- name: Form studio
- name: Workflows
- name: Workflow studio
- name: Rules
- name: Statuses and transitions
- name: Currencies and locales
- name: Work configuration
- name: Asset configuration
- name: Inventory configuration
- name: Tool configuration
- name: Workforce configuration
- name: Vendor and contract configuration
- name: Document configuration
- name: Inspection configuration
- name: Sites, locations and the organisation
- name: Platform
- name: Amendments
- name: Asset clone
- name: Asset components
- name: Asset register
- name: Asset transfer
- name: Audit feed
- name: Billing
- name: Bookings
- name: Budgets
- name: Bulk jobs
- name: Calibration history
- name: Capex plans
- name: Conversations
- name: Costing
- name: Currency
- name: Dashboards
- name: Directory sync
- name: Document control
- name: Document folders
- name: Document tree
- name: Documents
- name: Energy
- name: Extracts
- name: Features
- name: Feeds
- name: File exchange
- name: Filing exceptions
- name: Finance
- name: Inbound mail
- name: Keys
- name: Knowledge
- name: Licence
- name: List views
- name: Locations
- name: Mapping
- name: Mcp
- name: Mcp oauth
- name: Mfa
- name: Numbering
- name: Permits
- name: Readers
- name: Reference
- name: Reference columns
- name: Reference entry
- name: Release
- name: Scim
- name: Security streams
- name: Self verification
- name: Setup
- name: Shutdown
- name: Sso
- name: Telegram
- name: Tenant switch
- name: The caller's own work
- name: The checklist library
- name: Tools on a job, and who has them out
- name: Tray
- name: Vendor spend forecast
- name: Vendors and contracts
- name: Visitors
- name: Work order execution
- name: Work sequencing
- name: Workforce detail
externalDocs:
description: PostgREST Documentation
url: https://postgrest.org/en/v12/references/api.html
paths:
/asset_category_settings:
get:
tags:
- Asset configuration
summary: >-
The asset classification as a tree, with everything that leans on each
node.
description: >-
Assets filed directly against it and assets anywhere beneath it, the
maintenance plans scoped to it,
the contracts covering it, its models and its class bill of materials.
site_ids is the rule this category states itself; applies_at_site_ids is
the one that governs it,
inherited from the nearest category above that states one. NULL there
means everywhere, not
nowhere.
parameters:
- $ref: '#/components/parameters/rowFilter.asset_category_settings.id'
- $ref: '#/components/parameters/rowFilter.asset_category_settings.parent_id'
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.parent_name
- $ref: '#/components/parameters/rowFilter.asset_category_settings.code'
- $ref: '#/components/parameters/rowFilter.asset_category_settings.name'
- $ref: '#/components/parameters/rowFilter.asset_category_settings.path'
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.description
- $ref: '#/components/parameters/rowFilter.asset_category_settings.depth'
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.default_criticality_id
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.default_criticality
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.default_criticality_rank
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.expected_life_months
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.requires_calibration
- $ref: '#/components/parameters/rowFilter.asset_category_settings.is_active'
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.allows_direct_filing
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.takes_filing
- $ref: '#/components/parameters/rowFilter.asset_category_settings.site_ids'
- $ref: '#/components/parameters/rowFilter.asset_category_settings.site_names'
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.applies_at_site_ids
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.applies_at_site_names
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.site_scope_inherited_from
- $ref: '#/components/parameters/rowFilter.asset_category_settings.children'
- $ref: '#/components/parameters/rowFilter.asset_category_settings.assets'
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.assets_in_branch
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.maintenance_plans
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.contracts_covering
- $ref: '#/components/parameters/rowFilter.asset_category_settings.models'
- $ref: '#/components/parameters/rowFilter.asset_category_settings.bom_lines'
- $ref: >-
#/components/parameters/rowFilter.asset_category_settings.row_version
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/range'
- $ref: '#/components/parameters/rangeUnit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/preferCount'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/asset_category_settings'
type: array
application/vnd.pgrst.object+json:
schema:
items:
$ref: '#/components/schemas/asset_category_settings'
type: array
application/vnd.pgrst.object+json;nulls=stripped:
schema:
items:
$ref: '#/components/schemas/asset_category_settings'
type: array
text/csv:
schema:
items:
$ref: '#/components/schemas/asset_category_settings'
type: array
description: OK
'206':
description: Partial Content
components:
parameters:
rowFilter.asset_category_settings.id:
in: query
name: id
required: false
schema:
type: string
rowFilter.asset_category_settings.parent_id:
in: query
name: parent_id
required: false
schema:
type: string
rowFilter.asset_category_settings.parent_name:
in: query
name: parent_name
required: false
schema:
type: string
rowFilter.asset_category_settings.code:
in: query
name: code
required: false
schema:
type: string
rowFilter.asset_category_settings.name:
in: query
name: name
required: false
schema:
type: string
rowFilter.asset_category_settings.path:
in: query
name: path
required: false
schema:
type: string
rowFilter.asset_category_settings.description:
in: query
name: description
required: false
schema:
type: string
rowFilter.asset_category_settings.depth:
in: query
name: depth
required: false
schema:
type: string
rowFilter.asset_category_settings.default_criticality_id:
in: query
name: default_criticality_id
required: false
schema:
type: string
rowFilter.asset_category_settings.default_criticality:
in: query
name: default_criticality
required: false
schema:
type: string
rowFilter.asset_category_settings.default_criticality_rank:
in: query
name: default_criticality_rank
required: false
schema:
type: string
rowFilter.asset_category_settings.expected_life_months:
in: query
name: expected_life_months
required: false
schema:
type: string
rowFilter.asset_category_settings.requires_calibration:
in: query
name: requires_calibration
required: false
schema:
type: string
rowFilter.asset_category_settings.is_active:
in: query
name: is_active
required: false
schema:
type: string
rowFilter.asset_category_settings.allows_direct_filing:
in: query
name: allows_direct_filing
required: false
schema:
type: string
rowFilter.asset_category_settings.takes_filing:
in: query
name: takes_filing
required: false
schema:
type: string
rowFilter.asset_category_settings.site_ids:
in: query
name: site_ids
required: false
schema:
type: string
rowFilter.asset_category_settings.site_names:
in: query
name: site_names
required: false
schema:
type: string
rowFilter.asset_category_settings.applies_at_site_ids:
in: query
name: applies_at_site_ids
required: false
schema:
type: string
rowFilter.asset_category_settings.applies_at_site_names:
in: query
name: applies_at_site_names
required: false
schema:
type: string
rowFilter.asset_category_settings.site_scope_inherited_from:
in: query
name: site_scope_inherited_from
required: false
schema:
type: string
rowFilter.asset_category_settings.children:
in: query
name: children
required: false
schema:
type: string
rowFilter.asset_category_settings.assets:
in: query
name: assets
required: false
schema:
type: string
rowFilter.asset_category_settings.assets_in_branch:
in: query
name: assets_in_branch
required: false
schema:
type: string
rowFilter.asset_category_settings.maintenance_plans:
in: query
name: maintenance_plans
required: false
schema:
type: string
rowFilter.asset_category_settings.contracts_covering:
in: query
name: contracts_covering
required: false
schema:
type: string
rowFilter.asset_category_settings.models:
in: query
name: models
required: false
schema:
type: string
rowFilter.asset_category_settings.bom_lines:
in: query
name: bom_lines
required: false
schema:
type: string
rowFilter.asset_category_settings.row_version:
in: query
name: row_version
required: false
schema:
type: string
select:
description: Filtering Columns
in: query
name: select
required: false
schema:
type: string
order:
description: Ordering
in: query
name: order
required: false
schema:
type: string
range:
description: Limiting and Pagination
in: header
name: Range
required: false
schema:
type: string
rangeUnit:
description: Limiting and Pagination
in: header
name: Range-Unit
required: false
schema:
default: items
type: string
offset:
description: Limiting and Pagination
in: query
name: offset
required: false
schema:
type: string
limit:
description: Limiting and Pagination
in: query
name: limit
required: false
schema:
type: string
preferCount:
description: Preference
in: header
name: Prefer
required: false
schema:
enum:
- count=none
type: string
schemas:
asset_category_settings:
description: >-
The asset classification as a tree, with everything that leans on each
node.
Assets filed directly against it and assets anywhere beneath it, the
maintenance plans scoped to it,
the contracts covering it, its models and its class bill of materials.
site_ids is the rule this category states itself; applies_at_site_ids is
the one that governs it,
inherited from the nearest category above that states one. NULL there
means everywhere, not
nowhere.
properties:
allows_direct_filing:
format: boolean
type: boolean
applies_at_site_ids:
format: uuid[]
items:
type: string
type: array
applies_at_site_names:
format: character varying[]
items:
type: string
type: array
assets:
format: bigint
type: integer
assets_in_branch:
format: bigint
type: integer
bom_lines:
format: bigint
type: integer
children:
format: bigint
type: integer
code:
format: character varying
maxLength: 60
type: string
contracts_covering:
format: bigint
type: integer
default_criticality:
format: character varying
maxLength: 120
type: string
default_criticality_id:
description: >-
Note:
This is a Foreign Key to `criticality_settings.id`.
format: uuid
type: string
default_criticality_rank:
format: smallint
type: integer
depth:
format: smallint
type: integer
description:
format: text
type: string
expected_life_months:
format: integer
type: integer
id:
description: |-
Note:
This is a Primary Key.
format: uuid
type: string
is_active:
format: boolean
type: boolean
maintenance_plans:
format: bigint
type: integer
models:
format: bigint
type: integer
name:
format: character varying
maxLength: 200
type: string
parent_id:
description: >-
Note:
This is a Foreign Key to `asset_categories.id`.
format: uuid
type: string
parent_name:
format: character varying
maxLength: 200
type: string
path:
format: text
type: string
requires_calibration:
format: boolean
type: boolean
row_version:
format: bigint
type: integer
site_ids:
format: uuid[]
items:
type: string
type: array
site_names:
format: character varying[]
items:
type: string
type: array
site_scope_inherited_from:
format: character varying
maxLength: 200
type: string
takes_filing:
format: boolean
type: boolean
type: object
````