Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

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

OverrideProperties

Override properties for a feature

notice
String

Notice string to override the default value

serialNumber
String

Serial number to override the default value

vendorString
String

Vendor string to override the default value

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

PagedAccountResponse

Paginated account response

accounts
[Account!],non-null

List of accounts

pagination

Pagination information

Sample
{ "accounts": [ { "__typename": "Account" } ], "pagination": { "__typename": "Pagination" } }

PagedFeatureResponse

Paginated response carrying a list of features

List of features

pagination

Pagination information

Sample
{ "features": [ { "__typename": "FeaturesResponseDTO" } ], "pagination": { "__typename": "Pagination" } }

PagedUserResponse

Paginated users response

pagination

Pagination information

userList
[UserInfo!],non-null

List of user accounts

Sample
{ "pagination": { "__typename": "Pagination" }, "userList": [ { "__typename": "UserInfo" } ] }

Pagination

Represents the pagination information

limit
Int

Number of records per page

page
Int

Represents page number for pagination

totalCount
Int

Represents total number of records

Sample
{ "limit": 40, "page": 40, "totalCount": 40 }

PartNumberGraphQLResponse

Response for part number creation

List of part number creation results

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

PartNumberProductResponseDTO

Product details in part number response

licenseModel
String

License model associated with the product

name
String

Name of the product

version
String

Version of the product

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

PartNumberResponseDTO

Response object representing a part number with full details

createdDate
String

Creation date of the part number

description
String

Description of the part number

lastModifiedDate
String

Last modification date of the part number

name
String

Name of the part number

Product details associated with this part number

trialAvailability
Boolean

Trial availability flag

Sample
{ "createdDate": "Example String", "description": "Example String", "lastModifiedDate": "Example String", "name": "Example String", "product": { "__typename": "PartNumberProductResponseDTO" }, "trialAvailability": true }

PartNumberResponseListDTO

Paginated response carrying a list of part numbers

pagination

Pagination information

List of part numbers

Sample
{ "pagination": { "__typename": "Pagination" }, "partNumbers": [ { "__typename": "PartNumberResponseDTO" } ] }

Inputs

Overview

Scalars

Overview