Skip to content
REST API Reference/
Entitlement REST API Refe...
/
/
Update attributes of line...

Introduction to the Entitlement REST API (1.0.0_Beta)

API documentation for Entitlement service

Download OpenAPI description
entitlement-service.json
entitlement-service.yaml
Languages
Servers
Mock server
https://fnoapi.redocly.app/_mock/apis/rest/entitlement/entitlement-service
Generated server url
https://YourSiteID.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

LineItem

API for performing operations on Line Items.

Operations

Get line items for an entitlement

Request

Path
entitlementIdstringrequired
Query
activationIdstring

Activation ID to filter line items

productNamestring

Product name to filter line items

startDatestring

Start date to filter line items

licenseModelNamestring

License Model Name to filter line items

statusstring

Status to filter line items

pageinteger(int32)

Requested page number

limitinteger(int32)

Number of records per page

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/entitlement/entitlement-service/v1/entitlements/{entitlementId}/line-items?activationId=string&productName=string&startDate=string&licenseModelName=string&status=string&page=0&limit=0'

Responses

Get all line items for an entitlement

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

Create a line item

Request

Path
entitlementIdstringrequired
Bodyapplication/jsonrequired
lineItemsArray of objects(LineItem)required
lineItems[].​activationIdstring[ 0 .. 255 ] characters^$|^(?!.*[\'\"&%^()#@!~/<>`{}=|]).*$

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)

List of products entitled by this line item

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[].​partNumberstring

PartNumber

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"
curl -i -X POST \
  'https://fnoapi.redocly.app/_mock/apis/rest/entitlement/entitlement-service/v1/entitlements/{entitlementId}/line-items' \
  -H 'Content-Type: application/json' \
  -d '{
    "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",
        "partNumber": "string",
        "attributes": [
          {
            "name": "REGION",
            "value": "EMEA"
          }
        ],
        "autoGenerate": false,
        "autoDeploy": true,
        "orderType": "NEW_ORDER",
        "lineItemStatus": "draft"
      }
    ]
  }'

Responses

Created line items successfully

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

Configure line item policies

Request

Path
entitlementIdstringrequired
activationIdstringrequired
Bodyapplication/jsonrequired
rehostsobject(PolicyAttribute)

Represents License Model Policy Attributes used in Line Item.

returnsobject(PolicyAttribute)

Represents License Model Policy Attributes used in Line Item.

repairsobject(PolicyAttribute)

Represents License Model Policy Attributes used in Line Item.

extraActivationsinteger(int32)>= 0

Number of extra activations

cancelLicenseboolean

Cancel license policy

virtualLicenseboolean

Virtual license policy

acpiGenerationIdLicenseboolean

ACPI Generation ID License Policy

curl -i -X PATCH \
  'https://fnoapi.redocly.app/_mock/apis/rest/entitlement/entitlement-service/v1/entitlements/{entitlementId}/line-items/{activationId}/policies' \
  -H 'Content-Type: application/json' \
  -d '{
    "rehosts": {
      "allowedCount": 0,
      "policyTermDuration": 0,
      "policyTermUnit": "string"
    },
    "returns": {
      "allowedCount": 0,
      "policyTermDuration": 0,
      "policyTermUnit": "string"
    },
    "repairs": {
      "allowedCount": 0,
      "policyTermDuration": 0,
      "policyTermUnit": "string"
    },
    "extraActivations": 0,
    "cancelLicense": true,
    "virtualLicense": true,
    "acpiGenerationIdLicense": true
  }'

Responses

LineItem Policies configured successfully

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

Update attributes of line items for an entitlement

Request

Path
entitlementIdstringrequired
Bodyapplication/jsonrequired
lineItemsArray of objects(UpdateLineItemAttributesDTO)
curl -i -X PATCH \
  'https://fnoapi.redocly.app/_mock/apis/rest/entitlement/entitlement-service/v1/entitlements/{entitlementId}/additional-properties' \
  -H 'Content-Type: application/json' \
  -d '{
    "lineItems": [
      {
        "activationId": "string",
        "orderType": "new_order",
        "parentActivationId": "string",
        "deploy": true,
        "product": {
          "productName": "string",
          "productVersion": "string",
          "partNumber": "string",
          "licenseModel": {
            "name": "string",
            "issuer": "string",
            "serialNumber": "string",
            "vendorString": "string",
            "notice": "string",
            "overdraft": 0,
            "maxBorrowInterval": "string",
            "autoProvision": true,
            "gracePeriodDays": 0
          }
        },
        "attributes": [
          {
            "name": "string",
            "value": {},
            "type": "line_item"
          }
        ]
      }
    ]
  }'

Responses

Line Items updated successfully

Bodyapplication/json
statusstring
activationIdsArray of objects(ActivationIds)
responseobject
Response
application/json
{
  "status": "string",
  "activationIds": [
    { … }
  ],
  "response": {
    "property1": { … },
    "property2": { … }
  }
}

Link Maintenance Line Item

Request

Bodyapplication/jsonrequired
lineItemobject(LinkLineItemDTO)

Line Item activation ID to be linked with maintenance line Item

maintenanceLineItemobject(MaintenanceLinkLineItemDTO)

Maintenance Line item activation ID to be linked with line item

curl -i -X PATCH \
  https://fnoapi.redocly.app/_mock/apis/rest/entitlement/entitlement-service/v1/entitlements/line-items/link-maintenance \
  -H 'Content-Type: application/json' \
  -d '{
    "lineItem": {
      "activationId": "string"
    },
    "maintenanceLineItem": {
      "activationId": "string"
    }
  }'

Responses

Successfully linked maintenance line item

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