> ## 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 licence position per product that needs a licence: how many devices have it, how many of
> those no entitlement covers, and the entitlements counted against them — device licences used and
unused, user licences assigned and unassigned, concurrent seats (recorded, not measured) and whether
a site or enterprise agreement makes it unlimited. position is COMPLIANT, SHORT (installed beyond
what is owned), UNLICENSED (installed and nothing owned), OVER_ASSIGNED (more people assigned than
user licences bought) or NOT_MEASURED (only concurrent seats, which nothing here meters). Counted
over the devices the reader may see.
## OpenAPI
````yaml /api-reference/openapi.json get /software_licence_position
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: Itam
- name: Itam software
- 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: Trackers
- 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:
/software_licence_position:
get:
tags:
- Itam software
summary: >-
The licence position per product that needs a licence: how many devices
have it, how many of
description: >-
those no entitlement covers, and the entitlements counted against them —
device licences used and
unused, user licences assigned and unassigned, concurrent seats
(recorded, not measured) and whether
a site or enterprise agreement makes it unlimited. position is
COMPLIANT, SHORT (installed beyond
what is owned), UNLICENSED (installed and nothing owned), OVER_ASSIGNED
(more people assigned than
user licences bought) or NOT_MEASURED (only concurrent seats, which
nothing here meters). Counted
over the devices the reader may see.
parameters:
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.product_id
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.product_name
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.publisher_id
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.publisher_name
- $ref: '#/components/parameters/rowFilter.software_licence_position.category'
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.requires_licence
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.installed
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.not_covered
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.device_licences
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.device_used
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.device_unused
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.user_licences
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.users_assigned
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.user_unassigned
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.users_over_assigned
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.concurrent_licences
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.unlimited
- $ref: >-
#/components/parameters/rowFilter.software_licence_position.entitlements
- $ref: '#/components/parameters/rowFilter.software_licence_position.position'
- $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/software_licence_position'
type: array
application/vnd.pgrst.object+json:
schema:
items:
$ref: '#/components/schemas/software_licence_position'
type: array
application/vnd.pgrst.object+json;nulls=stripped:
schema:
items:
$ref: '#/components/schemas/software_licence_position'
type: array
text/csv:
schema:
items:
$ref: '#/components/schemas/software_licence_position'
type: array
description: OK
'206':
description: Partial Content
components:
parameters:
rowFilter.software_licence_position.product_id:
in: query
name: product_id
required: false
schema:
type: string
rowFilter.software_licence_position.product_name:
in: query
name: product_name
required: false
schema:
type: string
rowFilter.software_licence_position.publisher_id:
in: query
name: publisher_id
required: false
schema:
type: string
rowFilter.software_licence_position.publisher_name:
in: query
name: publisher_name
required: false
schema:
type: string
rowFilter.software_licence_position.category:
in: query
name: category
required: false
schema:
type: string
rowFilter.software_licence_position.requires_licence:
in: query
name: requires_licence
required: false
schema:
type: string
rowFilter.software_licence_position.installed:
in: query
name: installed
required: false
schema:
type: string
rowFilter.software_licence_position.not_covered:
in: query
name: not_covered
required: false
schema:
type: string
rowFilter.software_licence_position.device_licences:
in: query
name: device_licences
required: false
schema:
type: string
rowFilter.software_licence_position.device_used:
in: query
name: device_used
required: false
schema:
type: string
rowFilter.software_licence_position.device_unused:
in: query
name: device_unused
required: false
schema:
type: string
rowFilter.software_licence_position.user_licences:
in: query
name: user_licences
required: false
schema:
type: string
rowFilter.software_licence_position.users_assigned:
in: query
name: users_assigned
required: false
schema:
type: string
rowFilter.software_licence_position.user_unassigned:
in: query
name: user_unassigned
required: false
schema:
type: string
rowFilter.software_licence_position.users_over_assigned:
in: query
name: users_over_assigned
required: false
schema:
type: string
rowFilter.software_licence_position.concurrent_licences:
in: query
name: concurrent_licences
required: false
schema:
type: string
rowFilter.software_licence_position.unlimited:
in: query
name: unlimited
required: false
schema:
type: string
rowFilter.software_licence_position.entitlements:
in: query
name: entitlements
required: false
schema:
type: string
rowFilter.software_licence_position.position:
in: query
name: position
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:
software_licence_position:
description: >-
The licence position per product that needs a licence: how many devices
have it, how many of
those no entitlement covers, and the entitlements counted against them —
device licences used and
unused, user licences assigned and unassigned, concurrent seats
(recorded, not measured) and whether
a site or enterprise agreement makes it unlimited. position is
COMPLIANT, SHORT (installed beyond
what is owned), UNLICENSED (installed and nothing owned), OVER_ASSIGNED
(more people assigned than
user licences bought) or NOT_MEASURED (only concurrent seats, which
nothing here meters). Counted
over the devices the reader may see.
properties:
category:
format: character varying
maxLength: 30
type: string
concurrent_licences:
format: bigint
type: integer
device_licences:
format: bigint
type: integer
device_unused:
format: bigint
type: integer
device_used:
format: bigint
type: integer
entitlements:
format: bigint
type: integer
installed:
format: bigint
type: integer
not_covered:
format: bigint
type: integer
position:
format: text
type: string
product_id:
description: |-
Note:
This is a Primary Key.
format: uuid
type: string
product_name:
format: character varying
maxLength: 200
type: string
publisher_id:
description: |-
Note:
This is a Primary Key.
format: uuid
type: string
publisher_name:
format: character varying
maxLength: 200
type: string
requires_licence:
format: boolean
type: boolean
unlimited:
format: boolean
type: boolean
user_licences:
format: bigint
type: integer
user_unassigned:
format: bigint
type: integer
users_assigned:
format: bigint
type: integer
users_over_assigned:
format: bigint
type: integer
type: object
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.