Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

LicenseModel

Represents a license model entity.

issuer
String

Issuer associated with the license model.

licenseModelName
String!,non-null

License model name.

notice
String

Notice associated with the license model.

serialNumber
String

Serial number associated with the license model.

vendorString
String

Vendor string associated with the license model.

Sample
{ "issuer": "Example String", "licenseModelName": "Example String", "notice": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }
Referenced in

LineItem

Represents a line item in the entitlement

activationId
String!,non-null

Unique activation identifier of the line item.

duration
Int

Duration that the line item will be active.

expiryDate
String

Expiry date of the line item.

lineItemState

Represents the current state of the line item active/inactive/draft/deployed/obsoleted.

Represents the line item order type.

permanent
Boolean

Indicates if the line item is permanent.

products
[Product!]!,non-null

Products associated with the line item.

quantity
Int

Represents the quantity of the line item.

startDate
String

Start date of the line item.

Sample
{ "activationId": "Example String", "duration": 40, "expiryDate": "Example String", "lineItemState": "DEPLOYED", "orderType": "INVALID_ORDER", "permanent": true, "products": [ { "__typename": "Product" } ], "quantity": 40, "startDate": "Example String" }

LineItemDetail

Detailed information about a line item.

activationId
String!,non-null

Unique activation identifier of the line item.

duration
Int

Duration that the line item will be active.

expiryDate
String

Expiry date of the line item.

lineItemState

Represents the current state of the line item active/inactive/draft/deployed/obsoleted.

Represents the line item order type.

permanent
Boolean

Indicates if the line item is permanent.

products
[Product!]!,non-null

Products associated with the line item.

quantity
Int

Represents the quantity of the line item.

startDate
String

Start date of the line item.

Sample
{ "activationId": "Example String", "duration": 40, "expiryDate": "Example String", "lineItemState": "DEPLOYED", "orderType": "INVALID_ORDER", "permanent": true, "products": [ { "__typename": "Product" } ], "quantity": 40, "startDate": "Example String" }

LineItemListResponse

Paginated response carrying a list of line items.

limit
Int

Represents limit per page for pagination.

lineItems
[LineItem!]!,non-null

List of line item entities.

page
Int

Represents page for pagination.

Sample
{ "limit": 40, "lineItems": [ { "__typename": "LineItem" } ], "page": 40 }

LineItemResponse

Response a list type line item response

Sample
{ "responseItems": [ { "__typename": "LineItemResponseItem" } ] }

LineItemResponseItem

Represents a single line item response

activationId
String
errorMsg
String
status
String
Sample
{ "activationId": "Example String", "errorMsg": "Example String", "status": "Example String" }

Product

Represents a product entity.

licenseModel

License model associated with the product.

productName
String!,non-null

Product name.

productVersion
String

Product version.

quantityPerCopy
Int

Quantity per copy of the product.

Sample
{ "licenseModel": { "__typename": "LicenseModel" }, "productName": "Example String", "productVersion": "Example String", "quantityPerCopy": 40 }

Enums

Overview

Inputs

Overview