Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

createMaintenanceProduct

(input)

Create a new maintenance product.

Arguments

input

Input data for creating a maintenance product

Return type

CreateMaintenanceProductResponse
maintenanceProduct
String

Name of the maintenance product

message
String

Status message for the operation

status
String

Status of the operation (e.g., "success")

version
String

Version of the maintenance product

Mutation sample
mutation createMaintenanceProduct($input: CreateMaintenanceProductInput!) {
  createMaintenanceProduct(input: $input) {
    maintenanceProduct 
    message 
    status 
    version 
  }
}
Variables
{ "input": { "allowRenewals": true, "allowUpgrades": true, "allowUpsells": true, "description": "Example String", "maintenanceName": "Example String", "partNumberList": [ { "__typename": "MaintenanceProductPartNumberInput" } ], "productLine": "Example String", "productList": [ { "__typename": "MaintenanceProductProductInput" } ], "version": "Example String" } }
Response sample
{ "data": { "maintenanceProduct": "Example String", "message": "Example String", "status": "Example String", "version": "Example String" } }

createPartNumbers

(input)

Create one or more part numbers.

Arguments

input
CreatePartNumberInput!,non-nullrequired

Input data for creating part numbers

Return type

PartNumberGraphQLResponse

List of part number creation results

Mutation sample
mutation createPartNumbers($input: CreatePartNumberInput!) {
  createPartNumbers(input: $input) {
    response {
      __typename
      # ...PartNumberResultEntryFragment
    }
  }
}
Variables
{ "input": { "partNumbers": [ { "__typename": "PartNumberInput" } ] } }
Response sample
{ "data": { "response": [ { "__typename": "PartNumberResultEntry" } ] } }

createProduct

(input)

Create a new product.

Arguments

input
CreateProductInput!,non-nullrequired

Input data for creating a product

Return type

CreateProductResponse
message
String

Status message for the operation

status
String

Status of the operation (e.g., "success")

Mutation sample
mutation createProduct($input: CreateProductInput!) {
  createProduct(input: $input) {
    message 
    status 
  }
}
Variables
{ "input": { "allowObsoleteFulfilmentInEP": true, "allowObsoleteFulfilmentInPP": true, "autoDeploy": true, "description": "Example String", "endDate": "Example String", "featureBundles": [ { "__typename": "FeatureBundleInput" } ], "features": [ { "__typename": "FeatureInput" } ], "hostTypes": [ "Example String" ], "licenseGenerator": "Example String", "licenseModels": [ "Example String" ], "licenseTechnology": "Example String", "partNumbers": [ { "__typename": "PartNumberRequestInput" } ], "productCategory": "Example String", "productCategoryAttributes": [ { "__typename": "AttributesInput" } ], "productCustomAttributes": [ { "__typename": "AttributesInput" } ], "productName": "Example String", "productUpgradeEmailTemplate": "Example String", "startDate": "Example String", "trustedKey": "Example String", "usedOnDevice": true, "version": "Example String", "virtualTrustedKey": "Example String" } }
Response sample
{ "data": { "message": "Example String", "status": "Example String" } }

createSuite

(input)

Create a new product suite.

Arguments

input
CreateSuiteInput!,non-nullrequired

Input data for creating a suite

Return type

CreateSuiteResponse
message
String

Success or error message

suiteName
String

Name of the created suite

Mutation sample
mutation createSuite($input: CreateSuiteInput!) {
  createSuite(input: $input) {
    message 
    suiteName 
  }
}
Variables
{ "input": { "allowDownloadObsoleteFrInAdmin": true, "allowDownloadObsoleteFrInPortal": true, "autoDeploy": true, "customAttributes": [ { "__typename": "AttributesInput" } ], "description": "Example String", "hostTypes": [ "Example String" ], "licenseGenerator": "Example String", "licenseModels": [ "Example String" ], "licenseTechnology": "Example String", "packageProperties": { "__typename": "SuitePackageInput" }, "partNumbers": [ { "__typename": "PartNumberRequestInput" } ], "productCategory": "Example String", "productCategoryAttributes": [ { "__typename": "AttributesInput" } ], "products": [ { "__typename": "SuiteProductRequestInput" } ], "suiteName": "Example String", "trustedKey": "Example String", "usedOnDevice": true, "version": "Example String", "virtualTrustedKey": "Example String" } }
Response sample
{ "data": { "message": "Example String", "suiteName": "Example String" } }

createAccount

(input)

Create an Account

Arguments

input
CreateAccountInput!,non-nullrequired

Return type

AccountCreationResponse
message
String

Account creation success message

status
String

Status of the account creation

Mutation sample
mutation createAccount($input: CreateAccountInput!) {
  createAccount(input: $input) {
    message 
    status 
  }
}
Variables
{ "input": { "accountId": "Example String", "accountType": "Example String", "address1": "Example String", "address2": "Example String", "attributes": [ { "__typename": "AttributeInput" } ], "city": "Example String", "country": "Example String", "description": "Example String", "name": "Example String", "region": "Example String", "state": "Example String", "visible": true, "zipcode": "Example String" } }
Response sample
{ "data": { "message": "Example String", "status": "Example String" } }

createUser

(input)

Create a User

Arguments

input
CreateUserInput!,non-nullrequired

Return type

UserCreationResponse
message
String

User creation success message

status
String

Status of the user created

Mutation sample
mutation createUser($input: CreateUserInput!) {
  createUser(input: $input) {
    message 
    status 
  }
}
Variables
{ "input": { "accountRoles": [ { "__typename": "UserAccountRoleInput" } ], "attributes": [ { "__typename": "AttributeInput" } ], "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" } }
Response sample
{ "data": { "message": "Example String", "status": "Example String" } }

Objects

Overview

Inputs

Overview

Scalars

Overview