Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Account

Represents an Account entity

accountId
String!,non-null

Represents the unique identifier of the account

accountName
String

Name of the account

accountType
String

Represents the type of account

contactEmail
String

Email address of the contact associated with the account. This field is applicable only when the Account is linked through Entitlement. Returns null if no relevant parent association exists

currentOwner
Boolean

Flag indicating if this account is the current owner of the entitlement. This field is applicable only when the Account is linked through Entitlement. Returns null if no relevant parent association exists

partnerTierName
String

Represents the partner tier associated with the account. This field is applicable only when the Account is linked through Entitlement. Returns null if no relevant parent association exists

address1
String

Address line 1 of the account

address2
String

Address line 2 of the account

attributes

Represents the custom attributes associated with the account

city
String

City of the account

country
String

Country of the account

description
String

Description of the account

region
String

Region of the account

state
String

State of the account

visible
Boolean

Visibility of the account

zipcode
String

Zip code of the account

Sample
{ "accountId": "Example String", "accountName": "Example String", "accountType": "Example String", "contactEmail": "Example String", "currentOwner": true, "partnerTierName": "Example String", "address1": "Example String", "address2": "Example String", "attributes": [ { "__typename": "Attribute" } ], "city": "Example String", "country": "Example String", "description": "Example String", "region": "Example String", "state": "Example String", "visible": true, "zipcode": "Example String" }

AccountCreationResponse

Response returned after attempting to create an account

message
String

Account creation success message

status
String

Status of the account creation

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

ActivationId

Represents the activation ID of a line item

activationId
String
Sample
{ "activationId": "Example String" }

Attribute

Represents a custom attribute associated with an entity

name
String!,non-null

Name of the custom attribute

value
JSON!,non-null

Respective value of the custom attribute

Sample
{ "name": "Example String", "value": "Example Custom Scalar" }

CreateFeatureResponse

Response for feature creation

featureId
String

ID of the created feature (featureName)

message
String

Success or error message

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

Inputs

Overview

Scalars

Overview