> ## 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.

# Every administered entity, with what the calling user may do to it (ADR-017).



## OpenAPI

````yaml /api-reference/openapi.json patch /entity_definitions
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_definitions:
    patch:
      tags:
        - Admin
      summary: >-
        Every administered entity, with what the calling user may do to it
        (ADR-017).
      parameters:
        - $ref: '#/components/parameters/rowFilter.entity_definitions.entity'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.schema_name'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.table_name'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.label'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.plural'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.group'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.permission'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.title_column'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.parent_column'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.order_by'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.allows_delete'
        - $ref: >-
            #/components/parameters/rowFilter.entity_definitions.supports_attachments
        - $ref: '#/components/parameters/rowFilter.entity_definitions.can_create'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.can_edit'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.can_delete'
        - $ref: '#/components/parameters/rowFilter.entity_definitions.can_import'
        - $ref: >-
            #/components/parameters/rowFilter.entity_definitions.allows_import_create
        - $ref: '#/components/parameters/rowFilter.entity_definitions.import_depth'
        - $ref: '#/components/parameters/preferReturn'
      requestBody:
        $ref: '#/components/requestBodies/entity_definitions'
      responses:
        '204':
          description: No Content
components:
  parameters:
    rowFilter.entity_definitions.entity:
      in: query
      name: entity
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.schema_name:
      in: query
      name: schema_name
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.table_name:
      in: query
      name: table_name
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.label:
      in: query
      name: label
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.plural:
      in: query
      name: plural
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.group:
      in: query
      name: group
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.permission:
      in: query
      name: permission
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.title_column:
      in: query
      name: title_column
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.parent_column:
      in: query
      name: parent_column
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.order_by:
      in: query
      name: order_by
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.allows_delete:
      in: query
      name: allows_delete
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.supports_attachments:
      in: query
      name: supports_attachments
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.can_create:
      in: query
      name: can_create
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.can_edit:
      in: query
      name: can_edit
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.can_delete:
      in: query
      name: can_delete
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.can_import:
      in: query
      name: can_import
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.allows_import_create:
      in: query
      name: allows_import_create
      required: false
      schema:
        type: string
    rowFilter.entity_definitions.import_depth:
      in: query
      name: import_depth
      required: false
      schema:
        type: string
    preferReturn:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - return=representation
          - return=minimal
          - return=none
        type: string
  requestBodies:
    entity_definitions:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/entity_definitions'
        application/vnd.pgrst.object+json:
          schema:
            $ref: '#/components/schemas/entity_definitions'
        application/vnd.pgrst.object+json;nulls=stripped:
          schema:
            $ref: '#/components/schemas/entity_definitions'
        text/csv:
          schema:
            $ref: '#/components/schemas/entity_definitions'
      description: entity_definitions
  schemas:
    entity_definitions:
      description: >-
        Every administered entity, with what the calling user may do to it
        (ADR-017).
      properties:
        allows_delete:
          format: boolean
          type: boolean
        allows_import_create:
          format: boolean
          type: boolean
        can_create:
          format: boolean
          type: boolean
        can_delete:
          format: boolean
          type: boolean
        can_edit:
          format: boolean
          type: boolean
        can_import:
          format: boolean
          type: boolean
        entity:
          format: character varying
          maxLength: 80
          type: string
        group:
          format: character varying
          maxLength: 60
          type: string
        import_depth:
          format: integer
          type: integer
        label:
          format: character varying
          maxLength: 120
          type: string
        order_by:
          format: character varying
          maxLength: 120
          type: string
        parent_column:
          format: character varying
          maxLength: 63
          type: string
        permission:
          format: character varying
          maxLength: 80
          type: string
        plural:
          format: character varying
          maxLength: 140
          type: string
        schema_name:
          format: character varying
          maxLength: 40
          type: string
        supports_attachments:
          format: boolean
          type: boolean
        table_name:
          format: character varying
          maxLength: 60
          type: string
        title_column:
          format: character varying
          maxLength: 63
          type: string
      type: object

````

## Related topics

- [Administered lists](/config/administered-lists.md)
- [Copilot activity](/analytics/copilot.md)
- [Sites and organisation](/setup/sites.md)
- [Ways to sign in](/setup/sign-in-methods.md)
- [Role reference](/setup/roles.md)
