Skip to content
REST API Reference/
/Suite

Introduction to the Products and Packaging REST API (1.0.0_Beta)

API documentation for Product and Packaging service

Download OpenAPI description
product-service.json
product-service.yaml
Languages
Servers
Mock server
https://fnoapi.redocly.app/_mock/apis/rest/product/product-service
Generated server url
https://YourSiteID-uat.flexnetoperations.com/products-api

Part Number

API for performing operations on part numbers.

Operations

Product

API for performing operations on products.

Operations

Suite

API for performing operations on suites.

Operations

Get suites

Request

Query
suiteNamestring

Filter by suite name

versionstring

Filter by suite version

descriptionstring

Filter by description

partNumberstring

Filter by part number

statestring

Filter by suite state (draft, deployed, obsolete, inactive)

packageNamestring

Filter by package name

packageVersionstring

Filter by package version

hostTypestring

Filter by host type

licenseTechnologystring

Filter by license technology

licenseGeneratorstring

Filter by license generator

usedOnDeviceboolean

Filter by used on device(true/false)

creationDatestring

Filter by creation date (ISO 8601)

lastModifiedDatestring

Filter by last update date (ISO 8601)

sort_bystring

Field to sort by (suiteName, createdOn)

sort_orderstring

Order to sort by (asc/desc)

pageinteger(int32)

Requested page number

limitinteger(int32)

Number of records per page

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/product/product-service/v1/suites?suiteName=string&version=string&description=string&partNumber=string&state=string&packageName=string&packageVersion=string&hostType=string&licenseTechnology=string&licenseGenerator=string&usedOnDevice=true&creationDate=string&lastModifiedDate=string&sort_by=string&sort_order=string&page=0&limit=0'

Responses

Suites retrieved successfully

Bodyapplication/json
messagestring
statusstring
Response
application/json
{
  "message": "string",
  "status": "string"
}

Create a suite

Request

Bodyapplication/jsonrequired
suiteNamestring[ 0 .. 128 ] charactersrequired

Name of the suite

Example: "Suite A"
versionstringrequired

Version of the suite

Example: "1.0.0"
descriptionstring

Description of the suite

Example: "This is a sample product description"
autoDeployboolean

Flag to indicate if suite should be auto-deployed

Example: true
licenseTechnologystring

License Technology name of the suite

Default "FlexNet Licensing"
Example: "FlexNet Licensing"
licenseGeneratorstring

License Generator name of the suite

Example: "demo"
usedOnDeviceboolean

Used on device plays role only when license technology is FlexNet Licensing

Example: true
packagePropertiesobject(SuitePackage)

Suite package information

allowDownloadObsoleteFrInAdminboolean

Allow download of obsolete fulfillment records in Producer Portal

Example: true
allowDownloadObsoleteFrInPortalboolean

Allow download of obsolete fulfillment records in End-User Portal

Example: true
trustedKeystring

Trusted Key Configuration name

Example: "Trusted Key"
virtualTrustedKeystring

Virtual Trusted Key Configuration name

Example: "Virtual Trusted Key"
productsArray of objects(SuiteProduct)

List of products included in the suite

licenseModelsArray of strings

List of License Models associated with the suite

Example: ["Embedded Counted"]
customAttributesArray of objects(AttributesDTO)

Custom attributes of the suite

partNumbersArray of objects(PartNumber)

List of part numbers associated with the suite

hostTypesArray of strings

List of host types associated with the suite

Example: ["FLX_SERVER"]
productCategorystring

Product category name of the suite

Default "Uncategorized Products"
Example: "Uncategorized Products"
productCategoryAttributesArray of objects(AttributesDTO)

Product category custom attributes of the suite

curl -i -X POST \
  https://fnoapi.redocly.app/_mock/apis/rest/product/product-service/v1/suites \
  -H 'Content-Type: application/json' \
  -d '{
    "suiteName": "Suite A",
    "version": "1.0.0",
    "description": "This is a sample product description",
    "autoDeploy": true,
    "licenseTechnology": "FlexNet Licensing",
    "licenseGenerator": "demo",
    "usedOnDevice": true,
    "packageProperties": {
      "name": "Package",
      "version": "1.0.0",
      "versionFormat": "FIXED"
    },
    "allowDownloadObsoleteFrInAdmin": true,
    "allowDownloadObsoleteFrInPortal": true,
    "trustedKey": "Trusted Key",
    "virtualTrustedKey": "Virtual Trusted Key",
    "products": [
      {
        "name": "Product A",
        "version": "1.0.0",
        "count": 10
      }
    ],
    "licenseModels": [
      "Embedded Counted"
    ],
    "customAttributes": [
      {
        "name": "ca_text",
        "value": "testing"
      }
    ],
    "partNumbers": [
      {
        "partNumber": "PN-12345",
        "licenseModelName": "Embedded Counted"
      }
    ],
    "hostTypes": [
      "FLX_SERVER"
    ],
    "productCategory": "Uncategorized Products",
    "productCategoryAttributes": [
      {
        "name": "ca_text",
        "value": "testing"
      }
    ]
  }'

Responses

Created a suite successfully

Bodyapplication/json
messagestring
statusstring
Response
application/json
{
  "message": "string",
  "status": "string"
}

Get a suite

Request

Path
suiteNamestringrequired

Name of the suite

suiteVersionstringrequired

Version of the suite

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/product/product-service/v1/suites/{suiteName}/{suiteVersion}'

Responses

Suite retrieved successfully

Bodyapplication/json
messagestring
statusstring
Response
application/json
{
  "message": "string",
  "status": "string"
}

Feature

API for performing operations on features.

Operations