Key Concepts

Note: IT Visibility is being upgraded with the introduction of Technology Intelligence Platform beginning in September 2024. Flexera will contact you directly regarding the timeframe of your upgrade. If you have already been upgraded to Technology Intelligence Platform, information in this section is applicable to you.

This section explains the following key concepts of the GraphQL.

•

Starting Points

•

Device—Computers, printers, network devices, virtual machines, containers, and other physical and virtual items collectively as represented in inventory and asset records (that is, “hardware inventory” and “hardware assets”), or Technopedia catalog information pertaining to these items (that is, “hardware model”).

•

Software—Any set of executable code that tells a computer or other device how to work. This includes middle-ware and system software including operating systems, as well as more end-user focused applications.

•

Operations—To filter the results of a query, you can use the following operations:

Operation	Example
eq (equal to)	devices(where: {name: {eq: "my_computer"}})
not eq (not equal to)	devices(where: {name: {not: {eq: "not_my_computer"}}})
gt (greater than)	devices(where: {numberOfProcessors: {gt: 2}})
lt (less than)	devices(where: {numberOfProcessors: {lt: 4}})
gte (greater than or equal to)	devices(where: {numberOfProcessors: {gte: 4}})
lte (less than or equal to)	devices(where: {numberOfProcessors: {lte: 2}})
contains	devices(where: {name: {contains: "flexera"}})
startsWith	devices(where: {domain: {startsWith: "flex"}})
endsWith	devices(where: {domain: {endsWith: ".com"}})
and	devices(where: [{domain: {startsWith: "flex"}}, {domain: {endsWith: ".com"}}])
or	devices(where: {or: [{domain: {endWith: ".org"}}, {domain: {endsWith: ".com"}}]})

•

@require Directive—Indicates that the particular field is required to be returned.

•

@flatten (if: Boolean) Directive—Indicates whether the nested fields should be flattened to the top level. This directive simplifies the data structure by bringing the nested fields to the top level, similar to a JOIN in SQL. Flattening is off by default unless text/csv is requested in the Accept HTTP header.

•

Basic Parameters—For matching of key fields, you can use the following parameters:

Parameters	Definition
id	The unique identifier for each record.
limit	The maximum number of records returned. For example, limit: 20 indicates that the query should return only 20 devices.
offset	The starting point from which the data should be retrieved. For example, devices(limit: 20, offset: 1000) indicates that the query should skip the first 1000 devices and start retrieving data from 1001 device onwards.
orderBy	The ordering criteria for the returned results. For example, devices(orderBy: [{name: ASC}]) indicates that the devices should be ordered by the name field in ascending order.