Skip to content

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

API documentation for Product and Packaging service

Download OpenAPI description
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

Feature

API for performing operations on features.

Operations

Get features

Request

Query
namestring

Filter feature by name

versionstring

Filter feature by version

versionFormatstring

Filter feature by versionFormat

statestring

Feature state (for example, DRAFT, DEPLOYED)

creationDatestring

Creation date (ISO 8601)

lastModifiedDatestring

Last modified date (ISO 8601)

vendorAuthStringstring

Vendor authorization string

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/features?name=string&version=string&versionFormat=string&state=string&creationDate=string&lastModifiedDate=string&vendorAuthString=string&page=0&limit=0'

Responses

Get features

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

Create a feature

Request

Bodyapplication/jsonrequired

Mandatory fields: featureName, versionFormat

featureNamestring[ 0 .. 30 ] characters^[A-Za-z0-9_-]+$required

Name to uniquely identify the feature.

Example: "MyFeature"
versionFormatstringrequired

Select a FIXED or DATEBASED version format.

Example: "FIXED"
versionstring[ 0 .. 64 ] characters

If a FIXED version format is selected, specify version of the feature

Example: "1.0"
maxVersionstring^\d{4}\.(\d{2}(\d{2}|\.?\d{2})?)$

Specify maxVersion of the feature

Example: "2023.10.15"
descriptionstring[ 0 .. 2000 ] characters^[^:<>@={}\[\],!/|?"#$%~^`']+$

Describe the characteristics of this feature that make it unique.

Example: "This feature enables advanced reporting."
aggregationTypestring

Select an Aggregation Type for the feature. Valid values: NONE, SUM, MAX

Example: "SUM"
featureOverrideParamsobject(FeatureOverrideParamsTypeDTO)

DTO for specifying feature override parameters.

autoDeployboolean

Auto Deploy flag to indicate whether the feature should be deployed or not.

curl -i -X POST \
  https://fnoapi.redocly.app/_mock/apis/rest/product/product-service/v1/features \
  -H 'Content-Type: application/json' \
  -d '{
    "featureName": "MyFeature",
    "versionFormat": "FIXED",
    "version": "1.0",
    "maxVersion": "2023.10.15",
    "description": "This feature enables advanced reporting.",
    "aggregationType": "SUM",
    "featureOverrideParams": {
      "vendorString": "Vendor123",
      "notice": "This is a notice.",
      "borrowable": true,
      "serialNumber": "SN123456",
      "dupGroup": {
        "dupGroupOption": "GROUPMASK",
        "groupMask": {
          "option": [
            "USER",
            "HOST"
          ]
        }
      },
      "counted": "Yes",
      "reusable": "No"
    },
    "autoDeploy": true
  }'

Responses

Created a feature successfully

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

Get feature bundle

Request

Query
featureBundleNamestring

Filter by feature bundle name

statestring

Filter by feature bundle state

creationDatestring

Filter by created date

lastModifiedDatestring

Filter by last modified date

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/feature-bundles?featureBundleName=string&state=string&creationDate=string&lastModifiedDate=string&page=0&limit=0'

Responses

Feature bundle retrieved successfully

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

Create a feature bundle

Request

Bodyapplication/jsonrequired

Mandatory fields: featureBundleName

featureBundleNamestring[ 0 .. 64 ] characters^[A-Za-z0-9_-]+$required

Name to uniquely identify the feature bundle.

Example: "MyFeatureBundle"
descriptionstring

Describe the characteristics of this feature bundle that make it unique.

Example: "This feature bundle enables advanced reporting."
autoDeployboolean

Auto Deploy flag to indicate whether the feature bundle should be deployed or not.

featureListArray of objects(FeatureBundleFeature)

Optional feature list for the feature bundle.

curl -i -X POST \
  https://fnoapi.redocly.app/_mock/apis/rest/product/product-service/v1/feature-bundles \
  -H 'Content-Type: application/json' \
  -d '{
    "featureBundleName": "MyFeatureBundle",
    "description": "This feature bundle enables advanced reporting.",
    "autoDeploy": true,
    "featureList": [
      {
        "featureName": "MyFeature",
        "version": "1.0",
        "quantity": 1
      }
    ]
  }'

Responses

Created a feature bundle successfully

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