Skip to content
/Inputs

GraphQL Overview

Download GraphQL schema
CombinedGraphql.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Enums

Overview

Inputs

Overview

AccountInput

Represents an Account

CurrentOwner
Boolean

Whether this account is the current owner of the entitlement in the distribution chain

accountId
String!,non-null

ID of the account

accountName
String

The name of the account

accountType
AccountType!,non-null

Type of the account. Valid types are PUBLISHER, CUSTOMER, CHANNEL_PARTNER, SELF_REGISTERED, UNKNOWN

contactEmail
String

Email address of the Contact in the account

partnerTierName
PartnerTier!,non-null

Partner tier of the account owning the entitlement. Valid values are END_CUSTOMER and PARTNER_TIER_ONE

Sample
{
  "CurrentOwner": true,
  "accountId": "Example String",
  "accountName": "Example String",
  "accountType": "CHANNEL_PARTNER",
  "contactEmail": "Example String",
  "partnerTierName": "END_CUSTOMER"
}
Referenced in
CreateEntitlementInput.accounts

AttributeInput

Represents a Custom Attribute

name
String!,non-null

Name of the custom attribute

value
String!,non-null

The value of the custom attribute. If the value is a date-type, use format yyyy/MM/dd

Sample
{
  "name": "Example String",
  "value": "Example String"
}
Referenced in
CreateEntitlementInput.attributes
LineItemInput.attributes
MaintenanceLineItemInput.attributes

AttributeUpdateInput

Represents an update to a custom attribute

name
String!,non-null

Name of the custom attribute to be updated

type
AttributeType!,non-null
value
String!,non-null

Value of the custom attribute

Sample
{
  "name": "Example String",
  "type": "LICENSE_MODEL",
  "value": "Example String"
}
Referenced in
LineItemPropertyInput.attributes

CreateEntitlementInput

Input to create an entitlement

accounts
[AccountInput]

List of accounts associated with the entitlement. If account is not provided, the entitlement will be associated with UNKNOWN_ORG_UNIT(default account).

allowPortalLogin
Boolean

Whether the customer can use the entitlement ID to log into the End-User Portal after the entitlement is deployed

attributes
[AttributeInput]

List of entitlement custom attributes. Note that mandatory custom attributes must be included in this list

autoDeploy
Boolean

Flag to indicate if the entitlement should be auto-deployed

autoGenerate
Boolean

Whether the entitlement ID is to be auto-generated.

description
String

Description of the entitlement

emailTemplateVariation
String

Name of the email template to be used for entitlement related emails

entitlementId
String

The ID of the entitlement. This is to be specified if you want to generate the entitlement ID yourselves. This means that the autoGenerate flag below is set to false. If the ID matches that of an existing entitlement or line item, then operation will fail.

lineItems
[LineItemInput]

List of line items contained in the entitlement

shipToAddress
String

Address of the ship-to contact

shipToEmail
String

Email address of the ship-to contact

Sample
{
  "accounts": [
    {
      "__typename": "AccountInput"
    }
  ],
  "allowPortalLogin": true,
  "attributes": [
    {
      "__typename": "AttributeInput"
    }
  ],
  "autoDeploy": true,
  "autoGenerate": true,
  "description": "Example String",
  "emailTemplateVariation": "Example String",
  "entitlementId": "Example String",
  "lineItems": [
    {
      "__typename": "LineItemInput"
    }
  ],
  "shipToAddress": "Example String",
  "shipToEmail": "Example String"
}

CreateLineItemInput

Input to create a new line item

lineItems
[LineItemInput!]!,non-null

List of line item input objects

Sample
{
  "lineItems": [
    {
      "__typename": "LineItemInput"
    }
  ]
}

Scalars

Overview