FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: tns:entitlementLineItemPropertiesType

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
activationId  entitlementLineItemIdentifierType  0..1  Line item activation ID. See entitlementLineItemIdentifierType.
description  string  0..1  Description of the entitlement line item.
state  StateType  0..1 

One of the following:

  • TEST

  • DRAFT

  • DEPLOYED

  • INACTIVE

  • ON_HOLD

  • OBSOLETE
activatableItemType  ActivatableItemType  0..1  LINEITEM or WEBREGKEY
orderId  string  0..1  Order Id.
orderLineNumber  string  0..1  Order line number.
entitlementId  entitlementIdentifierType  0..1  See entitlementIdentifierType.
soldTo  accountIdentifierType  0..1  See accountIdentifierType.
soldToDisplayName  string  0..1  Account name of the account.
entitlementState  StateType  0..1 

One of the following:

  • TEST

  • DRAFT

  • DEPLOYED

  • INACTIVE

  • ON_HOLD

  • OBSOLETE 
entitlementDescription  string  0..1  Brief description of the entitlement.
allowPortalLogin  boolean  0..1  True if the entitlement ID can be used to log in to the self-service portal; otherwise, false.
shipToEmail  string  0..1  Email address of the account.
shipToAddress  string  0..1  Physical shipping address of the account.
parentBulkEntitlementId  entitlementIdentifierType  0..1  See entitlementIdentifierType.
bulkEntSoldTo  accountIdentifierType  0..1  See accountIdentifierType.
bulkEntSoldToDisplayName  string  0..1  Account name of the account.
product  productIdentifierType  0..1  See productIdentifierType.
productDescription  string  0..1  Brief description of the product.
partNumber  partNumberIdentifierType  0..1  See partNumberIdentifierType.
partNumberDescription  string  0..1  Brief description of the part number.
licenseTechnology  licenseTechnologyIdentifierType  0..1  Required. License technology of the product. See licenseTechnologyIdentifierType.
licenseModel  licenseModelIdentifierType  0..1  Required. 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.
lineItemSupportAction  LineItemType  0..1  Optional. UPGRADE, UPSELL, or RENEWAL. If this element is set, then the entitlement line item will be of this type.
parentLineItem  entitlementLineItemIdentifierType  0..1  See entitlementLineItemIdentifierType.
startDate  date  0..1  Start date of the line item.
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  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 either term or expirationDate.
expirationDate  date  0..1  Expiration date of the line item.
isAutoRenewal  boolean  0..1 

Controls whether a line item is automatically renewed. If set to True, the line item will be renewed according to the renewalInterval or renewalExpirationDate that is set.

  • True: Set this field to True to enable auto-renewal of this line item. On the day of expiration, the line item’s expiration date is extended to the new end date (renewalExpirationDate) or duration (renewalInterval) set for the line item.

  • False: Set this field to False to disable automatic renewal. (Default)
renewalInterval  DurationType  0..1  Set the duration after which the line item expires after it has been automatically renewed.
renewalExpirationDate  date  0..1  Expiration date of line item if its isAutoRenewal setting is set to True. Specify the date when the line item should expire after it has been automatically renewed.
versionDate  date  0..1  Version date of the line item.
versionDateAttributes  versionDateAttributesType  0..1  See versionDateAttributesType.
numberOfCopies  integer  0..1  Number of copies of the entitlement line item.
fulfilledAmount  integer  0..1  Number of copies fulfilled.
numberOfRemainingCopies  integer  0..1  Number of copies remaining.
isTrusted  boolean  0..1  Is the entitlement of trusted type?
customAttributes  attributeDescriptorDataType  0..1  See attributeDescriptorDataType.
entitledProducts  entitledProductDataListType  0..1  Deprecated. Use updatedEntitledProducts[] instead. See entitledProductDataListType.
channelPartners  channelPartnerDataListType  0..1  Optional. Only need to specify if modifying value. The account in the specified tier will be added or replaced. See Table channelPartnerDataListType.
maintenanceLineItems  maintenanceLineItemPropertiesType  0..* 

If set to 1, the following information is returned about maintenance line items linked to the returned line items:

  • activationId

  • maintenanceProduct

  • partNumber

  • orderId

  • orderLineNumber

  • startDate

  • expirationDate

  • isPermanent

  • state

See maintenanceLineItemPropertiesType.
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).
createdOnDateTime  dateTime  0..1  The date and time when the line item was created.
lastModifiedDateTime  dateTime  0..1  The date and time when the line item was last modified.
createdBy  string  0..1  The name of the user who created the entitlement line item.
lastModifiedBy  string  0..1  The name of the user who last modified the entitlement line item.
lineItemAttributes  attributeDescriptorDataType  0..1  See attributeDescriptorDataType.
transferredFromLineItem  string  0..1  The activation ID the line item was transferred from.
splitFromLineItem  string  0..1  The activation ID the line item was split from.
activatableItemOwners  ActivatableItemOwnersType  0..1   

FlexNet Operations SOAP Web Services Guide

July 2025