FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: tns:bulkEntitlementPropertiesType

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
entitlementId  entitlementIdentifierType  0..1  Entitlement ID. See entitlementIdentifierType.
allowPortalLogin  boolean  0..1  True if the entitlement ID can be used to log in to the self-service portal; otherwise, false.
description  string  0..1  Description of the bulk entitlement.
state  StateType  0..1 

Required. One of the following:

  • DRAFT

  • DEPLOYED

  • INACTIVE

  • OBSOLETE
soldTo  accountIdentifierType  0..1  Optional. Account ID. Deprecated in favor of the channelPartners element. See accountIdentifierType.
soldToDisplayName  string  0..1  Brief name of the account.
shipToEmail  string  0..1  Email address of the account.
shipToAddress  string  0..1  Physical address of the account.
orderId  string  0..1  Order ID from CRM or ERP system.
orderLineNumber  string  0..1  Order line number from CRM or ERP system.
product  productIdentifierType  0..1  Product on the bulk entitlement. See productIdentifierType.
productDescription  string  0..1  Description of the product.
partNumber  partNumberIdentifierType  0..1  Part number mapped to the product on the bulk entitlement. See partNumberIdentifierType.
partNumberDescription  string  0..1  Description of the part number.
licenseModel  licenseModelIdentifierType  0..1  License model linked to the product on the bulk entitlement. 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.
licenseTechnology  licenseTechnologyIdentifierType  0..1  License technology. See licenseTechnologyIdentifierType.
startDateOption  StartDateOptionType  0..1 

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

  • DEFINE_NOW

  • 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 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  Duration defined for the bulk entitlement. See DurationType.
expirationDate  date  0..1  Expiration date of the license.
versionDate  date  0..1  Version date, if any defined for this bulk entitlement record.
versionDateAttributes  versionDateAttributesType  0..1  Version date option and duration defined in the bulk entitlement. See versionDateAttributesType.
numberOfCopies  integer  0..1  Number of copies of the bulk entitlement.
bulkEntitlementType  BulkEntitlementType  0..1 

Type of the bulk entitlement, where the value is one of the following:

  • UPGRADE

  • UPSELL

  • RENEWAL
createdUserId  string  0..1  ID of the user who created the bulk entitlement.
customAttributes  attributeDescriptorDataType  0..1  Custom attributes associated with the bulk entitlement. See attributeDescriptorDataType.
entitledProducts  entitledProductDataListType  0..1  See entitledProductDataListType.
channelPartners  channelPartnerDataListType  0..1  See channelPartnerDataListType.
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).

FlexNet Operations SOAP Web Services Guide

July 2025