Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

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

FeatureBundleListResponse

Paginated response for feature bundles

List of feature bundles

pagination

Pagination information

Sample
{ "featureBundles": [ { "__typename": "FeatureBundleResponseDTO" } ], "pagination": { "__typename": "Pagination" } }

FeatureBundleResponseDTO

Feature bundle response object with summary information

creationDate
String

Creation date of the feature bundle

description
String

Description of the feature bundle

featureBundleName
String

Name of the feature bundle

List of features in the bundle

lastModifiedDate
String

Last modification date of the feature bundle

state
String

Current state of the feature bundle

Sample
{ "creationDate": "Example String", "description": "Example String", "featureBundleName": "Example String", "features": [ { "__typename": "FeatureBundleFeatureResponseDTO" } ], "lastModifiedDate": "Example String", "state": "Example String" }

FeaturesResponseDTO

Response object representing a feature with full details

createdOn
String

Creation date of the feature

description
String

Description of the feature

lastModifiedOn
String

Last modification date of the feature

name
String

Name of the feature

overrideProperties

Override properties for the feature

state
String

Current state of the feature (DRAFT, DEPLOYED, OBSOLETE, INACTIVE)

version
String

Version of the feature

versionFormat
String

Version format (FIXED or DATEBASED)

Sample
{ "createdOn": "Example String", "description": "Example String", "lastModifiedOn": "Example String", "name": "Example String", "overrideProperties": { "__typename": "OverrideProperties" }, "state": "Example String", "version": "Example String", "versionFormat": "Example String" }

Inputs

Overview

Scalars

Overview