Fetches an Entitlement associated to the given Activation ID
Arguments
Return type
EntitlementRepresents the date and time when the entitlement was created.
Human readable description of the entitlement.
Represents a high-level entitlement entity.
Represents the shipping address associated with the entitlement.
Email address associated with shipment contact.
status could be one of the following values: ACTIVE, INACTIVE, DRAFT, DEPLOYED, OBSOLETED
Represents the date and time when the entitlement was last updated.
query getEntitlementByActivationId($activationId: String!) {
getEntitlementByActivationId(activationId: $activationId) {
createdOn
description
entitlementId
shipToAddress
shipToEmail
status
updatedOn
}
}{ "activationId": "Example String" }
{ "data": { "createdOn": "Example String", "description": "Example String", "entitlementId": "Example String", "shipToAddress": "Example String", "shipToEmail": "Example String", "status": "DEPLOYED", "updatedOn": "Example String" } }
Fetches an Entitlement by its ID.
Arguments
Return type
EntitlementRepresents the accounts associated with the entitlement.
Represents the custom attributes associated with the entitlement.
Represents the date and time when the entitlement was created.
Human readable description of the entitlement.
Unique identifier of the entitlement.
List of line items associated with the entitlement.
Represents the shipping address associated with the entitlement.
Email address associated with shipment contact.
status could be one of the following values: ACTIVE, INACTIVE, DRAFT, DEPLOYED, OBSOLETED
Represents the date and time when the entitlement was last updated.
query getEntitlementById($entitlementId: String!) {
getEntitlementById(entitlementId: $entitlementId) {
accounts {
__typename
# ...AccountFragment
}
attributes {
__typename
# ...AttributeFragment
}
createdOn
description
entitlementId
lineItems {
__typename
# ...LineItemDetailFragment
}
shipToAddress
shipToEmail
status
updatedOn
}
}{ "entitlementId": "Example String" }
{ "data": { "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" } }
Fetches a list of Entitlements based on various filters.
Arguments
Unique identifier for the account
Name of the account
Contact email associated with the entitlement
limit number of records per page
page number for pagination
Product Part number associated with the entitlement
Product associated with the entitlement
Product version associated with the entitlement
sortBy - You can sort by the following fields entitlement_id,account_name,created_on
sortOrder - You can specify either asc or desc
status - You can filter by the following statuses active, inactive, draft, deployed, obsoleted
Return type
EntitlementList of entitlement entities.
Represents limit per page for pagination.
Represents page for pagination.
query getEntitlements(
$accountId: String
$accountName: String
$contactEmail: String
$limit: Int
$page: Int
$partNumber: String
$product: String
$productVersion: String
$sortBy: String
$sortOrder: String
$status: String
) {
getEntitlements(
accountId: $accountId
accountName: $accountName
contactEmail: $contactEmail
limit: $limit
page: $page
partNumber: $partNumber
product: $product
productVersion: $productVersion
sortBy: $sortBy
sortOrder: $sortOrder
status: $status
) {
entitlements {
__typename
# ...EntitlementFragment
}
limit
page
}
}{ "accountId": "Example String", "accountName": "Example String", "contactEmail": "Example String", "limit": 40, "page": 40, "partNumber": "Example String", "product": "Example String", "productVersion": "Example String", "sortBy": "Example String", "sortOrder": "Example String", "status": "Example String" }
{ "data": { "entitlements": [ { "__typename": "Entitlement" } ], "limit": 40, "page": 40 } }
Given an entitlement ID, fetch the line items associated with it.
Arguments
Activation ID of the line item
Entitlement ID for which line items are to be fetched
License model name associated with the line item.
limit number of records per page
page number for pagination
Name of the product associated with the line item
Start date of the line item.
Status of the line item. You can filter by the following statuses active, inactive, draft, deployed, obsoleted
Return type
LineRepresents limit per page for pagination.
List of line item entities.
Represents page for pagination.
query getLineItemsForEntitlement(
$activationId: String
$entitlementId: String!
$licenseModelName: String
$limit: Int
$page: Int
$productName: String
$startDate: String
$status: String
) {
getLineItemsForEntitlement(
activationId: $activationId
entitlementId: $entitlementId
licenseModelName: $licenseModelName
limit: $limit
page: $page
productName: $productName
startDate: $startDate
status: $status
) {
limit
lineItems {
__typename
# ...LineItemFragment
}
page
}
}{ "activationId": "Example String", "entitlementId": "Example String", "licenseModelName": "Example String", "limit": 40, "page": 40, "productName": "Example String", "startDate": "Example String", "status": "Example String" }
{ "data": { "limit": 40, "lineItems": [ { "__typename": "LineItem" } ], "page": 40 } }