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" } ] } }
Get a single suite by its name and version.
Arguments
Suite name of the suite to retrieve. Example: "Suite A"
Suite version of the suite to retrieve. Example: "1.0"
Return type
SuiteThe suite data
query getSuite($suiteName: String!, $suiteVersion: String!) {
getSuite(suiteName: $suiteName, suiteVersion: $suiteVersion) {
suite {
__typename
# ...SuiteDTOFragment
}
}
}{ "suiteName": "Example String", "suiteVersion": "Example String" }
{ "data": { "suite": { "__typename": "SuiteDTO" } } }
Get suites with filtering, sorting, and pagination support. Filters can be applied on suiteName, version, description, partNumber, state, packageName, packageVersion, hostType, licenseTechnology, licenseGenerator, usedOnDevice, creationDate, and lastModifiedDate.
Arguments
Filter by creation date (ISO 8601 format). Example: "2023-10-15T10:30:00Z"
Filter by description. Example: "Product suite for enterprise"
Filter by host type. Example: "Windows"
Filter by last modified date (ISO 8601 format). Example: "2023-11-20T14:45:00Z"
Filter by license generator. Example: "GeneratorX"
Filter by license technology. Example: "FlexNet"
Number of records per page. Default: 25
Filter by package name. Example: "PackageA"
Filter by package version. Example: "2.0"
Requested page number for pagination. Default: 1
Filter by part number. Example: "PN-12345"
Field to sort by. Valid values: suiteName, createdOn. Example: "suiteName"
Order to sort by. Valid values: asc, desc. Example: "asc"
Filter by suite state. Valid values: DRAFT, DEPLOYED, OBSOLETE, INACTIVE. Example: "DEPLOYED"
Filter by suite name. Example: "Suite A"
Filter by used on device flag. Example: true
Filter by suite version. Example: "1.0"
Return type
SuitePagination information
List of suites
query getSuites(
$creationDate: String
$description: String
$hostType: String
$lastModifiedDate: String
$licenseGenerator: String
$licenseTechnology: String
$limit: Int
$packageName: String
$packageVersion: String
$page: Int
$partNumber: String
$sort_by: String
$sort_order: String
$state: String
$suiteName: String
$usedOnDevice: Boolean
$version: String
) {
getSuites(
creationDate: $creationDate
description: $description
hostType: $hostType
lastModifiedDate: $lastModifiedDate
licenseGenerator: $licenseGenerator
licenseTechnology: $licenseTechnology
limit: $limit
packageName: $packageName
packageVersion: $packageVersion
page: $page
partNumber: $partNumber
sort_by: $sort_by
sort_order: $sort_order
state: $state
suiteName: $suiteName
usedOnDevice: $usedOnDevice
version: $version
) {
pagination {
__typename
# ...PaginationFragment
}
suiteList {
__typename
# ...SuiteListItemDTOFragment
}
}
}{ "creationDate": "Example String", "description": "Example String", "hostType": "Example String", "lastModifiedDate": "Example String", "licenseGenerator": "Example String", "licenseTechnology": "Example String", "limit": 40, "packageName": "Example String", "packageVersion": "Example String", "page": 40, "partNumber": "Example String", "sort_by": "Example String", "sort_order": "Example String", "state": "Example String", "suiteName": "Example String", "usedOnDevice": true, "version": "Example String" }
{ "data": { "pagination": { "__typename": "Pagination" }, "suiteList": [ { "__typename": "SuiteListItemDTO" } ] } }
Gets accounts with filtering and pagination
Arguments
Unique identifier of the account to filter by
Name of the account to filter by
Type of the account to filter by. Valid values: CUSTOMER, PUBLISHER, CHANNEL_PARTNER, SELF_REGISTERED. Default: CUSTOMER
Number of records per page
Page number for pagination
Whether to return only root accounts (accounts without parent). Default: false
Return type
PagedList of accounts
Pagination information
query getAccounts(
$accountId: String
$accountName: String
$accountType: [String]
$limit: Int
$page: Int
$rootAccountOnly: Boolean
) {
getAccounts(
accountId: $accountId
accountName: $accountName
accountType: $accountType
limit: $limit
page: $page
rootAccountOnly: $rootAccountOnly
) {
accounts {
__typename
# ...AccountFragment
}
pagination {
__typename
# ...PaginationFragment
}
}
}{ "accountId": "Example String", "accountName": "Example String", "accountType": [ "Example String" ], "limit": 40, "page": 40, "rootAccountOnly": true }
{ "data": { "accounts": [ { "__typename": "Account" } ], "pagination": { "__typename": "Pagination" } } }
Gets the user account details by the user ID
Arguments
UserId of the user to retrieve details for
Return type
UserAccounts associated with the user
Represents the custom attributes associated with the account
City of the user
Country of the user
Display name of the user
Email address of the user
Fax number of the user
First name of the user
Last name of the user
Locale preference of the user
Whether the user has opted in for communications
Phone number of the user
Whether the user can login
Whether the user is shared across accounts
State or province of the user
Status of the user account (active/inactive)
Street address of the user
Timezone preference of the user
Username of the user
Postal/ZIP code of the user
query getUserByID($UserID: String!) {
getUserByID(UserID: $UserID) {
accounts {
__typename
# ...UserAccountFragment
}
attributes {
__typename
# ...AttributeFragment
}
city
country
displayName
emailAddress
faxNumber
firstName
lastName
locale
optIn
phoneNumber
portalLogin
shared
state
status
street
timezone
userName
zipcode
}
}{ "UserID": "Example String" }
{ "data": { "accounts": [ { "__typename": "UserAccount" } ], "attributes": [ { "__typename": "Attribute" } ], "city": "Example String", "country": "Example String", "displayName": "Example String", "emailAddress": "Example String", "faxNumber": "Example String", "firstName": "Example String", "lastName": "Example String", "locale": "Example String", "optIn": true, "phoneNumber": "Example String", "portalLogin": true, "shared": true, "state": "Example String", "status": "Example String", "street": "Example String", "timezone": "Example String", "userName": "Example String", "zipcode": "Example String" } }
Gets all users with optional filtering, sorting, and pagination
Arguments
Unique identifier of the account to filter users by
Name of the account to filter users by
Type of the account to filter users by. Valid values: HOME, PUBLISHER, END_CUSTOMER, CHANNEL_PARTNER, SELF_REGISTERED
Display name of the user to filter by
Email address of the user to filter by
Number of records per page. Default: 25
Page number for pagination. Default: 1
Field to sort results by. Valid values: displayName, email, status. Default: displayName
Sort order for the results. Valid values: asc, desc. Default: asc
Status of the user account to filter by. Valid values: active, inactive
Username to filter by
Return type
PagedPagination information
List of user accounts
query getUsers(
$accountId: String
$accountName: String
$accountType: String
$displayName: String
$email: String
$limit: Int
$page: Int
$sort_by: String
$sort_order: String
$status: String
$userName: String
) {
getUsers(
accountId: $accountId
accountName: $accountName
accountType: $accountType
displayName: $displayName
email: $email
limit: $limit
page: $page
sort_by: $sort_by
sort_order: $sort_order
status: $status
userName: $userName
) {
pagination {
__typename
# ...PaginationFragment
}
userList {
__typename
# ...UserInfoFragment
}
}
}{ "accountId": "Example String", "accountName": "Example String", "accountType": "Example String", "displayName": "Example String", "email": "Example String", "limit": 40, "page": 40, "sort_by": "Example String", "sort_order": "Example String", "status": "Example String", "userName": "Example String" }
{ "data": { "pagination": { "__typename": "Pagination" }, "userList": [ { "__typename": "UserInfo" } ] } }