Skip to content
Overview
Overview

Mutation to configure line item policies

Arguments

activationId
String!,non-nullrequired
entitlementId
String!,non-nullrequired
policy
PolicyInput!,non-nullrequired

Return type

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

Mutation to update line item properties

Arguments

entitlementId
String!,non-nullrequired
lineItemProperties
[LineItemPropertyInput!]!,non-nullrequired

Return type

[LineItemResponseItem]
activationId
errorMsg
status
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": "INVALID_ORDER", "parentActivationId": "Example String", "product": { "__typename": "UpdateProductInput" } } ] }
Response sample
{ "data": [ { "activationId": "Example String", "errorMsg": "Example String", "status": "Example String" } ] }

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

Mutation to create a line items within an entitlement.

Arguments

entitlementId
String!,non-nullrequired
lineItems
[LineItemInput!]!,non-nullrequired

Return type

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

Mutation to create maintenance line items

Arguments

entitlementId
String!,non-nullrequired
maintenanceLineItems

Return type

[LineItemResponseItem]
activationId
errorMsg
status
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" } ] }
Overview
Overview
Overview
Overview