Skip to content
GraphQL API Reference
/
/
createEntitlement

GraphQL Overview

Download GraphQL schema
fno-schema.gql

Queries

Overview

Mutations

Overview

configureLineItemPolicies

(...args)
ActivationId

Configure line item policies

Arguments

activationId
String!,non-nullrequired

Activation ID of the line item

entitlementId
String!,non-nullrequired

Entitlement ID containing the line item

policy
PolicyInput!,non-nullrequired

Policy configuration details

Return type

ActivationId
activationId
String
Mutation sample
mutation configureLineItemPolicies(
  $activationId: String!
  $entitlementId: String!
  $policy: PolicyInput!
) {
  configureLineItemPolicies(
    activationId: $activationId
    entitlementId: $entitlementId
    policy: $policy
  ) {
    activationId 
  }
}
Variables
{
  "activationId": "Example String",
  "entitlementId": "Example String",
  "policy": {
    "acpiGenerationIdLicense": true,
    "cancelLicense": true,
    "extraActivations": 40,
    "rehosts": {
      "__typename": "PolicyAttributeInput"
    },
    "repairs": {
      "__typename": "PolicyAttributeInput"
    },
    "returns": {
      "__typename": "PolicyAttributeInput"
    },
    "virtualLicense": true
  }
}
Response sample
{
  "data": {
    "activationId": "Example String"
  }
}

configureLineItemProperties

(...args)
[LineItemResponseItem]

Update attributes of line items for an entitlement

Arguments

entitlementId
String!,non-nullrequired

Entitlement ID containing the line items

lineItemProperties
[LineItemPropertyInput!]!,non-nullrequired

List of line item properties to be updated

Return type

[LineItemResponseItem]
activationId
String
errorMsg
String
status
String
Mutation sample
mutation configureLineItemProperties($entitlementId: String!, $lineItemProperties: [LineItemPropertyInput!]!) {
  configureLineItemProperties(entitlementId: $entitlementId, lineItemProperties: $lineItemProperties) {
    activationId 
    errorMsg 
    status 
  }
}
Variables
{
  "entitlementId": "Example String",
  "lineItemProperties": [
    {
      "activationId": "Example String",
      "attributes": [
        {
          "__typename": "AttributeUpdateInput"
        }
      ],
      "deploy": true,
      "orderType": "Example String",
      "parentActivationId": "Example String",
      "product": {
        "__typename": "UpdateProductInput"
      }
    }
  ]
}
Response sample
{
  "data": [
    {
      "activationId": "Example String",
      "errorMsg": "Example String",
      "status": "Example String"
    }
  ]
}

createEntitlement

(input)
String

Create a simple Entitlement

Arguments

input
CreateEntitlementInput!,non-nullrequired

Return type

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Mutation sample
mutation createEntitlement($input: CreateEntitlementInput!) {
  createEntitlement(input: $input) 
}
Variables
{
  "input": {
    "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"
  }
}
Response sample
{
  "data": "Example String"
}

createLineItems

(...args)
LineItemGraphQLResponse

Create a line item

Arguments

entitlementId
String!,non-nullrequired

Entitlement ID for which line items are to be created

lineItems
[LineItemInput!]!,non-nullrequired

List of line items to be created

Return type

LineItemGraphQLResponse
response
[LineItemResultEntry]

List of line item creation results

Mutation sample
mutation createLineItems($entitlementId: String!, $lineItems: [LineItemInput!]!) {
  createLineItems(entitlementId: $entitlementId, lineItems: $lineItems) {
    response {
      __typename
      # ...LineItemResultEntryFragment
    }
  }
}
Variables
{
  "entitlementId": "Example String",
  "lineItems": [
    {
      "activatable": true,
      "activationId": "Example String",
      "attributes": [
        {
          "__typename": "AttributeInput"
        }
      ],
      "autoDeploy": true,
      "autoGenerate": true,
      "expiryDate": "Example String",
      "orderType": "Example String",
      "partNumber": "Example String",
      "permanent": true,
      "product": [
        {
          "__typename": "ProductInput"
        }
      ],
      "quantity": 40,
      "quantityPerCopy": 40,
      "startDate": "Example String"
    }
  ]
}
Response sample
{
  "data": {
    "response": [
      {
        "__typename": "LineItemResultEntry"
      }
    ]
  }
}

createMaintenanceLineItems

(...args)
[LineItemResponseItem]

Create maintenance line items

Arguments

entitlementId
String!,non-nullrequired

Entitlement ID for which maintenance line items are to be created

maintenanceLineItems
[MaintenanceLineItemInput!]!,non-nullrequired

List of maintenance line items to be created

Return type

[LineItemResponseItem]
activationId
String
errorMsg
String
status
String
Mutation sample
mutation createMaintenanceLineItems($entitlementId: String!, $maintenanceLineItems: [MaintenanceLineItemInput!]!) {
  createMaintenanceLineItems(entitlementId: $entitlementId, maintenanceLineItems: $maintenanceLineItems) {
    activationId 
    errorMsg 
    status 
  }
}
Variables
{
  "entitlementId": "Example String",
  "maintenanceLineItems": [
    {
      "activationId": "Example String",
      "attributes": [
        {
          "__typename": "AttributeInput"
        }
      ],
      "autoDeploy": true,
      "autoGenerate": true,
      "expiryDate": "Example String",
      "maintenanceProduct": {
        "__typename": "MaintenanceProductInput"
      },
      "permanent": true,
      "startDate": "Example String"
    }
  ]
}
Response sample
{
  "data": [
    {
      "activationId": "Example String",
      "errorMsg": "Example String",
      "status": "Example String"
    }
  ]
}

linkMaintenanceLineItem

(input)
Response

Link Maintenance Line Item

Arguments

input
LinkMaintenanceLineItemInput!,non-nullrequired

Link maintenance line item input containing line item and maintenance line item activation IDs

Return type

Response
message
String

Response message

status
String

Response status

Mutation sample
mutation linkMaintenanceLineItem($input: LinkMaintenanceLineItemInput!) {
  linkMaintenanceLineItem(input: $input) {
    message 
    status 
  }
}
Variables
{
  "input": {
    "lineItem": {
      "__typename": "LinkLineItemInput"
    },
    "maintenanceLineItem": {
      "__typename": "MaintenanceLinkLineItemInput"
    }
  }
}
Response sample
{
  "data": {
    "message": "Example String",
    "status": "Example String"
  }
}

createFeature

(input)
CreateFeatureResponse

Create a new feature.

Arguments

input
CreateFeatureInput!,non-nullrequired

Input data for creating a feature

Return type

CreateFeatureResponse
featureId
String

ID of the created feature (featureName)

message
String

Success or error message

Mutation sample
mutation createFeature($input: CreateFeatureInput!) {
  createFeature(input: $input) {
    featureId 
    message 
  }
}
Variables
{
  "input": {
    "aggregationType": "Example String",
    "autoDeploy": true,
    "description": "Example String",
    "featureName": "Example String",
    "featureOverrideParams": {
      "__typename": "FeatureOverrideParamsInput"
    },
    "maxVersion": "Example String",
    "version": "Example String",
    "versionFormat": "Example String"
  }
}
Response sample
{
  "data": {
    "featureId": "Example String",
    "message": "Example String"
  }
}

createFeatureBundle

(input)
FeatureBundleCreateResponse

Create a new feature bundle.

Arguments

input
CreateFeatureBundleInput!,non-nullrequired

Input data for creating a feature bundle

Return type

FeatureBundleCreateResponse
featureBundle
String

Name of the created feature bundle

message
String

Success or error message

Mutation sample
mutation createFeatureBundle($input: CreateFeatureBundleInput!) {
  createFeatureBundle(input: $input) {
    featureBundle 
    message 
  }
}
Variables
{
  "input": {
    "autoDeploy": true,
    "description": "Example String",
    "featureBundleName": "Example String",
    "featureList": [
      {
        "__typename": "FeatureBundleFeatureInput"
      }
    ]
  }
}
Response sample
{
  "data": {
    "featureBundle": "Example String",
    "message": "Example String"
  }
}

Objects

Overview

Inputs

Overview

Scalars

Overview