Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview

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" }

PolicyInput

Represents a Policy

acpiGenerationIdLicense
Boolean

ACPI Generation ID License Policy

cancelLicense
Boolean

Cancel license policy

extraActivations
Int

Number of extra activations

Number of rehosts

Number of repairs

Number of returns

virtualLicense
Boolean

Virtual license policy

Sample
{ "acpiGenerationIdLicense": true, "cancelLicense": true, "extraActivations": 40, "rehosts": { "__typename": "PolicyAttributeInput" }, "repairs": { "__typename": "PolicyAttributeInput" }, "returns": { "__typename": "PolicyAttributeInput" }, "virtualLicense": true }

ProductInput

Represents a Product

licenseModel

License model associated with the product

productName
String!,non-null

Name of the product. Example: "SampleProduct"

productVersion
String!,non-null

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

Sample
{ "licenseModel": { "__typename": "LicenseModelInput" }, "productName": "Example String", "productVersion": "Example String" }
Referenced in

SuitePackageInput

Suite package properties input.

name
String

Name of the package. Example: "PackageA"

version
String

Version of the package. Example: "2.0"

versionFormat
String

Version format of the package. Example: "FIXED"

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

SuiteProductRequestInput

Suite product request input.

count
Int

Count/quantity of the product. Example: 5

name
String

Name of the product. Example: "Product A"

version
String

Version of the product. Example: "1.0"

Sample
{ "count": 40, "name": "Example String", "version": "Example String" }

Scalars

Overview