Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

PagedFeatureResponse

Paginated response carrying a list of features

List of features

pagination

Pagination information

Sample
{ "features": [ { "__typename": "FeaturesResponseDTO" } ], "pagination": { "__typename": "Pagination" } }

PagedUserResponse

Paginated users response

pagination

Pagination information

userList
[UserInfo!],non-null

List of user accounts

Sample
{ "pagination": { "__typename": "Pagination" }, "userList": [ { "__typename": "UserInfo" } ] }

Pagination

Represents the pagination information

limit
Int

Number of records per page

page
Int

Represents page number for pagination

totalCount
Int

Represents total number of records

Sample
{ "limit": 40, "page": 40, "totalCount": 40 }

PartNumberGraphQLResponse

Response for part number creation

List of part number creation results

Sample
{ "response": [ { "__typename": "PartNumberResultEntry" } ] }

PartNumberProductResponseDTO

Product details in part number response

licenseModel
String

License model associated with the product

name
String

Name of the product

version
String

Version of the product

Sample
{ "licenseModel": "Example String", "name": "Example String", "version": "Example String" }

PartNumberResponseDTO

Response object representing a part number with full details

createdDate
String

Creation date of the part number

description
String

Description of the part number

lastModifiedDate
String

Last modification date of the part number

name
String

Name of the part number

Product details associated with this part number

trialAvailability
Boolean

Trial availability flag

Sample
{ "createdDate": "Example String", "description": "Example String", "lastModifiedDate": "Example String", "name": "Example String", "product": { "__typename": "PartNumberProductResponseDTO" }, "trialAvailability": true }

PartNumberResponseListDTO

Paginated response carrying a list of part numbers

pagination

Pagination information

List of part numbers

Sample
{ "pagination": { "__typename": "Pagination" }, "partNumbers": [ { "__typename": "PartNumberResponseDTO" } ] }

PartNumberResultEntry

Entry in the part number creation response. Represents the result of creating a part number at a specific index.

index
Int!,non-null

Index of the part number in the input array. This maintains the same order as the input request. Example: 0, 1, 2

Result of the operation (success/error)

Sample
{ "index": 40, "result": { "__typename": "ResultItem" } }

PartNumbersDTO

Part number information for maintenance product.

partNumber
String

Part number identifier

Sample
{ "partNumber": "Example String" }

Product

Represents a product and its related licensing configuration

licenseModel

License model associated with the product

productName
String!,non-null

Unique product name

quantityPerCopy
Int

Quantity per copy of the product. This field is applicable only when the Product is linked through Entitlement → LineItem. Returns null if no relevant parent association exists

version
String

Version identifier of the product

description
String

Human readable description

featureBundles

List of feature bundles linked to this product

features

List of features belonging to this product

hostTypes
[String]

Supported host types

licenseGenerator
String

License generator identifier

licenseModels

License model associated with this product

licenseTechnology
String

Licensing technology identifier

obsoleteFulfillmentDownloadEndUser
Boolean

Obsolete Fulfillment Download End User flag

obsoleteFulfillmentDownloadProducer
Boolean

Obsolete Fulfillment Download Producer flag

partNumbers
[String]

List of part numbers tied to the product

productCategory
String

Product category label

state
String

Current lifecycle state of the product

upgradeEmailTemplateVarName
String

Variable name for upgrade email template

usedOnDevice
Boolean

Indicates if product is used on a device

Sample
{ "licenseModel": { "__typename": "LicenseModel" }, "productName": "Example String", "quantityPerCopy": 40, "version": "Example String", "description": "Example String", "featureBundles": [ { "__typename": "FeatureBundle" } ], "features": [ { "__typename": "Feature" } ], "hostTypes": [ "Example String" ], "licenseGenerator": "Example String", "licenseModels": [ { "__typename": "LicenseModel" } ], "licenseTechnology": "Example String", "obsoleteFulfillmentDownloadEndUser": true, "obsoleteFulfillmentDownloadProducer": true, "partNumbers": [ "Example String" ], "productCategory": "Example String", "state": "Example String", "upgradeEmailTemplateVarName": "Example String", "usedOnDevice": true }

ProductListDTO

Paginated response carrying a list of products

pagination

Represents pagination information

productList

List of product entities

Sample
{ "pagination": { "__typename": "Pagination" }, "productList": [ { "__typename": "Product" } ] }

Inputs

Overview

Scalars

Overview