Skip to content
/Entitlement

Entitlements API (Beta) (1.0.0_Beta)

API documentation for Entitlement service

Download OpenAPI description
FNO_API_Modernization.json
FNO_API_Modernization.yaml
Languages
Servers
Mock server

https://fnoapi.redocly.app/_mock/apis/rest/fno_api_modernization/

Generated server url

https://flex1001-ci.flexnetoperations.com/entitlements-api/

MaintenanceLineItem

API for performing operations on Maintenance Line Items.

Operations

Entitlement

API for performing operations on Entitlements and Line Items.

Operations

Create a simple Entitlement

Request

Bodyapplication/jsonrequired
entitlementIdstring[ 0 .. 255 ] characters^(?!\s*$)(?!.*['"&%^()#@!~/<>`{}=|]).*$

Entitlement ID of the entitlement. If you specify the entitlement ID, then it must be unique across all entitlements and line items. If you specify the entitlement ID here, then the autoGenerate flag must be set to false

Example: "ent-id-1234"
descriptionstring[ 0 .. 2000 ] characters

Description of the entitlement

Example: "Description for entitlement"
allowPortalLoginboolean

Whether the customer can use the entitlement ID to log into the End-User Portal after the entitlement is deployed

shipToEmailstring[ 0 .. 1000 ] characters

Email address of the ship-to contact

Example: "Joe@example.com"
shipToAddressstring[ 0 .. 1000 ] characters^$|^[ a-zA-Z0-9_-]+$

Address of the ship-to contact

Example: "Building-Street-City"
accountsArray of objects(Account)[ 0 .. 2147483647 ] items

List of accounts associated with the entitlement. If account is not provided, the entitlement will be associated with UNKNOWN_ORG_UNIT(default account).

lineItemsArray of objects(LineItem)[ 1 .. 2147483647 ] itemsrequired

List of line items contained in the entitlement

lineItems[].​activationIdstring[ 0 .. 255 ] characters^(?!\s*$)(?!.*['"&%^()#@!~/<>`{}=|]).*$

Activation ID of the line item. If you specify the activation ID, then it must be unique across all entitlements and line items. If you specify the activation ID here, then the autoGenerate flag must be set to false

Example: "act-id-1234"
lineItems[].​productArray of objects(Product)required

List of products entitled by this line item

lineItems[].​product[].​productNamestringrequired

Name of the product

Example: "SampleProduct"
lineItems[].​product[].​productVersionstringrequired

Version of the product

Example: "SampleVersion-1.0"
lineItems[].​product[].​licenseModelobject(LicenseModel)

License model associated with the product

lineItems[].​quantityinteger(int32)>= 0

Number of copies for the entitlement

Example: 1
lineItems[].​quantityPerCopyinteger(int32)>= 1
lineItems[].​isActivatableboolean

Whether this line item is activatable

lineItems[].​isPermanentboolean

Whether this line item is permanent. A permanent line item has no expiration date.

lineItems[].​expiryDatestring

End date of the line item in YYYY-MM-DD format

Example: "2025-01-01"
lineItems[].​startDatestring^\d{4}-\d{2}-\d{2}$required

Start date of the line item in YYYY-MM-DD format

Example: "2025-01-01"
lineItems[].​attributesArray of objects(Attribute)

List of custom attributes related to the line item

lineItems[].​autoGenerateboolean

Whether the activation ID should be auto-generated

Example: false
lineItems[].​autoDeployboolean

Whether the Line item should be auto-deployed

lineItems[].​orderTypestring

Type of order for the line item. The default is NEW_ORDER

Enum"new_order""renewal_order""upgrade_order""upsell_order""invalid_order"
Example: "NEW_ORDER"
lineItems[].​lineItemStatusstring
Enum"draft""deployed""obsolete"
autoDeployboolean

Flag to indicate if the entitlement should be auto-deployed

emailTemplateVariationstring^(?!\s+$).*

Name of the email template to be used for entitlement related emails

Example: "DEFAULT"
attributesArray of objects(Attribute)

List of entitlement custom attributes. Note that mandatory custom attributes must be included in this list

autoGenerateboolean

Whether the entitlement ID is to be auto-generated.

Example: false
statusstring
Enum"draft""deployed""obsolete"
curl -i -X POST \
  https://fnoapi.redocly.app/_mock/apis/rest/fno_api_modernization/v1/entitlement \
  -H 'Content-Type: application/json' \
  -d '{
    "entitlementId": "ent-id-1234",
    "description": "Description for entitlement",
    "allowPortalLogin": true,
    "shipToEmail": "Joe@example.com",
    "shipToAddress": "Building-Street-City",
    "accounts": [
      {
        "accountId": "SampleOrg12345",
        "accountName": "string",
        "accountType": "CUSTOMER",
        "partnerTierName": "END_CUSTOMER/PARTNER_TIER_ONE",
        "isCurrentOwner": true,
        "contactEmail": "Joe@example.com"
      }
    ],
    "lineItems": [
      {
        "activationId": "act-id-1234",
        "product": [
          {
            "productName": "SampleProduct",
            "productVersion": "SampleVersion-1.0",
            "licenseModel": {
              "licenseModelName": "LicenseModelName",
              "issuer": "SampleLicenseIssuer",
              "serialNumber": "SampleSerialno",
              "vendorString": "uniqueVendorString",
              "notice": "Premium Feature A"
            }
          }
        ],
        "quantity": 1,
        "quantityPerCopy": 1,
        "isActivatable": true,
        "isPermanent": true,
        "expiryDate": "2025-01-01",
        "startDate": "2025-01-01",
        "attributes": [
          {
            "name": "REGION",
            "value": "EMEA"
          }
        ],
        "autoGenerate": false,
        "autoDeploy": true,
        "orderType": "NEW_ORDER",
        "lineItemStatus": "draft"
      }
    ],
    "autoDeploy": true,
    "emailTemplateVariation": "DEFAULT",
    "attributes": [
      {
        "name": "REGION",
        "value": "EMEA"
      }
    ],
    "autoGenerate": false,
    "status": "draft"
  }'

Responses

Created a simple entitlement successfully

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

Get a list of simple entitlements.

Request

Query
activationIdstring

Activation ID associated with the entitlement

accountIdstring

Account ID associated with the entitlement

accountNamestring

Account name associated with the entitlement

contactEmailstring

Contact email associated with the entitlement

productstring

Product name associated with the entitlement

versionstring

Product version associated with the entitlement

partNumberstring

Part number associated with the entitlement

statusstring

Status of the entitlement (draft,deployed,active,inactive,obsoleted)

sort_bystring

Field to sort by (entitlement_id,created_on)

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/fno_api_modernization/v1/entitlements?activationId=string&accountId=string&accountName=string&contactEmail=string&product=string&version=string&partNumber=string&status=string&sort_by=string&sort_order=string&page=0&limit=0'

Responses

Get simple entitlement list

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

LineItem

API for performing operations on Line Items.

Operations