> ## 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 writable columns per administered entity, generated from the model.

> A form is built from this, and the write RPCs refuse any key that is not here.



## OpenAPI

````yaml /api-reference/openapi.json get /entity_fields
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:
  /entity_fields:
    get:
      tags:
        - Admin
      summary: The writable columns per administered entity, generated from the model.
      description: >-
        A form is built from this, and the write RPCs refuse any key that is not
        here.
      parameters:
        - $ref: '#/components/parameters/rowFilter.entity_fields.entity'
        - $ref: '#/components/parameters/rowFilter.entity_fields.column_name'
        - $ref: '#/components/parameters/rowFilter.entity_fields.label'
        - $ref: '#/components/parameters/rowFilter.entity_fields.data_type'
        - $ref: '#/components/parameters/rowFilter.entity_fields.is_required'
        - $ref: '#/components/parameters/rowFilter.entity_fields.is_nullable'
        - $ref: '#/components/parameters/rowFilter.entity_fields.default_value'
        - $ref: '#/components/parameters/rowFilter.entity_fields.is_immutable'
        - $ref: '#/components/parameters/rowFilter.entity_fields.references_entity'
        - $ref: >-
            #/components/parameters/rowFilter.entity_fields.references_title_column
        - $ref: '#/components/parameters/rowFilter.entity_fields.references_label'
        - $ref: >-
            #/components/parameters/rowFilter.entity_fields.references_allows_create
        - $ref: '#/components/parameters/rowFilter.entity_fields.scope_column'
        - $ref: '#/components/parameters/rowFilter.entity_fields.scope_target_column'
        - $ref: '#/components/parameters/rowFilter.entity_fields.allowed_values'
        - $ref: '#/components/parameters/rowFilter.entity_fields.sort_order'
        - $ref: '#/components/parameters/rowFilter.entity_fields.comment'
        - $ref: '#/components/parameters/rowFilter.entity_fields.section'
        - $ref: '#/components/parameters/rowFilter.entity_fields.section_label'
        - $ref: '#/components/parameters/rowFilter.entity_fields.section_hint'
        - $ref: '#/components/parameters/rowFilter.entity_fields.hint'
        - $ref: '#/components/parameters/rowFilter.entity_fields.widget'
        - $ref: '#/components/parameters/rowFilter.entity_fields.companion_column'
        - $ref: '#/components/parameters/rowFilter.entity_fields.is_hidden'
        - $ref: >-
            #/components/parameters/rowFilter.entity_fields.companion_references_entity
        - $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/entity_fields'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/entity_fields'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/entity_fields'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/entity_fields'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.entity_fields.entity:
      in: query
      name: entity
      required: false
      schema:
        type: string
    rowFilter.entity_fields.column_name:
      in: query
      name: column_name
      required: false
      schema:
        type: string
    rowFilter.entity_fields.label:
      in: query
      name: label
      required: false
      schema:
        type: string
    rowFilter.entity_fields.data_type:
      in: query
      name: data_type
      required: false
      schema:
        type: string
    rowFilter.entity_fields.is_required:
      in: query
      name: is_required
      required: false
      schema:
        type: string
    rowFilter.entity_fields.is_nullable:
      in: query
      name: is_nullable
      required: false
      schema:
        type: string
    rowFilter.entity_fields.default_value:
      in: query
      name: default_value
      required: false
      schema:
        type: string
    rowFilter.entity_fields.is_immutable:
      in: query
      name: is_immutable
      required: false
      schema:
        type: string
    rowFilter.entity_fields.references_entity:
      in: query
      name: references_entity
      required: false
      schema:
        type: string
    rowFilter.entity_fields.references_title_column:
      in: query
      name: references_title_column
      required: false
      schema:
        type: string
    rowFilter.entity_fields.references_label:
      in: query
      name: references_label
      required: false
      schema:
        type: string
    rowFilter.entity_fields.references_allows_create:
      in: query
      name: references_allows_create
      required: false
      schema:
        type: string
    rowFilter.entity_fields.scope_column:
      in: query
      name: scope_column
      required: false
      schema:
        type: string
    rowFilter.entity_fields.scope_target_column:
      in: query
      name: scope_target_column
      required: false
      schema:
        type: string
    rowFilter.entity_fields.allowed_values:
      in: query
      name: allowed_values
      required: false
      schema:
        type: string
    rowFilter.entity_fields.sort_order:
      in: query
      name: sort_order
      required: false
      schema:
        type: string
    rowFilter.entity_fields.comment:
      in: query
      name: comment
      required: false
      schema:
        type: string
    rowFilter.entity_fields.section:
      in: query
      name: section
      required: false
      schema:
        type: string
    rowFilter.entity_fields.section_label:
      in: query
      name: section_label
      required: false
      schema:
        type: string
    rowFilter.entity_fields.section_hint:
      in: query
      name: section_hint
      required: false
      schema:
        type: string
    rowFilter.entity_fields.hint:
      in: query
      name: hint
      required: false
      schema:
        type: string
    rowFilter.entity_fields.widget:
      in: query
      name: widget
      required: false
      schema:
        type: string
    rowFilter.entity_fields.companion_column:
      in: query
      name: companion_column
      required: false
      schema:
        type: string
    rowFilter.entity_fields.is_hidden:
      in: query
      name: is_hidden
      required: false
      schema:
        type: string
    rowFilter.entity_fields.companion_references_entity:
      in: query
      name: companion_references_entity
      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:
    entity_fields:
      description: >-
        The writable columns per administered entity, generated from the model.


        A form is built from this, and the write RPCs refuse any key that is not
        here.
      properties:
        allowed_values:
          format: text[]
          items:
            type: string
          type: array
        column_name:
          format: character varying
          maxLength: 63
          type: string
        comment:
          format: text
          type: string
        companion_column:
          format: character varying
          maxLength: 63
          type: string
        companion_references_entity:
          format: character varying
          maxLength: 80
          type: string
        data_type:
          format: character varying
          maxLength: 40
          type: string
        default_value:
          format: text
          type: string
        entity:
          description: >-
            Note:

            This is a Foreign Key to `custom_field_scopes.entity`.<fk
            table='custom_field_scopes' column='entity'/>
          format: character varying
          maxLength: 80
          type: string
        hint:
          format: text
          type: string
        is_hidden:
          format: boolean
          type: boolean
        is_immutable:
          format: boolean
          type: boolean
        is_nullable:
          format: boolean
          type: boolean
        is_required:
          format: boolean
          type: boolean
        label:
          format: character varying
          maxLength: 120
          type: string
        references_allows_create:
          format: boolean
          type: boolean
        references_entity:
          format: character varying
          maxLength: 80
          type: string
        references_label:
          format: character varying
          maxLength: 120
          type: string
        references_title_column:
          format: character varying
          maxLength: 63
          type: string
        scope_column:
          format: character varying
          maxLength: 63
          type: string
        scope_target_column:
          format: character varying
          maxLength: 63
          type: string
        section:
          format: character varying
          maxLength: 60
          type: string
        section_hint:
          format: text
          type: string
        section_label:
          format: character varying
          type: string
        sort_order:
          format: integer
          type: integer
        widget:
          format: character varying
          maxLength: 30
          type: string
      type: object

````

## Related topics

- [The asset register](/assets/register.md)
- [Administered lists](/config/administered-lists.md)
- [The asset lifecycle](/assets/lifecycle.md)
- [Sites and organisation](/setup/sites.md)
- [The dispatch board](/work/dispatch.md)