Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview

LineItemInput

Represents a line item in the entitlement

activatable
Boolean

Whether this line item is activatable

activationId
String

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"

List of custom attributes related to the line item

autoDeploy
Boolean

Whether the Line item should be auto-deployed

autoGenerate
Boolean

Whether the activation ID should be auto-generated. Example: false

expiryDate
String

End date of the line item in YYYY-MM-DD format. Example: "2025-01-01"

orderType
String
Default:"NEW_ORDER"

Type of order for the line item. The default is NEW_ORDER. Example: "NEW_ORDER" Default: NEW_ORDER

partNumber
String

PartNumber

permanent
Boolean

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

List of products entitled by this line item

quantity
Int

Number of copies for the entitlement. Example: 1

quantityPerCopy
Int

Quantity per copy. Minimum value is 1. Default: 1

startDate
String!,non-null

Start date of the line item in YYYY-MM-DD format. Example: "2025-01-01"

Sample
{ "activatable": true, "activationId": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "expiryDate": "Example String", "orderType": "Example String", "partNumber": "Example String", "permanent": true, "product": [ { "__typename": "ProductInput" } ], "quantity": 40, "quantityPerCopy": 40, "startDate": "Example String" }

LineItemPropertyInput

Represents the properties of a line item that can be updated

activationId
String!,non-null

Activation ID of the line item for which attributes has to be updated

List of custom attributes related to the line item and license model

deploy
Boolean

Whether this line item is to be deployed

orderType
String

Order type can have values like 'New_Order', 'Renewal_Order', 'Upgrade_Order' and Upsell_Order. This is used to identify the type of order for the line item

parentActivationId
String

Activation ID which will be updated as a parent line item if order type relation exists between line items. If order type is 'New' then this field will be ignored

Product related to the line item

Sample
{ "activationId": "Example String", "attributes": [ { "__typename": "AttributeUpdateInput" } ], "deploy": true, "orderType": "Example String", "parentActivationId": "Example String", "product": { "__typename": "UpdateProductInput" } }

LinkLineItemInput

Input for line item to be linked

activationId
String!,non-null

Activation ID of the line item

Sample
{ "activationId": "Example String" }

LinkMaintenanceLineItemInput

Input to link a maintenance line item

lineItem

Line Item activation ID to be linked with maintenance line item

maintenanceLineItem

Maintenance Line item activation ID to be linked with line item

Sample
{ "lineItem": { "__typename": "LinkLineItemInput" }, "maintenanceLineItem": { "__typename": "MaintenanceLinkLineItemInput" } }

MaintenanceLineItemInput

activationId
String

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"

List of custom attributes related to the maintenance line item

autoDeploy
Boolean

Whether the maintenance Line item should be auto-deployed

autoGenerate
Boolean

Whether the activation ID should be auto-generated

expiryDate
String

End date of the maintenance line item in YYYY-MM-DD format. Example: "2025-01-01"

maintenanceProduct

List of products entitled by this maintenance line item

permanent
Boolean

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

startDate
String!,non-null

Start date of the maintenance line item in YYYY-MM-DD format. Example: "2025-01-01"

Sample
{ "activationId": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "expiryDate": "Example String", "maintenanceProduct": { "__typename": "MaintenanceProductInput" }, "permanent": true, "startDate": "Example String" }

MaintenanceLinkLineItemInput

Input for maintenance line item to be linked

activationId
String!,non-null

Activation ID of the maintenance line item

Sample
{ "activationId": "Example String" }

MaintenanceProductInput

maintenanceProductName
String

Name of the maintenance product

maintenanceProductVersion
String

Version of the maintenance product

partNumber
String

Part number associated with maintenance product

Sample
{ "maintenanceProductName": "Example String", "maintenanceProductVersion": "Example String", "partNumber": "Example String" }

MaintenanceProductPartNumberInput

Maintenance product part number input.

partNumber
String!,non-null

Name to uniquely identify the part number. Can only contain ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyPartNumber"

Sample
{ "partNumber": "Example String" }

MaintenanceProductProductInput

Maintenance product product input.

productName
String!,non-null

Name to uniquely identify the product name. Can only contain ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyProduct"

version
String!,non-null

Version to uniquely identify the product version. Maximum length: 64 characters. Example: "1.0"

Sample
{ "productName": "Example String", "version": "Example String" }

PartNumberInput

Input for a single part number

description
String

Describe the characteristics of this part number. Maximum length: 2000 characters. Example: "This part number is for enterprise customers."

partNumber
String!,non-null

Name to uniquely identify the part number. Can only contain ASCII letters, numbers, spaces, dots, or _ (underscore) and - (hyphen). Cannot be only spaces. Maximum length: 200 characters. Example: "MyPartNumber"

Optional Product to be assigned to this part number.

trialAvailability
Boolean

Trial Availability flag to indicate whether the part number is available for trial. Default: false.

Sample
{ "description": "Example String", "partNumber": "Example String", "product": { "__typename": "PartNumberProductInput" }, "trialAvailability": true }

PartNumberProductInput

Product associated with part number

licenseModel
String

License model associated with the product. Example: "LicenseModelName"

name
String!,non-null

Name of the product. Example: "SampleProduct"

version
String!,non-null

Version of the product. Example: "SampleVersion-1.0"

Sample
{ "licenseModel": "Example String", "name": "Example String", "version": "Example String" }

Scalars

Overview