FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: tns:updateBulkEntitlementDataType

Description

The entitlementIdentifier always needs to be specified, along with the new values of the elements to be updated.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
entitlementIdentifier  entitlementIdentifierType  1..1  Required. See entitlementIdentifierType.
entitlementId  idType  0..1  Only need to specify if modifying value. See idType.
soldTo  string  0..1  Optional. Only need to specify if modifying the value of the Distributor account. Account that has the right to fulfill or distribute activation IDs from this entitlement. Deprecated in favor of the channelPartners element.
product  productIdentifierType  0..1  Only need to specify if modifying value. See productIdentifierType.
partNumber  partNumberIdentifierType  0..1  Only need to specify if modifying value. See partNumberIdentifierType.
licenseModel  licenseModelIdentifierType  0..1  Only need to specify if modifying value. See licenseModelIdentifierType.
alternateLicenseModel1  licenseModelIdentifierType  0..1  Optional. Up to three license models are supported on a FlexNet license technology line item, one each of a certificate-based, trusted storage, and embedded on a single line item. See licenseModelIdentifierType.
alternateLicenseModel2  licenseModelIdentifierType  0..1  Optional. Up to three license models are supported on a FlexNet license technology line item, one each of a certificate-based, trusted storage, and embedded on a single line item. See licenseModelIdentifierType.
licenseModelAttributes  attributeDescriptorDataType  0..1 

Any entitlement-time attributes must be set before deployment of the entitlement.

If a request or response contains multiple license models, the accompanying license model attributes are a union of the attributes in all the license models. Therefore, if any license attributes are shared among the license models, they all must be assigned the same value.

See attributeDescriptorDataType.
FNPTimeZoneValue  string  0..1  The time zone value is given as the contents of the name column of the time zone entry in the PROD_FNP_TIMEZONE table (not the time zone string that will be written into the license file).
policyAttributes  policyAttributesListType  0..1  Only need to specify if modifying values. See policyAttributesListType.
shipToEmail  string  0..1  Only need to specify if modifying value. Email address for a contact in the sold-to account where license certificates are shipped.
shipToAddress  string  0..1  Only need to specify if modifying value. Postal address for the sold-to account.
orderId  string  0..1  Only need to specify if modifying value. Order ID from CRM or ERP system.
orderLineNumber  string  0..1  Only need to specify if modifying value. Order line number from CRM or ERP system.
startDateOption  StartDateOptionType  0..1 

At what point the start date is defined, where this is of the following values:

  • DEFINE_AT_FIRST_ACTIVATION

  • DEFINE_AT_EACH_ACTIVATION

  • DEFINE_ACTDATE_AT_FIRST_ACTIVATION

  • DEFINE_ACTDATE_AT_EACH_ACTIVATION
isPermanent  boolean  0..1 

Only need to specify if modifying value. Whether the entitlement, and therefore, license activated from it, is permanent. If true, the entitlement line item, and the licenses activated from it, never expire. If true, do not set term or expirationDate. If false, set term or expirationDate, but not both.

  • If isPermanent is set to false, a query response will contain only expiring lineitem details.

  • If isPermanent is set to true, a query response will contain only permanent lineitem details.

  • If isPermanent is null (i.e. blank or not included in the query), a query response will contain both permanent and expiring lineitem details.
term  DurationType  0..1  Only need to specify if modifying value. The length of time after the start date that the entitlement, and the licenses activated from it, are valid. See DurationType. If isPermanent is true, do not set term or expirationDate. If isPermanent is false, set term or expirationDate, but not both.
expirationDate  date  0..1  Only need to specify if modifying value. The date that the entitlement line item, and the licenses activated from it, expire. If isPermanent is true, do not set term or expirationDate. If isPermanent is false, set term or expirationDate, but not both.
versionDate  date  0..1  Only need to specify if modifying value. If any of the features in the product use date-based versions, and you want to set the version date when the line item is created, set versionDate and set versionDateAttributes to DEFINE_NOW. In a license, this date is converted into the Version Date Format that is specified in the system configuration.
versionDateAttributes  versionDateAttributesType  0..1  Only need to specify if modifying value. If any of the features in the product use date-based versions, set versionDateAttributes to reflect when and how you want to specify the version date. See versionDateAttributesType.
numberOfCopies  integer  0..1  Only need to specify if modifying value. Number of copies of the product entitled by each web register key on this entitlement.
description  string  0..1  Only need to specify if modifying value. Describe what makes this bulk entitlement unique.
autoDeploy  boolean  0..1  Whether to deploy this entitlement as soon as it is updated.
updatedEntitledProducts  updateEntitledProductDataListType  0..1  See updateEntitledProductDataListType.
channelPartners  channelPartnerDataListType  0..1  Optional. Only need to specify if modifying value. The account in the specified tier will be added or replaced. See channelPartnerDataListType.
allowPortalLogin  boolean  0..1  True if the entitlement ID can be used to log in to the self-service portal; otherwise, false.

FlexNet Operations SOAP Web Services Guide

July 2025