Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview

LinkLineItemInput

Input for line item to be linked

activationId
String!,non-null

Activation ID of the line item

Sample
{ "activationId": "Example String" }

LinkMaintenanceLineItemInput

Input to link a maintenance line item

lineItem

Line Item activation ID to be linked with maintenance line item

maintenanceLineItem

Maintenance Line item activation ID to be linked with line item

Sample
{ "lineItem": { "__typename": "LinkLineItemInput" }, "maintenanceLineItem": { "__typename": "MaintenanceLinkLineItemInput" } }

MaintenanceLineItemInput

activationId
String

Activation ID of the maintenance line item. If you specify the activation ID, then it must be unique across all entitlements and maintenance line items. If you specify the activation ID here, then the autoGenerate flag must be set to false. Example: "act-id-1234"

List of custom attributes related to the maintenance line item

autoDeploy
Boolean

Whether the maintenance Line item should be auto-deployed

autoGenerate
Boolean

Whether the activation ID should be auto-generated

expiryDate
String

End date of the maintenance line item in YYYY-MM-DD format. Example: "2025-01-01"

maintenanceProduct

List of products entitled by this maintenance line item

permanent
Boolean

Whether this maintenance line item is permanent. A permanent maintenance line item has no expiration date

startDate
String!,non-null

Start date of the maintenance line item in YYYY-MM-DD format. Example: "2025-01-01"

Sample
{ "activationId": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "autoDeploy": true, "autoGenerate": true, "expiryDate": "Example String", "maintenanceProduct": { "__typename": "MaintenanceProductInput" }, "permanent": true, "startDate": "Example String" }

MaintenanceLinkLineItemInput

Input for maintenance line item to be linked

activationId
String!,non-null

Activation ID of the maintenance line item

Sample
{ "activationId": "Example String" }

MaintenanceProductInput

maintenanceProductName
String

Name of the maintenance product

maintenanceProductVersion
String

Version of the maintenance product

partNumber
String

Part number associated with maintenance product

Sample
{ "maintenanceProductName": "Example String", "maintenanceProductVersion": "Example String", "partNumber": "Example String" }

MaintenanceProductPartNumberInput

Maintenance product part number input.

partNumber
String!,non-null

Name to uniquely identify the part number. Can only contain ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyPartNumber"

Sample
{ "partNumber": "Example String" }

MaintenanceProductProductInput

Maintenance product product input.

productName
String!,non-null

Name to uniquely identify the product name. Can only contain ASCII letters, numbers, or _ (underscore) with no whitespace. Maximum length: 64 characters. Example: "MyProduct"

version
String!,non-null

Version to uniquely identify the product version. Maximum length: 64 characters. Example: "1.0"

Sample
{ "productName": "Example String", "version": "Example String" }

PartNumberInput

Input for a single part number

description
String

Describe the characteristics of this part number. Maximum length: 2000 characters. Example: "This part number is for enterprise customers."

partNumber
String!,non-null

Name to uniquely identify the part number. Can only contain ASCII letters, numbers, spaces, dots, or _ (underscore) and - (hyphen). Cannot be only spaces. Maximum length: 200 characters. Example: "MyPartNumber"

Optional Product to be assigned to this part number.

trialAvailability
Boolean

Trial Availability flag to indicate whether the part number is available for trial. Default: false.

Sample
{ "description": "Example String", "partNumber": "Example String", "product": { "__typename": "PartNumberProductInput" }, "trialAvailability": true }

PartNumberProductInput

Product associated with part number

licenseModel
String

License model associated with the product. Example: "LicenseModelName"

name
String!,non-null

Name of the product. Example: "SampleProduct"

version
String!,non-null

Version of the product. Example: "SampleVersion-1.0"

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

PartNumberRequestInput

Part number request input.

licenseModelName
String

License model name to be associated with the part number. If empty or null, license model details will not be associated. Example: "Embedded Counted"

partNumber
String

Part number associated with the product. Example: "PN-12345"

Sample
{ "licenseModelName": "Example String", "partNumber": "Example String" }

PolicyAttributeInput

Represents attributes for a given policy

allowedCount
Int!,non-null

Allowed Policy Count for the given Line Item

policyTermDuration
Int!,non-null

License Model Policy term duration used is given Line Item

policyTermUnit
String!,non-null

License Model Policy term unit used is given Line Item. Valid types are Days, Weeks, Months, Years

Sample
{ "allowedCount": 40, "policyTermDuration": 40, "policyTermUnit": "Example String" }

Scalars

Overview