Skip to content
Overview
Overview
Overview
Overview

Represents the entitlement entity.

createdOn

Represents the date and time when the entitlement was created.

description

Human readable description of the entitlement.

entitlementId
String!,non-null

Represents a high-level entitlement entity.

shipToAddress

Represents the shipping address associated with the entitlement.

shipToEmail

Email address associated with shipment contact.

status

status could be one of the following values: ACTIVE, INACTIVE, DRAFT, DEPLOYED, OBSOLETED

updatedOn

Represents the date and time when the entitlement was last updated.

Sample
{ "createdOn": "Example String", "description": "Example String", "entitlementId": "Example String", "shipToAddress": "Example String", "shipToEmail": "Example String", "status": "DEPLOYED", "updatedOn": "Example String" }

Entitlement details including associated accounts and line items.

accounts
[Account!]!,non-null

Represents the accounts associated with the entitlement.

attributes

Represents the custom attributes associated with the entitlement.

createdOn

Represents the date and time when the entitlement was created.

description

Human readable description of the entitlement.

entitlementId
String!,non-null

Unique identifier of the entitlement.

lineItems

List of line items associated with the entitlement.

shipToAddress

Represents the shipping address associated with the entitlement.

shipToEmail

Email address associated with shipment contact.

status

status could be one of the following values: ACTIVE, INACTIVE, DRAFT, DEPLOYED, OBSOLETED

updatedOn

Represents the date and time when the entitlement was last updated.

Sample
{ "accounts": [ { "__typename": "Account" } ], "attributes": [ { "__typename": "Attribute" } ], "createdOn": "Example String", "description": "Example String", "entitlementId": "Example String", "lineItems": [ { "__typename": "LineItemDetail" } ], "shipToAddress": "Example String", "shipToEmail": "Example String", "status": "DEPLOYED", "updatedOn": "Example String" }

Paginated response carrying a list of entitlements.

entitlements

List of entitlement entities.

limit

Represents limit per page for pagination.

page

Represents page for pagination.

Sample
{ "entitlements": [ { "__typename": "Entitlement" } ], "limit": 40, "page": 40 }

Represents a license model entity.

issuer

Issuer associated with the license model.

licenseModelName
String!,non-null

License model name.

notice

Notice associated with the license model.

serialNumber

Serial number associated with the license model.

vendorString

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

Represents a line item in the entitlement

activationId
String!,non-null

Unique activation identifier of the line item.

duration

Duration that the line item will be active.

expiryDate

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

Indicates if the line item is permanent.

products
[Product!]!,non-null

Products associated with the line item.

quantity

Represents the quantity of the line item.

startDate

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" }

Detailed information about a line item.

activationId
String!,non-null

Unique activation identifier of the line item.

duration

Duration that the line item will be active.

expiryDate

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

Indicates if the line item is permanent.

products
[Product!]!,non-null

Products associated with the line item.

quantity

Represents the quantity of the line item.

startDate

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" }

Paginated response carrying a list of line items.

limit

Represents limit per page for pagination.

lineItems
[LineItem!]!,non-null

List of line item entities.

page

Represents page for pagination.

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

Response a list type line item response

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

Represents a single line item response

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

Represents a product entity.

licenseModel

License model associated with the product.

productName
String!,non-null

Product name.

productVersion

Product version.

quantityPerCopy

Quantity per copy of the product.

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