Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

LicenseModel

Represents a license model entity

issuer
String

Issuer associated with the license model. This field is applicable only when the LicenseModel is linked through Entitlement → LineItem → Product. Returns null if no relevant parent association exists

licenseModelName
String!,non-null

License Model name

notice
String

Notice associated with the license model. This field is applicable only when the LicenseModel is linked through Entitlement → LineItem → Product. Returns null if no relevant parent association exists

serialNumber
String

Serial number associated with the license model. This field is applicable only when the LicenseModel is linked through Entitlement → LineItem → Product. Returns null if no relevant parent association exists

vendorString
String

Vendor string associated with the license model. This field is applicable only when the LicenseModel is linked through Entitlement → LineItem → Product. Returns null if no relevant parent association exists

Sample
{ "issuer": "Example String", "licenseModelName": "Example String", "notice": "Example String", "serialNumber": "Example String", "vendorString": "Example String" }

LineItem

Represents a line item in the entitlement

activationId
String!,non-null

Unique activation identifier of the line item

duration
Int

Duration that the line item will be active

expiryDate
String

Expiry date of the line item

lineItemState
String

Represents the current state of the line item active/inactive/draft/deployed/obsolete

orderType
String

Represents the line item order type

permanent
Boolean

Indicates if the line item is permanent

products
[Product!]!,non-null

Products associated with the line item

quantity
Int

Represents the quantity of the line item

startDate
String

Start date of the line item

Sample
{ "activationId": "Example String", "duration": 40, "expiryDate": "Example String", "lineItemState": "Example String", "orderType": "Example String", "permanent": true, "products": [ { "__typename": "Product" } ], "quantity": 40, "startDate": "Example String" }

LineItemDetail

Detailed information about a line item

activationId
String!,non-null

Unique activation identifier of the line item

duration
Int

Duration that the line item will be active

expiryDate
String

Expiry date of the line item

lineItemState
String

Represents the current state of the line item active/inactive/draft/deployed/obsolete

orderType
String

Represents the line item order type

permanent
Boolean

Indicates if the line item is permanent

products
[Product!]!,non-null

Products associated with the line item

quantity
Int

Represents the quantity of the line item

startDate
String

Start date of the line item

Sample
{ "activationId": "Example String", "duration": 40, "expiryDate": "Example String", "lineItemState": "Example String", "orderType": "Example String", "permanent": true, "products": [ { "__typename": "Product" } ], "quantity": 40, "startDate": "Example String" }

LineItemGraphQLResponse

GraphQL response for line item creation

List of line item creation results

Sample
{ "response": [ { "__typename": "LineItemResultEntry" } ] }

LineItemListResponse

Paginated response carrying a list of line items

limit
Int

Represents limit per page for pagination

lineItems
[LineItem!]!,non-null

List of line item entities

page
Int

Represents page for pagination

Sample
{ "limit": 40, "lineItems": [ { "__typename": "LineItem" } ], "page": 40 }

LineItemResponse

Response a list type line item response

Sample
{ "responseItems": [ { "__typename": "LineItemResponseItem" } ] }

LineItemResponseItem

Represents a single line item response

activationId
String
errorMsg
String
status
String
Sample
{ "activationId": "Example String", "errorMsg": "Example String", "status": "Example String" }

LineItemResult

Result item containing status, activation ID and error message

activationId
String

Activation ID if successful

errorMsg
String

Error message if status is error

status
String

Status of the operation (success/error)

Sample
{ "activationId": "Example String", "errorMsg": "Example String", "status": "Example String" }

LineItemResultEntry

Entry in the line item creation response. Represents the result of creating a line item at a specific index.

index
Int!,non-null

Index of the line item in the input array. This maintains the same order as the input request. Example: 0, 1, 2

Result of the operation (success/error)

Sample
{ "index": 40, "result": { "__typename": "LineItemResult" } }

MaintenanceProductDTO

Maintenance product information.

creationDate
String

Creation date in ISO format

description
String

Description of the maintenance product

lastModifiedDate
String

Last modified date in ISO format

maintenanceName
String

Name of the maintenance product

partNumbers

List of associated part numbers

state
String

State of the maintenance product

version
String

Version of the maintenance product

Sample
{ "creationDate": "Example String", "description": "Example String", "lastModifiedDate": "Example String", "maintenanceName": "Example String", "partNumbers": [ { "__typename": "PartNumbersDTO" } ], "state": "Example String", "version": "Example String" }

MaintenanceProductListDTO

Maintenance product list response.

maintenanceProducts

List of maintenance products

pagination

Pagination information

Sample
{ "maintenanceProducts": [ { "__typename": "MaintenanceProductDTO" } ], "pagination": { "__typename": "Pagination" } }

Inputs

Overview

Scalars

Overview