Data Access Report APIs (1.0.0)

Download OpenAPI specification:Download

The FlexNet Operations Data Access Report APIs can be used to extract data from the FlexNet Operations Data Warehouse for the purposes of reporting. They allow programmatic access to data using a standard interface on which it is possible to build customer reporting tools. Using the APIs, the data can be integrated into any web or mobile application.

Query the /report-report-names/ API to identify the individual report names (required for the "{group}" parameter).

Data from up to the preceding 30 days can be obtained, eliminating the need to store data in an external data warehouse. Where the quantity of data is large, it is returned in pages. The "header" of the response payload contains URLs to link directly to the previous and next pages of data. A specific page of data can be requested using the pageNumber filter (see the /global-filters/ API).

The API that obtains a report for a particular data group is /report/. The other APIs in the report-controller provide meta data that allow the report API to be understood, in order to plan how to use it in a custom application.

Data Access API Entity Relationship Diagram and Field Descriptions
To see a diagram that lists the entities that are returned by this API, the relationships between them, and a description of each of the response fields, see Data Access API Entity Relationship Diagram and Field Descriptions.
Using the "Try It" Console
To execute an API command using the Try It console, enter the Username and Password (in the Security section) and the siteID of your FlexNet Operations instance.

Build: a5cbbcc (2022-01-05T06:20:21+0000)

Data Access Report API

Get Specific Report

Use this API to retrieve a specific report. Specify the report using the group parameter.

SecurityFNO_Credentials
Request
path Parameters
group
required
string

Report Name.

Example: account
query Parameters
mode
string
Default: "batch"

Either batch or interactive.

format
string
Default: "json"

Format of the resulting report {json|csv}. Default: json.

pastDays
integer <int32>
Default: 1

Return data for the past X days {[1-30]}. Default: 1.

limitRecords
integer <int32>
Default: 500

Limit the number of records returned {[1-2500]}. Default: 500.

pageNumber
integer <int32>
Default: 1

Return a specific page {minimum value is 1}. Default: 1.

dateFrom
string
Default: ""

Report start date {yyyy-MM-dd}. Example: 2019-01-10.

dateTo
string
Default: ""

Report end date {yyyy-MM-dd}. Example: 2019-01-10.

query
string
Default: "{}"

Optional filters based on the specific group (report name).

Example: {"accountId" : { "$eq" : "test"}}

Responses
200

Successfully retrieved report

400

The reporter identified a request with incorrect parameters

401

You are not authorized to view the report

403

Accessing the report you were trying to reach is forbidden

404

The report you were trying to reach can't be found

500

The reporter returned an error

get/api/v1/report/{group}

Get Data Model for All Reports

This API retrieves information about the data model used in each available report. The response provides the name and type of each data item included in a given report. This information helps you understand the content of a report before you run it against live data. The response also contains information about the filters that can be used for each of the reports.

SecurityFNO_Credentials
Responses
200

Successfully retrieved report

400

The reporter identified a request with incorrect parameters

401

You are not authorized to view the report

403

Accessing the report you were trying to reach is forbidden

404

The report you were trying to reach can't be found

500

The reporter returned an error

get/api/v1/report/report-types
Response samples
application/json
{
  • "data": { }
}

Get Data Model for Specific Report

This API retrieves information about the data model used in a specific report. The response provides the name and type of each data item included in the report. This information helps you understand the content of the report before you run it against live data.

SecurityFNO_Credentials
Request
path Parameters
group
required
string

Report Name.

Example: account
Responses
200

Successfully retrieved report

400

The reporter identified a request with incorrect parameters

401

You are not authorized to view the report

403

Accessing the report you were trying to reach is forbidden

404

The report you were trying to reach can't be found

500

The reporter returned an error

get/api/v1/report/report-types/{group}
Response samples
application/json
{
  • "data": { }
}

Get Report Names

This API returns the names of the available reports.

SecurityFNO_Credentials
Responses
200

Successfully retrieved report

400

The reporter identified a request with incorrect parameters

401

You are not authorized to view the report

403

Accessing the report you were trying to reach is forbidden

404

The report you were trying to reach can't be found

500

The reporter returned an error

get/api/v1/report/report-names
Response samples
application/json
{
  • "data": { }
}

Get Filters for Specific Report

This API retrieves the filters that can be used when requesting a specific report.

SecurityFNO_Credentials
Request
path Parameters
group
required
string

Report Name.

Example: account
Responses
200

Successfully retrieved report

400

The reporter identified a request with incorrect parameters

401

You are not authorized to view the report

403

Accessing the report you were trying to reach is forbidden

404

The report you were trying to reach can't be found

500

The reporter returned an error

get/api/v1/report/report-filters/{group}
Response samples
application/json
{
  • "data": { }
}

Get Filters for All Reports

This API retrieves the filters available for each of the reports. These filters can be used to obtain specific data or to reduce the amount of data returned.

SecurityFNO_Credentials
Responses
200

Successfully retrieved report

400

The reporter identified a request with incorrect parameters

401

You are not authorized to view the report

403

Accessing the report you were trying to reach is forbidden

404

The report you were trying to reach can't be found

500

The reporter returned an error

get/api/v1/report/global-filters
Response samples
application/json
{
  • "data": { }
}