> ## 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 software catalogue: each product under its publisher, with what the organisation allows of
> it (policy: ALLOWED, BLOCKED or UNREVIEWED), whether it needs a licence, how many raw names from the
scans mean it, on how many devices it is installed now, and how many entitlements for it are in
force or still to come.
## OpenAPI
````yaml /api-reference/openapi.json get /software_products
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_products:
get:
tags:
- Itam software
summary: >-
The software catalogue: each product under its publisher, with what the
organisation allows of
description: >-
it (policy: ALLOWED, BLOCKED or UNREVIEWED), whether it needs a licence,
how many raw names from the
scans mean it, on how many devices it is installed now, and how many
entitlements for it are in
force or still to come.
parameters:
- $ref: '#/components/parameters/rowFilter.software_products.id'
- $ref: '#/components/parameters/rowFilter.software_products.publisher_id'
- $ref: '#/components/parameters/rowFilter.software_products.publisher_name'
- $ref: '#/components/parameters/rowFilter.software_products.name'
- $ref: '#/components/parameters/rowFilter.software_products.category'
- $ref: '#/components/parameters/rowFilter.software_products.requires_licence'
- $ref: '#/components/parameters/rowFilter.software_products.policy'
- $ref: '#/components/parameters/rowFilter.software_products.policy_reason'
- $ref: '#/components/parameters/rowFilter.software_products.policy_set_by'
- $ref: '#/components/parameters/rowFilter.software_products.policy_set_at'
- $ref: '#/components/parameters/rowFilter.software_products.from_catalogue'
- $ref: '#/components/parameters/rowFilter.software_products.names'
- $ref: '#/components/parameters/rowFilter.software_products.devices'
- $ref: '#/components/parameters/rowFilter.software_products.entitlements'
- $ref: '#/components/parameters/rowFilter.software_products.created_at'
- $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_products'
type: array
application/vnd.pgrst.object+json:
schema:
items:
$ref: '#/components/schemas/software_products'
type: array
application/vnd.pgrst.object+json;nulls=stripped:
schema:
items:
$ref: '#/components/schemas/software_products'
type: array
text/csv:
schema:
items:
$ref: '#/components/schemas/software_products'
type: array
description: OK
'206':
description: Partial Content
components:
parameters:
rowFilter.software_products.id:
in: query
name: id
required: false
schema:
type: string
rowFilter.software_products.publisher_id:
in: query
name: publisher_id
required: false
schema:
type: string
rowFilter.software_products.publisher_name:
in: query
name: publisher_name
required: false
schema:
type: string
rowFilter.software_products.name:
in: query
name: name
required: false
schema:
type: string
rowFilter.software_products.category:
in: query
name: category
required: false
schema:
type: string
rowFilter.software_products.requires_licence:
in: query
name: requires_licence
required: false
schema:
type: string
rowFilter.software_products.policy:
in: query
name: policy
required: false
schema:
type: string
rowFilter.software_products.policy_reason:
in: query
name: policy_reason
required: false
schema:
type: string
rowFilter.software_products.policy_set_by:
in: query
name: policy_set_by
required: false
schema:
type: string
rowFilter.software_products.policy_set_at:
in: query
name: policy_set_at
required: false
schema:
type: string
rowFilter.software_products.from_catalogue:
in: query
name: from_catalogue
required: false
schema:
type: string
rowFilter.software_products.names:
in: query
name: names
required: false
schema:
type: string
rowFilter.software_products.devices:
in: query
name: devices
required: false
schema:
type: string
rowFilter.software_products.entitlements:
in: query
name: entitlements
required: false
schema:
type: string
rowFilter.software_products.created_at:
in: query
name: created_at
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_products:
description: >-
The software catalogue: each product under its publisher, with what the
organisation allows of
it (policy: ALLOWED, BLOCKED or UNREVIEWED), whether it needs a licence,
how many raw names from the
scans mean it, on how many devices it is installed now, and how many
entitlements for it are in
force or still to come.
properties:
category:
format: character varying
maxLength: 30
type: string
created_at:
format: timestamp with time zone
type: string
devices:
format: bigint
type: integer
entitlements:
format: bigint
type: integer
from_catalogue:
format: boolean
type: boolean
id:
description: |-
Note:
This is a Primary Key.
format: uuid
type: string
name:
format: character varying
maxLength: 200
type: string
names:
format: bigint
type: integer
policy:
format: character varying
maxLength: 12
type: string
policy_reason:
format: text
type: string
policy_set_at:
format: timestamp with time zone
type: string
policy_set_by:
description: >-
Note:
This is a Foreign Key to `capex_invite_candidates.id`.
format: uuid
type: string
publisher_id:
description: >-
Note:
This is a Foreign Key to `software_installations.publisher_id`.
format: uuid
type: string
publisher_name:
format: character varying
maxLength: 200
type: string
requires_licence:
format: boolean
type: boolean
type: object
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.