Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

CreateSuiteResponse

Response for suite creation.

message
String

Success or error message

suiteName
String

Name of the created suite

Sample
{ "message": "Example String", "suiteName": "Example String" }

Entitlement

Represents the entitlement entity

createdOn
String

Represents the date and time when the entitlement was created

description
String

Human readable description of the entitlement

entitlementId
String!,non-null

Represents a high-level entitlement entity

shipToAddress
String

Represents the shipping address associated with the entitlement

shipToEmail
String

Email address associated with shipment contact

status
String

status could be one of the following values: ACTIVE, INACTIVE, DRAFT, DEPLOYED, OBSOLETE

updatedOn
String

Represents the date and time when the entitlement was last updated

Sample
{ "createdOn": "Example String", "description": "Example String", "entitlementId": "Example String", "shipToAddress": "Example String", "shipToEmail": "Example String", "status": "Example String", "updatedOn": "Example String" }

EntitlementDetail

Entitlement details including associated accounts and line items

accounts
[Account!]!,non-null

Represents the accounts associated with the entitlement

attributes

Represents the custom attributes associated with the entitlement

createdOn
String

Represents the date and time when the entitlement was created

description
String

Human readable description of the entitlement

entitlementId
String!,non-null

Unique identifier of the entitlement

lineItems

List of line items associated with the entitlement

shipToAddress
String

Represents the shipping address associated with the entitlement

shipToEmail
String

Email address associated with shipment contact

status
String

status could be one of the following values: ACTIVE, INACTIVE, DRAFT, DEPLOYED, OBSOLETE

updatedOn
String

Represents the date and time when the entitlement was last updated

Sample
{ "accounts": [ { "__typename": "Account" } ], "attributes": [ { "__typename": "Attribute" } ], "createdOn": "Example String", "description": "Example String", "entitlementId": "Example String", "lineItems": [ { "__typename": "LineItemDetail" } ], "shipToAddress": "Example String", "shipToEmail": "Example String", "status": "Example String", "updatedOn": "Example String" }

EntitlementListResponse

Paginated response carrying a list of entitlements

entitlements

List of entitlement entities

limit
Int

Represents limit per page for pagination

page
Int

Represents page for pagination

Sample
{ "entitlements": [ { "__typename": "Entitlement" } ], "limit": 40, "page": 40 }

Feature

Represents a feature entity in a product context

count
Int

Feature count

name
String

Unique feature name

version
String

Version identifier of the feature

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

FeatureBundle

Represents a feature bundle entity in a product context

count
Int

Count for the feature bundle

name
String

Unique feature bundle name

Sample
{ "count": 40, "name": "Example String" }
Referenced in

FeatureBundleCreateResponse

Response for feature bundle creation

featureBundle
String

Name of the created feature bundle

message
String

Success or error message

Sample
{ "featureBundle": "Example String", "message": "Example String" }

FeatureBundleFeatureResponse

Feature within a feature bundle

featureName
String

Name to uniquely identify the feature. Example: "MyFeature"

quantity
Int

Quantity of the feature (minimum value is 1). Example: 1

state
String

State of the feature. Valid values: draft, deployed, obsolete, inactive.

version
String

Version of the feature. Example: "1.0"

Sample
{ "featureName": "Example String", "quantity": 40, "state": "Example String", "version": "Example String" }

FeatureBundleFeatureResponseDTO

Feature within a feature bundle (response for getFeatureBundles query)

name
String

Feature name

quantity
Int

Feature quantity in the bundle

state
String

State of the feature

version
String

Feature version

Sample
{ "name": "Example String", "quantity": 40, "state": "Example String", "version": "Example String" }

FeatureBundleGet

Feature bundle details with full information

description
String

Description of the feature bundle

featureBundleName
String

Name of the feature bundle

List of features in the bundle

state
String

Current state of the feature bundle

Sample
{ "description": "Example String", "featureBundleName": "Example String", "featureList": [ { "__typename": "FeatureBundleFeatureResponse" } ], "state": "Example String" }

FeatureBundleGetResponse

Response containing a single feature bundle

featureBundle

The feature bundle details

Sample
{ "featureBundle": { "__typename": "FeatureBundleGet" } }

Inputs

Overview

Scalars

Overview