> ## 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 Today layouts set for the whole organisation (no role) and for individual roles, lowest
> precedence first. Somebody holding several roles lands on the first of theirs that has one.
## OpenAPI
````yaml /api-reference/openapi.json get /today_layouts
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: Data exports
- name: Directory sync
- name: Document control
- name: Document folders
- name: Document tree
- name: Documents
- name: Energy
- name: Extracts
- name: Features
- name: Feeds
- name: Ffe plans
- 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: Today
- name: Tools on a job, and who has them out
- name: Tray
- name: Vendor spend forecast
- name: Vendors and contracts
- name: Visitors
- name: Webhooks
- name: Work order execution
- name: Work sequencing
- name: Workforce detail
externalDocs:
description: PostgREST Documentation
url: https://postgrest.org/en/v12/references/api.html
paths:
/today_layouts:
get:
tags:
- Today
summary: >-
The Today layouts set for the whole organisation (no role) and for
individual roles, lowest
description: >-
precedence first. Somebody holding several roles lands on the first of
theirs that has one.
parameters:
- $ref: '#/components/parameters/rowFilter.today_layouts.id'
- $ref: '#/components/parameters/rowFilter.today_layouts.role_id'
- $ref: '#/components/parameters/rowFilter.today_layouts.role_name'
- $ref: '#/components/parameters/rowFilter.today_layouts.role_code'
- $ref: '#/components/parameters/rowFilter.today_layouts.precedence'
- $ref: '#/components/parameters/rowFilter.today_layouts.layout'
- $ref: '#/components/parameters/rowFilter.today_layouts.updated_at'
- $ref: '#/components/parameters/rowFilter.today_layouts.updated_by_name'
- $ref: '#/components/parameters/rowFilter.today_layouts.holders'
- $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/today_layouts'
type: array
application/vnd.pgrst.object+json:
schema:
items:
$ref: '#/components/schemas/today_layouts'
type: array
application/vnd.pgrst.object+json;nulls=stripped:
schema:
items:
$ref: '#/components/schemas/today_layouts'
type: array
text/csv:
schema:
items:
$ref: '#/components/schemas/today_layouts'
type: array
description: OK
'206':
description: Partial Content
components:
parameters:
rowFilter.today_layouts.id:
in: query
name: id
required: false
schema:
type: string
rowFilter.today_layouts.role_id:
in: query
name: role_id
required: false
schema:
type: string
rowFilter.today_layouts.role_name:
in: query
name: role_name
required: false
schema:
type: string
rowFilter.today_layouts.role_code:
in: query
name: role_code
required: false
schema:
type: string
rowFilter.today_layouts.precedence:
in: query
name: precedence
required: false
schema:
type: string
rowFilter.today_layouts.layout:
in: query
name: layout
required: false
schema:
type: string
rowFilter.today_layouts.updated_at:
in: query
name: updated_at
required: false
schema:
type: string
rowFilter.today_layouts.updated_by_name:
in: query
name: updated_by_name
required: false
schema:
type: string
rowFilter.today_layouts.holders:
in: query
name: holders
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:
today_layouts:
description: >-
The Today layouts set for the whole organisation (no role) and for
individual roles, lowest
precedence first. Somebody holding several roles lands on the first of
theirs that has one.
properties:
holders:
format: integer
type: integer
id:
description: |-
Note:
This is a Primary Key.
format: uuid
type: string
layout:
format: jsonb
precedence:
format: integer
type: integer
role_code:
format: character varying
maxLength: 60
type: string
role_id:
description: >-
Note:
This is a Foreign Key to `role_settings.id`.
format: uuid
type: string
role_name:
format: character varying
maxLength: 150
type: string
updated_at:
format: timestamp with time zone
type: string
updated_by_name:
format: character varying
maxLength: 200
type: string
type: object
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.