Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Account

Represents an Account entity.

accountId
String!,non-null

Represents the unique identifier of the account.

accountName
String

Name of the account.

accountType

Represents the type of account.

contactEmail
String

Email address of the contact associated with the account.

currentOwner
Boolean

Flag indicating if this account is the current owner of the entitlement.

partnerTierName

Represents the partner tier associated with the account.

Sample
{ "accountId": "Example String", "accountName": "Example String", "accountType": "CHANNEL_PARTNER", "contactEmail": "Example String", "currentOwner": true, "partnerTierName": "END_CUSTOMER" }

ActivationId

Represents the activation ID of a line item.

activationId
String
Sample
{ "activationId": "Example String" }

Attribute

Represents a custom attribute associated with an entity.

name
String!,non-null

Name of the custom attribute.

value
String!,non-null

Respective value of the custom attribute.

Sample
{ "name": "Example String", "value": "Example String" }

Entitlement

Represents the entitlement entity.

createdOn
String

Represents the date and time when the entitlement was created.

description
String

Human readable description of the entitlement.

entitlementId
String!,non-null

Represents a high-level entitlement entity.

shipToAddress
String

Represents the shipping address associated with the entitlement.

shipToEmail
String

Email address associated with shipment contact.

status

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

updatedOn
String

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

EntitlementDetail

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
String

Represents the date and time when the entitlement was created.

description
String

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
String

Represents the shipping address associated with the entitlement.

shipToEmail
String

Email address associated with shipment contact.

status

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

updatedOn
String

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

EntitlementListResponse

Paginated response carrying a list of entitlements.

entitlements

List of entitlement entities.

limit
Int

Represents limit per page for pagination.

page
Int

Represents page for pagination.

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

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

Enums

Overview

Inputs

Overview