Skip to content
REST API Reference
/
/MaintenanceLineItem

Entitlements API (Beta) (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://Your_SiteID.flexnetoperations.com/entitlements-api/

MaintenanceLineItem

API for performing operations on Maintenance Line Items.

Operations

Create maintenance line items

Request

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

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

Example: "act-id-1234"
maintenanceLineItems[].​maintenanceProductobject(MaintenanceProduct)required

Maintenance Product entitled by the maintenance line item

maintenanceLineItems[].​maintenanceProduct.​maintenanceProductNamestringrequired

Name of the maintenance product

maintenanceLineItems[].​maintenanceProduct.​maintenanceProductVersionstringrequired

Version of the maintenance product

maintenanceLineItems[].​maintenanceProduct.​partNumberstring

Part number associated with maintenance product

maintenanceLineItems[].​isPermanentboolean

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

maintenanceLineItems[].​expiryDatestring^\d{4}-\d{2}-\d{2}$

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

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

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

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

List of custom attributes related to the maintenance line item

maintenanceLineItems[].​autoGenerateboolean

Whether the activation ID should be auto-generated

maintenanceLineItems[].​autoDeployboolean

Whether the maintenance Line item should be auto-deployed

curl -i -X POST \
  'https://fnoapi.redocly.app/_mock/apis/rest/entitlement/entitlement-service/v1/entitlement/{entitlementId}/maintenance-line-items' \
  -H 'Content-Type: application/json' \
  -d '{
    "maintenanceLineItems": [
      {
        "activationId": "act-id-1234",
        "maintenanceProduct": {
          "maintenanceProductName": "string",
          "maintenanceProductVersion": "string",
          "partNumber": "string"
        },
        "isPermanent": true,
        "expiryDate": "2025-01-01",
        "startDate": "2025-01-01",
        "attributes": [
          {
            "name": "REGION",
            "value": "EMEA"
          }
        ],
        "autoGenerate": true,
        "autoDeploy": true
      }
    ]
  }'

Responses

Created maintenance line items successfully

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

Entitlement

API for performing operations on Entitlements and Line Items.

Operations

LineItem

API for performing operations on Line Items.

Operations