> ## 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 statuses each register can be in, with how the screens should draw them.



## OpenAPI

````yaml /api-reference/openapi.json get /state_settings
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes (ADR-014). 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: Routing
  - 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: Self verification
  - name: Setup
  - name: Tools on a job, and who has them out
  - name: Vendors and contracts
  - name: Work order execution
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /state_settings:
    get:
      tags:
        - Statuses and transitions
      summary: >-
        The statuses each register can be in, with how the screens should draw
        them.
      parameters:
        - $ref: '#/components/parameters/rowFilter.state_settings.id'
        - $ref: '#/components/parameters/rowFilter.state_settings.entity_type'
        - $ref: '#/components/parameters/rowFilter.state_settings.state_model_id'
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.state_model_version_id
        - $ref: '#/components/parameters/rowFilter.state_settings.code'
        - $ref: '#/components/parameters/rowFilter.state_settings.display_name'
        - $ref: '#/components/parameters/rowFilter.state_settings.category'
        - $ref: '#/components/parameters/rowFilter.state_settings.color'
        - $ref: '#/components/parameters/rowFilter.state_settings.icon'
        - $ref: '#/components/parameters/rowFilter.state_settings.sort_order'
        - $ref: '#/components/parameters/rowFilter.state_settings.is_active'
        - $ref: '#/components/parameters/rowFilter.state_settings.is_initial'
        - $ref: '#/components/parameters/rowFilter.state_settings.is_terminal'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_open'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_active'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_downtime'
        - $ref: '#/components/parameters/rowFilter.state_settings.counts_as_accepted'
        - $ref: '#/components/parameters/rowFilter.state_settings.stops_sla'
        - $ref: '#/components/parameters/rowFilter.state_settings.pauses_sla'
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.allows_technician_edit
        - $ref: >-
            #/components/parameters/rowFilter.state_settings.allows_parts_consumption
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_labour_entry'
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_attachments'
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_cancellation'
        - $ref: '#/components/parameters/rowFilter.state_settings.allows_reopen'
        - $ref: '#/components/parameters/rowFilter.state_settings.offline_allowed'
        - $ref: '#/components/parameters/rowFilter.state_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/state_settings'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/state_settings'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/state_settings'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/state_settings'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.state_settings.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.state_settings.entity_type:
      in: query
      name: entity_type
      required: false
      schema:
        type: string
    rowFilter.state_settings.state_model_id:
      in: query
      name: state_model_id
      required: false
      schema:
        type: string
    rowFilter.state_settings.state_model_version_id:
      in: query
      name: state_model_version_id
      required: false
      schema:
        type: string
    rowFilter.state_settings.code:
      in: query
      name: code
      required: false
      schema:
        type: string
    rowFilter.state_settings.display_name:
      in: query
      name: display_name
      required: false
      schema:
        type: string
    rowFilter.state_settings.category:
      in: query
      name: category
      required: false
      schema:
        type: string
    rowFilter.state_settings.color:
      in: query
      name: color
      required: false
      schema:
        type: string
    rowFilter.state_settings.icon:
      in: query
      name: icon
      required: false
      schema:
        type: string
    rowFilter.state_settings.sort_order:
      in: query
      name: sort_order
      required: false
      schema:
        type: string
    rowFilter.state_settings.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.state_settings.is_initial:
      in: query
      name: is_initial
      required: false
      schema:
        type: string
    rowFilter.state_settings.is_terminal:
      in: query
      name: is_terminal
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_open:
      in: query
      name: counts_as_open
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_active:
      in: query
      name: counts_as_active
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_downtime:
      in: query
      name: counts_as_downtime
      required: false
      schema:
        type: string
    rowFilter.state_settings.counts_as_accepted:
      in: query
      name: counts_as_accepted
      required: false
      schema:
        type: string
    rowFilter.state_settings.stops_sla:
      in: query
      name: stops_sla
      required: false
      schema:
        type: string
    rowFilter.state_settings.pauses_sla:
      in: query
      name: pauses_sla
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_technician_edit:
      in: query
      name: allows_technician_edit
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_parts_consumption:
      in: query
      name: allows_parts_consumption
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_labour_entry:
      in: query
      name: allows_labour_entry
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_attachments:
      in: query
      name: allows_attachments
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_cancellation:
      in: query
      name: allows_cancellation
      required: false
      schema:
        type: string
    rowFilter.state_settings.allows_reopen:
      in: query
      name: allows_reopen
      required: false
      schema:
        type: string
    rowFilter.state_settings.offline_allowed:
      in: query
      name: offline_allowed
      required: false
      schema:
        type: string
    rowFilter.state_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:
    state_settings:
      description: >-
        The statuses each register can be in, with how the screens should draw
        them.
      properties:
        allows_attachments:
          format: boolean
          type: boolean
        allows_cancellation:
          format: boolean
          type: boolean
        allows_labour_entry:
          format: boolean
          type: boolean
        allows_parts_consumption:
          format: boolean
          type: boolean
        allows_reopen:
          format: boolean
          type: boolean
        allows_technician_edit:
          format: boolean
          type: boolean
        category:
          format: character varying
          maxLength: 20
          type: string
        code:
          format: character varying
          maxLength: 60
          type: string
        color:
          format: character varying
          maxLength: 20
          type: string
        counts_as_accepted:
          format: boolean
          type: boolean
        counts_as_active:
          format: boolean
          type: boolean
        counts_as_downtime:
          format: boolean
          type: boolean
        counts_as_open:
          format: boolean
          type: boolean
        display_name:
          format: character varying
          maxLength: 150
          type: string
        entity_type:
          format: character varying
          maxLength: 80
          type: string
        icon:
          format: character varying
          maxLength: 60
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_active:
          format: boolean
          type: boolean
        is_initial:
          format: boolean
          type: boolean
        is_terminal:
          format: boolean
          type: boolean
        offline_allowed:
          format: boolean
          type: boolean
        pauses_sla:
          format: boolean
          type: boolean
        row_version:
          format: bigint
          type: integer
        sort_order:
          format: integer
          type: integer
        state_model_id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        state_model_version_id:
          description: >-
            Note:

            This is a Foreign Key to `state_models.version_id`.<fk
            table='state_models' column='version_id'/>
          format: uuid
          type: string
        stops_sla:
          format: boolean
          type: boolean
      type: object

````

## Related topics

- [Setting up the plant](/setup/overview.md)
- [Statuses and transitions](/config/statuses.md)
- [Lost & Found](/work/lost-and-found.md)
- [The asset register](/assets/register.md)
- [Root cause and corrective actions](/assets/root-cause.md)