## configureLineItemPolicies **Type:** GraphQL mutations **Description:** Mutation to configure line item policies ### Arguments - activationId (String) - entitlementId (String) - policy (PolicyInput, Not Null): undefined - acpiGenerationIdLicense (Boolean): ACPI Generation ID License flag - cancelLicense (Boolean): Cancel License flag - extraActivations (Int): Activation Policy Attributes - rehosts (PolicyAttributeInput): Rehost Policy Attributes - allowedCount (Int): Represents the allowed count for the policy - policyTermDuration (Int): Represents the duration of the policy term - policyTermUnit (PolicyTermUnit, Not Null): Represents policy term unit - repairs (PolicyAttributeInput): Repair Policy Attributes - allowedCount (Int): Represents the allowed count for the policy - policyTermDuration (Int): Represents the duration of the policy term - policyTermUnit (PolicyTermUnit, Not Null): Represents policy term unit - returns (PolicyAttributeInput): Return Policy Attributes - allowedCount (Int): Represents the allowed count for the policy - policyTermDuration (Int): Represents the duration of the policy term - policyTermUnit (PolicyTermUnit, Not Null): Represents policy term unit - virtualLicense (Boolean): Virtual License flag ### Response **Type:** ActivationId **Description:** Represents the activation ID of a line item. #### Fields - activationId (String) --- ## configureLineItemProperties **Type:** GraphQL mutations **Description:** Mutation to update line item properties ### Arguments - entitlementId (String) - lineItemProperties (LineItemPropertyInput, Not Null): undefined - activationId (String): Activation ID of the line item for which attributes has to be updated. - attributes (AttributeUpdateInput): List of custom attributes related to the line item and license model - name (String): Name of the custom attribute to be updated - type (AttributeType, Not Null): undefined - value (String): Value of the custom attribute - deploy (Boolean): Whether the line item is to be deployed or not. This is used to update the deployment status of the line item - orderType (LineItemOrderType): Order type can have values like 'New_Order', 'Renewal_Order', 'Upgrade_Order' and Upsell_Order This is used to identify the type of order for the line item. - parentActivationId (String): Parent Line Item Activation ID. This is used to update the parent line item when the line item is a child of another line item. - product (UpdateProductInput): Product related to the line item - licenseModel (UpdateLicenseModelInput, Not Null): License Model Details - autoProvision (Boolean): Auto Provision flag - gracePeriodDays (String): Represents the grace period days - issuer (String): Name of the issuer - maxBorrowInterval (Int): Represents the max borrow interval - name (String): Name of the license model - notice (String): Represents the notice - overdraft (String): Represents the overdraft - serialNumber (String): Serial Number of the license model - vendorString (String): Represents the vendor string - partNumber (String): Part Number related to Product - productName (String): Product Name related to the line item - productVersion (String): Product Version related to the line item ### Response **Type:** LineItemResponseItem **Description:** Represents a single line item response #### Fields - activationId (String) - errorMsg (String) - status (String) --- ## createEntitlement **Type:** GraphQL mutations **Description:** Mutation to create a Simple Entitlement ### Arguments - input (CreateEntitlementInput, Not Null): undefined - 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). - CurrentOwner (Boolean): Whether this account is the current owner of the entitlement in the distribution chain - accountId (String): ID of the account - accountName (String): The name of the account - accountType (AccountType, Not 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, Not Null): Partner tier of the account owning the entitlement. Valid values are END_CUSTOMER and PARTNER_TIER_ONE - 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 - name (String): Name of the custom attribute - value (String): The value of the custom attribute. If the value is a date-type, use format yyyy/MM/dd - 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 - activatable (Boolean): Flag to indicate whether this line item is activatable - activationId (String): The activation ID associated with the line item. You may specify this while creation. If you choose to specify this then the autoGenerate flag should be set to false. If the activationID specified, matches with any existing entitlementID or activationID, then you will get an error - attributes (AttributeInput): List of custom attributes related to the line item - name (String): Name of the custom attribute - value (String): The value of the custom attribute. If the value is a date-type, use format yyyy/MM/dd - autoDeploy (Boolean): Whether the Line item should be auto-deployed - autoGenerate (Boolean): Whether the activation ID should be auto-generated - expiryDate (String): End date of the line item in YYYY-MM-DD format - orderType (LineItemOrderType): Type of order for the line item. The default is NEW_ORDER - permanent (Boolean): Whether this line item is permanent. A permanent line item has no expiration date. - product (ProductInput): List of products entitled by this line item - licenseModel (LicenseModelInput): License model associated with the product - productName (String): Name of the product - productVersion (String): Version of the product - quantity (Int): Number of copies for the entitlement - quantityPerCopy (Int): Quantity per copy. Minimum value is 1 - startDate (String): Start date of the line item in YYYY-MM-DD format - shipToAddress (String): Address of the ship-to contact - shipToEmail (String): Email address of the ship-to contact ### Response **Type:** String --- ## createLineItems **Type:** GraphQL mutations **Description:** Mutation to create a line items within an entitlement. ### Arguments - entitlementId (String) - lineItems (LineItemInput, Not Null): undefined - activatable (Boolean): Flag to indicate whether this line item is activatable - activationId (String): The activation ID associated with the line item. You may specify this while creation. If you choose to specify this then the autoGenerate flag should be set to false. If the activationID specified, matches with any existing entitlementID or activationID, then you will get an error - attributes (AttributeInput): List of custom attributes related to the line item - name (String): Name of the custom attribute - value (String): The value of the custom attribute. If the value is a date-type, use format yyyy/MM/dd - autoDeploy (Boolean): Whether the Line item should be auto-deployed - autoGenerate (Boolean): Whether the activation ID should be auto-generated - expiryDate (String): End date of the line item in YYYY-MM-DD format - orderType (LineItemOrderType): Type of order for the line item. The default is NEW_ORDER - permanent (Boolean): Whether this line item is permanent. A permanent line item has no expiration date. - product (ProductInput): List of products entitled by this line item - licenseModel (LicenseModelInput): License model associated with the product - issuer (String): specify who is issuing the license - licenseModelName (String): specify a name that uniquely identifies this license model - notice (String): This field is usually set at entitlement time and includes customer name and purchase order - serialNumber (String): specify the serial number of the license - vendorString (String): Unique value assigned by each publisher to each license - productName (String): Name of the product - productVersion (String): Version of the product - quantity (Int): Number of copies for the entitlement - quantityPerCopy (Int): Quantity per copy. Minimum value is 1 - startDate (String): Start date of the line item in YYYY-MM-DD format ### Response **Type:** ActivationId **Description:** Represents the activation ID of a line item. #### Fields - activationId (String) --- ## createMaintenanceLineItems **Type:** GraphQL mutations **Description:** Mutation to create maintenance line items ### Arguments - entitlementId (String) - maintenanceLineItems (MaintenanceLineItemInput, Not Null): undefined - activationId (String): Activation ID of the maintenance line item. If you specify the activation ID, then it must be unique across all entitlements and maintenance line items. If you specify the activation ID here, then the autoGenerate flag must be set to false - attributes (AttributeInput): List of custom attributes related to the maintenance line item - name (String): Name of the custom attribute - value (String): The value of the custom attribute. If the value is a date-type, use format yyyy/MM/dd - autoDeploy (Boolean): Whether the maintenance Line item should be auto-deployed - autoGenerate (Boolean): Whether the activation ID should be auto-generated - expiryDate (String): End date of the maintenance line item in YYYY-MM-DD format - maintenanceProduct (MaintenanceProductInput): List of products entitled by this maintenance line item - maintenanceProductName (String): Name of the maintenance product - maintenanceProductVersion (String): Version of the maintenance product - partNumber (String): Part number associated with maintenance product - permanent (Boolean): Whether this maintenance line item is permanent. A permanent maintenance line item has no expiration date. - startDate (String): Start date of the maintenance line item in YYYY-MM-DD format ### Response **Type:** LineItemResponseItem **Description:** Represents a single line item response #### Fields - activationId (String) - errorMsg (String) - status (String)