FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: tns:bulkEntitlementDataType

Derived By

Extending createBulkEntitlementDataType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
entitlementId  idType  1..1  Required. See idType.
soldTo  string  0..1 

Optional. Account that has the right to fulfill or distribute activation IDs from this entitlement. If soldTo is specified, that account is set in the Distributor tier. The account is not set as the current owner of the entitlement.

Deprecated in favor of the channelPartners element.
product  productIdentifierType  0..1 

Optional element supported for backwards compatibility.

  • A product must be uniquely identified by product identifier, part number, or a combination of part number and license model. Specifying a product element provides the default quantity of 1 for the single product on a line item.

  • Only products and suites are currently supported, not maintenance.

See productIdentifierType.
partNumber  partNumberIdentifierType  0..1  Optional. A part number can be used to identify a product or a unique combination of a product and license model. Only products and suites are currently supported, not maintenance. See partNumberIdentifierType.
licenseModel  licenseModelIdentifierType  0..1  Optional, but before the entitlement is deployed, a license model must be uniquely identified by a license model identifier, part number, or product. 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  Required if any policies must be set at entitlement time. See policyAttributesListType.
shipToEmail  string  0..1  Optional. Email address for a contact in the sold-to account where license certificates are shipped.
shipToAddress  string  0..1  Optional. Postal address for the sold-to account.
orderId  string  0..1  Optional. Order ID from CRM or ERP system.
orderLineNumber  string  0..1  Optional. 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 

Whether the entitlement, and therefore, the 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  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  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  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  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.
description  string  0..1  Optional. Describe what makes this bulk entitlement unique.
numberOfCopies  integer  0..1  Optional. Number of copies of the product entitled by each web register key on this entitlement. If not specified, it will be 1.
bulkEntitlementType  BulkEntitlementType  0..1 

One of the following:

  • UPGRADE

  • UPSELL

  • RENEWAL
autoDeploy  boolean  0..1  Whether to deploy this entitlement as soon as it is created.
entitledProducts  entitledProductDataListType  0..1  See entitledProductDataListType.
channelPartners  channelPartnerDataListType  0..1  Optional. Either soldTo or channelPartners must be specified. A bulk entitlement cannot be deployed without an account specified in the Distributor tier (bo.constants.partnertiernames.tier1). Other partner tiers (except End Customer) can be specified also. See channelPartnerDataListType.
allowPortalLogin  boolean  0..1  True if the entitlement ID can be used to log in to the self-service portal; otherwise, false.
state  StateType  0..1 

One of the following:

  • TEST

  • DRAFT

  • DEPLOYED

  • INACTIVE

  • OBSOLETE 
createdUserId  string  0..1  User name of the user who created this entitlement.
licenseTechnology  licenseTechnologyIdentifierType  0..1  License technology of the product. See licenseTechnologyIdentifierType.

FlexNet Operations SOAP Web Services Guide

July 2025