Application RESTful Services

Version:As of 2018 R2, documentation of application RESTful services has been moved to Swagger. Use the following URL to access the information:

https://YOUR_FNO_INSTANCE/flexnet/swagger-ui.html

For example, if your FNO instance was https://prod2222.mycompany.com, then the URL to the Swagger documentation would be:

https://prod2222.mycompany.com/flexnet/swagger-ui.html

RESTful services information will no longer be maintained in this document.

REST APIs enable an end-user application to retrieve and send product and device information with FlexNet Operations.

API

Description

Entitlement Orders

Returns the activatable line items that match specified criteria

Entitlement Orders Count

Returns the number of activatable line items that match specified criteria.

Devices

Returns the query parameters for a specified device (or all devices if no parameters are specified)

Devices Count

Returns the number of matching devices to one or more query parameters or all devices if no parameters specified.

Consumption

Returns the consumption information for a given account ID.

Note:All date values use the yyyy-MM-dd format

Permissions

All REST APIs require the user to be logged into the server and have permissions to execute web services as well as permission for the resource, i.e. View Entitlement, Manage Devices, etc.

Authentication

When calling the API, a producer user must authenticate themselves. Authentication information (in Base64) must be included in the header. The following procedure explains how to provide credentials, including an example for each step.

To provide credentials

1. Concatenate the user name and password with a single colon.

Example: If the user name is "alice" and the password is "password", the resulting concatenated string would be alice:password

2. Base64 encode the concatenated user name and password.

Example: Base64 encode the string alice:password to obtain "YWxpY2U6cGFzc3dvcmQ="

3. Add the "Authorization" key to the header of the request, with the Base64-encoded result as the value.

Example: Add the value "Basic YWxpY2UucGFzc3dvcmQ=" to the Authorization header.

REST Web Services Batch Limits

The following batch-size maximum limits apply for requests issued from application RESTful web services:

• All read services have a maximum batch size of 2000.
• All services that result in a write have a batch size maximum of 25 records.

Specifying a batch size higher than the new cap results in an error.