- Product
Product details in part number response
License model associated with the product
Name of the product
Version of the product
{ "licenseModel": "Example String", "name": "Example String", "version": "Example String" }
Response object representing a part number with full details
Creation date of the part number
Description of the part number
Last modification date of the part number
Name of the part number
Product details associated with this part number
Trial availability flag
{ "createdDate": "Example String", "description": "Example String", "lastModifiedDate": "Example String", "name": "Example String", "product": { "__typename": "PartNumberProductResponseDTO" }, "trialAvailability": true }
Paginated response carrying a list of part numbers
Pagination information
List of part numbers
{ "pagination": { "__typename": "Pagination" }, "partNumbers": [ { "__typename": "PartNumberResponseDTO" } ] }
Entry in the part number creation response. Represents the result of creating a part number at a specific index.
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)
{ "index": 40, "result": { "__typename": "ResultItem" } }
Part number information for maintenance product.
Part number identifier
{ "partNumber": "Example String" }
Represents a product and its related licensing configuration
License model associated with the product
Unique product name
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 identifier of the product
Human readable description
List of feature bundles linked to this product
List of features belonging to this product
Supported host types
License generator identifier
License model associated with this product
Licensing technology identifier
Obsolete Fulfillment Download End User flag
Obsolete Fulfillment Download Producer flag
List of part numbers tied to the product
Product category label
Current lifecycle state of the product
Variable name for upgrade email template
Indicates if product is used on a device
{ "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 }
Paginated response carrying a list of products
Represents pagination information
List of product entities
{ "pagination": { "__typename": "Pagination" }, "productList": [ { "__typename": "Product" } ] }
Represents a generic response
Response message
Response status
{ "message": "Example String", "status": "Example String" }
Result item containing status and error message
Error message if status is error
Status of the operation (success/error)
{ "errorMsg": "Example String", "status": "Example String" }
Complete suite details including products, part numbers, and attributes.
Creation date (ISO 8601 format)
Description of the suite
List of supported host types
License generator
List of license models
License technology
Obsolete fulfillment download for end user
Obsolete fulfillment download for producer
Package name
Package version
Package version format
List of part numbers associated with the suite
List of products in the suite
State of the suite (e.g., DRAFT, DEPLOYED, OBSOLETE, INACTIVE)
Suite attributes (custom attributes)
Suite category
Name of the suite
Last modified date (ISO 8601 format)
Indicates if suite is used on device
Version of the suite
{ "createdOn": "Example String", "description": "Example String", "hostTypes": [ "Example String" ], "licenseGenerator": "Example String", "licenseModels": [ { "__typename": "LicenseModel" } ], "licenseTechnology": "Example String", "obsoleteFulfillmentDownloadEndUser": true, "obsoleteFulfillmentDownloadProducer": true, "packageName": "Example String", "packageVersion": "Example String", "packageVersionFormat": "Example String", "partNumbers": [ "Example String" ], "products": [ { "__typename": "SuiteProductDTO" } ], "state": "Example String", "suiteAttributes": [ "Example Custom Scalar" ], "suiteCategory": "Example String", "suiteName": "Example String", "updatedOn": "Example String", "usedOnDevice": true, "version": "Example String" }
Suite list item with basic information.
Creation date (ISO 8601 format)
Description of the suite
License generator
License technology
Obsolete fulfillment download for end user
Obsolete fulfillment download for producer
Package name
Package version
Package version format
State of the suite (e.g., DRAFT, DEPLOYED, OBSOLETE, INACTIVE)
Suite category
Name of the suite
Last modified date (ISO 8601 format)
Indicates if suite is used on device
Version of the suite
{ "createdOn": "Example String", "description": "Example String", "licenseGenerator": "Example String", "licenseTechnology": "Example String", "obsoleteFulfillmentDownloadEndUser": true, "obsoleteFulfillmentDownloadProducer": true, "packageName": "Example String", "packageVersion": "Example String", "packageVersionFormat": "Example String", "state": "Example String", "suiteCategory": "Example String", "suiteName": "Example String", "updatedOn": "Example String", "usedOnDevice": true, "version": "Example String" }