Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Enums

Overview

Inputs

Overview

LineItemInput

Represents a line item in the entitlement

activatable
Boolean

Flag to indicate whether this line item is activatable

activationId
String

The activation ID associated with the line item. You may specify this while creation. If you choose to specify this then the autoGenerate flag should be set to false. If the activationID specified, matches with any existing entitlementID or activationID, then you will get an error

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

expiryDate
String

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

Default:"NEW_ORDER"

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

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

quantityPerCopy
Int

Quantity per copy. Minimum value is 1

startDate
String!,non-null

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

Sample
{ "activatable": true, "activationId": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "expiryDate": "Example String", "orderType": "INVALID_ORDER", "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 the line item is to be deployed or not. This is used to update the deployment status of the line item

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

Parent Line Item Activation ID. This is used to update the parent line item when the line item is a child of another line item.

Product related to the line item

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

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

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

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

Sample
{ "activationId": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "expiryDate": "Example String", "maintenanceProduct": { "__typename": "MaintenanceProductInput" }, "permanent": true, "startDate": "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" }

PolicyAttributeInput

Represents attributes for a given policy

allowedCount
Int!,non-null

Represents the allowed count for the policy

policyTermDuration
Int!,non-null

Represents the duration of the policy term

policyTermUnit

Represents policy term unit

Sample
{ "allowedCount": 40, "policyTermDuration": 40, "policyTermUnit": "Days" }

PolicyInput

Represents a Policy

acpiGenerationIdLicense
Boolean

ACPI Generation ID License flag

cancelLicense
Boolean

Cancel License flag

extraActivations
Int

Activation Policy Attributes

Rehost Policy Attributes

Repair Policy Attributes

Return Policy Attributes

virtualLicense
Boolean

Virtual License flag

Sample
{ "acpiGenerationIdLicense": true, "cancelLicense": true, "extraActivations": 40, "rehosts": { "__typename": "PolicyAttributeInput" }, "repairs": { "__typename": "PolicyAttributeInput" }, "returns": { "__typename": "PolicyAttributeInput" }, "virtualLicense": true }

ProductInput

Represents a Product

licenseModel

License model associated with the product

productName
String!,non-null

Name of the product

productVersion
String!,non-null

Version of the product

Sample
{ "licenseModel": { "__typename": "LicenseModelInput" }, "productName": "Example String", "productVersion": "Example String" }
Referenced in

UpdateLicenseModelInput

Represents an update to a License Model

autoProvision
Boolean

Auto Provision flag

gracePeriodDays
String

Represents the grace period days

issuer
String

Name of the issuer

maxBorrowInterval
Int

Represents the max borrow interval

name
String!,non-null

Name of the license model

notice
String

Represents the notice

overdraft
String

Represents the overdraft

serialNumber
String

Serial Number of the license model

vendorString
String

Represents the vendor string

Sample
{ "autoProvision": true, "gracePeriodDays": "Example String", "issuer": "Example String", "maxBorrowInterval": 40, "name": "Example String", "notice": "Example String", "overdraft": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }

UpdateProductInput

Represents an update to a Product

licenseModel

License Model Details

partNumber
String

Part Number related to Product

productName
String!,non-null

Product Name related to the line item

productVersion
String!,non-null

Product Version related to the line item

Sample
{ "licenseModel": { "__typename": "UpdateLicenseModelInput" }, "partNumber": "Example String", "productName": "Example String", "productVersion": "Example String" }