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, OBSOLETE
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": "Example String", "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, OBSOLETE
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": "Example String", "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, obsolete
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, obsolete
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 } }
Get a specific feature bundle by its name.
Arguments
Name of the feature bundle. Example: "MyFeatureBundle"
Return type
FeatureThe feature bundle details
query getFeatureBundle($featureBundleName: String!) {
getFeatureBundle(featureBundleName: $featureBundleName) {
featureBundle {
__typename
# ...FeatureBundleGetFragment
}
}
}{ "featureBundleName": "Example String" }
{ "data": { "featureBundle": { "__typename": "FeatureBundleGet" } } }
Get feature bundles with filtering and pagination support. Filters can be applied on featureBundleName, state, creationDate, and lastModifiedDate.
Arguments
Filter by creation date in ISO 8601 format. Example: "2024-01-15"
Filter by feature bundle name. Example: "MyFeatureBundle"
Filter by last modified date in ISO 8601 format. Example: "2024-01-20"
Number of records per page. Default: 25
Requested page number for pagination. Default: 1
Filter by feature bundle state. Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"
Return type
FeatureList of feature bundles
Pagination information
query getFeatureBundles(
$creationDate: String
$featureBundleName: String
$lastModifiedDate: String
$limit: Int
$page: Int
$state: String
) {
getFeatureBundles(
creationDate: $creationDate
featureBundleName: $featureBundleName
lastModifiedDate: $lastModifiedDate
limit: $limit
page: $page
state: $state
) {
featureBundles {
__typename
# ...FeatureBundleResponseDTOFragment
}
pagination {
__typename
# ...PaginationFragment
}
}
}{ "creationDate": "Example String", "featureBundleName": "Example String", "lastModifiedDate": "Example String", "limit": 40, "page": 40, "state": "Example String" }
{ "data": { "featureBundles": [ { "__typename": "FeatureBundleResponseDTO" } ], "pagination": { "__typename": "Pagination" } } }
Get features with filtering and pagination support. Filters can be applied on name, version, versionFormat, state, creationDate, lastModifiedDate, and vendorAuthString.
Arguments
Filter by creation date in ISO 8601 format. Example: "2024-01-15"
Filter by last modified date in ISO 8601 format. Example: "2024-01-20"
Number of records per page. Default: 25
Filter feature by name. Example: "MyFeature"
Requested page number for pagination. Default: 1
Feature state (e.g., DRAFT, DEPLOYED). Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"
Vendor authorization string for filtering.
Filter feature by version. Example: "1.0"
Filter feature by versionFormat. Valid values: FIXED, DATEBASED. Example: "FIXED"
Return type
PagedList of features
Pagination information
query getFeatures(
$creationDate: String
$lastModifiedDate: String
$limit: Int
$name: String
$page: Int
$state: String
$vendorAuthString: String
$version: String
$versionFormat: String
) {
getFeatures(
creationDate: $creationDate
lastModifiedDate: $lastModifiedDate
limit: $limit
name: $name
page: $page
state: $state
vendorAuthString: $vendorAuthString
version: $version
versionFormat: $versionFormat
) {
features {
__typename
# ...FeaturesResponseDTOFragment
}
pagination {
__typename
# ...PaginationFragment
}
}
}{ "creationDate": "Example String", "lastModifiedDate": "Example String", "limit": 40, "name": "Example String", "page": 40, "state": "Example String", "vendorAuthString": "Example String", "version": "Example String", "versionFormat": "Example String" }
{ "data": { "features": [ { "__typename": "FeaturesResponseDTO" } ], "pagination": { "__typename": "Pagination" } } }
Get maintenance products with filtering, sorting, and pagination support. Filters can be applied on maintenanceName, version, partNumber, state, creationDate, and lastModifiedDate.
Arguments
Filter by creation date (ISO 8601 format). Example: "2023-10-15T10:30:00Z"
Filter by last modified date (ISO 8601 format). Example: "2023-11-20T14:45:00Z"
Number of records per page. Default: 25
Filter by maintenance product name. Example: "MyMaintenanceProduct"
Requested page number for pagination. Default: 1
Filter by part number. Example: "PN-12345"
Field to sort by. Valid values: maintenanceName, state, partNumber, version, creationDate, lastModifiedDate. Example: "maintenanceName"
Order to sort by. Valid values: asc, desc. Example: "asc"
Filter by maintenance product state. Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"
Filter by maintenance product version. Example: "1.0"
Return type
MaintenanceList of maintenance products
Pagination information
query getMaintenanceProducts(
$creationDate: String
$lastModifiedDate: String
$limit: Int
$maintenanceName: String
$page: Int
$partNumber: String
$sort_by: String
$sort_order: String
$state: String
$version: String
) {
getMaintenanceProducts(
creationDate: $creationDate
lastModifiedDate: $lastModifiedDate
limit: $limit
maintenanceName: $maintenanceName
page: $page
partNumber: $partNumber
sort_by: $sort_by
sort_order: $sort_order
state: $state
version: $version
) {
maintenanceProducts {
__typename
# ...MaintenanceProductDTOFragment
}
pagination {
__typename
# ...PaginationFragment
}
}
}{ "creationDate": "Example String", "lastModifiedDate": "Example String", "limit": 40, "maintenanceName": "Example String", "page": 40, "partNumber": "Example String", "sort_by": "Example String", "sort_order": "Example String", "state": "Example String", "version": "Example String" }
{ "data": { "maintenanceProducts": [ { "__typename": "MaintenanceProductDTO" } ], "pagination": { "__typename": "Pagination" } } }
Get part numbers with filtering, sorting, and pagination support. Filters can be applied on partNumber, productName, licenseModel, dates, and mapping status.
Arguments
Filter by creation date in ISO 8601 format. Example: "2024-01-15"
Filter by last modified date in ISO 8601 format. Example: "2024-01-20"
Filter by license model. Example: "LicenseModelName"
Number of records per page. Default: 25
Requested page number for pagination. Default: 1
Filter by part number name. Example: "MyPartNumber"
Filter by product name. Example: "SampleProduct"
Field to sort by. Valid values: partNumber, productName, licenseModel, creationDate, lastModifiedDate. Example: "partNumber"
Order to sort by. Valid values: asc, desc. Default: asc.
Filter by unmapped with license model. Example: false.
Filter by unmapped with product. Example: true.
Return type
PartPagination information
List of part numbers
query getPartNumbers(
$creationDate: String
$lastModifiedDate: String
$licenseModel: String
$limit: Int
$page: Int
$partNumber: String
$productName: String
$sort_by: String
$sort_order: String
$unmappedWithLicenseModel: Boolean
$unmappedWithProduct: Boolean
) {
getPartNumbers(
creationDate: $creationDate
lastModifiedDate: $lastModifiedDate
licenseModel: $licenseModel
limit: $limit
page: $page
partNumber: $partNumber
productName: $productName
sort_by: $sort_by
sort_order: $sort_order
unmappedWithLicenseModel: $unmappedWithLicenseModel
unmappedWithProduct: $unmappedWithProduct
) {
pagination {
__typename
# ...PaginationFragment
}
partNumbers {
__typename
# ...PartNumberResponseDTOFragment
}
}
}{ "creationDate": "Example String", "lastModifiedDate": "Example String", "licenseModel": "Example String", "limit": 40, "page": 40, "partNumber": "Example String", "productName": "Example String", "sort_by": "Example String", "sort_order": "Example String", "unmappedWithLicenseModel": true, "unmappedWithProduct": true }
{ "data": { "pagination": { "__typename": "Pagination" }, "partNumbers": [ { "__typename": "PartNumberResponseDTO" } ] } }
Fetches a list of Products based on various filters
Arguments
Filter by description
Filter by host type
Filter by license technology
Number of records per page
Requested page number
Filter by part number
Filter by product ID
Filter by product name
Field to sort by (productName,state,partNumber,hosttype,licenseTechnology,version,usedOnDevice)
Order to sort by (asc/desc)
Filter by product state
Filter by used on device
Filter by product version
Return type
ProductRepresents pagination information
List of product entities
query getProducts(
$description: String
$hostType: String
$licenseTechnology: String
$limit: Int
$page: Int
$partNumber: String
$productId: ID
$productName: String
$sortBy: String
$sortOrder: String
$state: String
$usedOnDevice: String
$version: String
) {
getProducts(
description: $description
hostType: $hostType
licenseTechnology: $licenseTechnology
limit: $limit
page: $page
partNumber: $partNumber
productId: $productId
productName: $productName
sortBy: $sortBy
sortOrder: $sortOrder
state: $state
usedOnDevice: $usedOnDevice
version: $version
) {
pagination {
__typename
# ...PaginationFragment
}
productList {
__typename
# ...ProductFragment
}
}
}{ "description": "Example String", "hostType": "Example String", "licenseTechnology": "Example String", "limit": 40, "page": 40, "partNumber": "Example String", "productId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "productName": "Example String", "sortBy": "Example String", "sortOrder": "Example String", "state": "Example String", "usedOnDevice": "Example String", "version": "Example String" }
{ "data": { "pagination": { "__typename": "Pagination" }, "productList": [ { "__typename": "Product" } ] } }