Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview

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

UpdateLicenseModelInput

Represents an update to a License Model

autoProvision
Boolean

Auto Provision flag

gracePeriodDays
String

Represents the grace period days

issuer
String

specify who is issuing the license

maxBorrowInterval
Int

Represents the max borrow interval

name
String!,non-null

Name of the license model

notice
String

This field is usually set at entitlement time and includes customer name and purchase order

overdraft
String

Represents the overdraft

serialNumber
String

specify the serial number of the license

vendorString
String

Unique value assigned by each publisher to each license

Sample
{ "autoProvision": true, "gracePeriodDays": "Example String", "issuer": "Example String", "maxBorrowInterval": 40, "name": "Example String", "notice": "Example String", "overdraft": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }

UpdateProductInput

Represents an update to a Product

licenseModel

License Model Details

partNumber
String

Part Number related to Product

productName
String!,non-null

Product Name related to the line item

productVersion
String!,non-null

Product Version related to the line item

Sample
{ "licenseModel": { "__typename": "UpdateLicenseModelInput" }, "partNumber": "Example String", "productName": "Example String", "productVersion": "Example String" }

UserAccountRoleInput

Input for user account role association

accountName
String!,non-null

Account Name [unique identifier of Account - short name] which needs to be linked to User. Example: "123456"

expiryDate
String

Expiry date of the user in YYYY-MM-DD format. Expiry date should be provided when portalLogin flag is true. It is the date when user is no longer linked to the account. If included, the value cannot be null. If not included, the user's access to the account will not expire. Example: "2025-12-30"

roles
[String!]!,non-null

List of roles. Example: ["USER", "ADMIN"]

Sample
{ "accountName": "Example String", "expiryDate": "Example String", "roles": [ "Example String" ] }

Scalars

Overview