Using the Technology Intelligence Platform Queryable Inventory API
Note:
Important:The Query Graphql role is required to query and filter inventory data. For complete descriptions of each role available in Flexera One, see Flexera One Roles.
IT Visibility customers benefit from the Queryable Inventory API and improved performance on inventory export API with this upgrade. With the Queryable Inventory API, IT Visibility users gain targeted access to exactly the normalized inventory data they need to solve their use case, without the need to download multiple large datasets, and then join and analyze in another tool.
GraphQL is an open-source query language for your Application Programming Interface (API). It provides an efficient and flexible alternative to REST APIs to explore and request data.
With GraphQL, you can retrieve exactly what you need with a single query. You can use a GraphQL client to visualize the data retrieved from GraphQL. GraphQL clients are tools that facilitate interaction with GraphQL APIs. For information on how to set up and use a GraphQL client, see Using Altair Client.
While you can use a GraphQL client to visualize data, GraphQL queries can be executed in various ways such as using cURL and in automation scripts, without having to use a GraphQL client.
Using GraphQL you can:
| • | Conveniently and securely query and extract data from the Flexera One platform. |
| • | Efficiently curate content in a single location. |
| • | Quickly obtain consistent results from the Flexera One platform. |
| • | Easily correlate and communicate results from the Flexera One platform. |
For information on GraphQL, see Introduction to GraphQL on the GraphQL site.
Use Cases for GraphQL
The following section describes the use cases for GraphQL:
| • | Data Integrations—Flexera One integrates data into customers’ in-house applications. |
| • | Targeted Data Extraction—Enhanced data retrieval without having to use the Power BI tool. |
| • | Automation—By reducing the data load, the policy engine can leverage IT Visibility data for more automated actions. |
New Attributes in Technology Intelligence Platform
Two new attributes are available in the Hardware Inventory dataset for customers who upgrade to the Technology Intelligence Platform:
| • | BIOS_RELEASE_DATE—the date when the BIOS was released |
| • | BIOS_VERSION—an identifier for the BIOS version |
To work with these new attributes, use the https://api.flexera.com/graphql/v1/orgs/{Org_ID}/graphql endpoint. Replace {Org_ID} with your organization’s Org ID. Also remember to use the domain appropriate for the Flexera One region in which your organization is hosted: api.flexera.com for North America, api.flexera.eu for the EU, and api.flexera.au for APAC.
Note:These BIOS attributes are available via GraphQL as well as via Power BI when creating Technology Intelligence Platform custom reports in IT Visibility. They are not included in the standard reports that are part of IT Visibility.
Prerequisites
The following prerequisites are required for using GraphQL.
|
Prerequisite |
Notes |
|
You must generate a refresh token. |
For information on how to generate a refresh token, see Generating a Refresh Token. |
|
You must generate an access token from the refresh token before making a request. |
For information on how to generate an token, see Generating an Access Token From Refresh Token. |
GraphQL Help Topics
The following table provides navigation to the GraphQL help topics.
|
Topic |
Description |
|
Explains the key concepts of GraphQL. |
|
|
Describes how to create the basic GraphQL queries. |
|
|
Explains how to construct the HTTP POST request. |