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

Get part numbers

Request

Query
partNumberstring

Filter by partNumber

productNamestring

Filter by productName

licenseModelstring

Filter by licenseModel

creationDatestring

Filter by created date

lastModifiedDatestring

Filter by last modified date

unmappedWithProductboolean

Filter by unmapped with product

unmappedWithLicenseModelboolean

Filter by unmapped with license model

sort_bystring

Field to sort by (partNumber, productName, licenseModel, creationDate and lastModifiedDate)

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/part-numbers?partNumber=string&productName=string&licenseModel=string&creationDate=string&lastModifiedDate=string&unmappedWithProduct=true&unmappedWithLicenseModel=true&sort_by=string&sort_order=string&page=0&limit=0'

Responses

Part numbers retrieved successfully

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

Create one or more part numbers

Request

Bodyapplication/jsonrequired
partNumbersArray of objects(PartNumberDTO)required
partNumbers[].​partNumberstring[ 0 .. 200 ] characters^(?=.*[A-Za-z0-9_\-.])[ A-Za-z0-9_\-.]+$required

Name to uniquely identify the part number.

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

Describe the characteristics of this feature that make it unique.

Example: "This feature enables advanced reporting."
partNumbers[].​productobject(PartNumberProductDTO)

Product associated with part number

partNumbers[].​trialAvailabilityboolean

Trial Availability flag to indicate whether the part number is available for trial or not.

Example: false
curl -i -X POST \
  https://fnoapi.redocly.app/_mock/apis/rest/product/product-service/v1/part-numbers \
  -H 'Content-Type: application/json' \
  -d '{
    "partNumbers": [
      {
        "partNumber": "MyPartNumber",
        "description": "This feature enables advanced reporting.",
        "product": {
          "name": "SampleProduct",
          "version": "SampleVersion-1.0",
          "licenseModel": "LicenseModelName"
        },
        "trialAvailability": false
      }
    ]
  }'

Responses

Created a part number successfully

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

Product

API for performing operations on products.

Operations

Suite

API for performing operations on suites.

Operations

Feature

API for performing operations on features.

Operations