FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: tns:searchEntitlementDataType

Description

Specify the elements needed to construct your query.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
entitlementId  SimpleQueryType  0..1 

Optional. An entitlementId element contains:

  • value—a string to match part or all of the entitlement ID.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS
entDescription  SimpleQueryType  0..1 

Optional. An entDescription element contains:

  • value—a string to match part or all of the product name.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

productName  SimpleQueryType  0..1 

Optional. A productName element contains:

  • value—a string to match part or all of the product name.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

productVersion  SimpleQueryType  0..1 

Optional. A productVersion element contains:

  • value—a string to match part or all of the product version.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

productType  ProductType  0..1 

Optional. A productType element contains one of the following:

  • LICENSED_PRODUCT

  • SUITE

  • MAINTENANCE
partNumber  SimpleQueryType  0..1 

Optional. A partNumber element contains:

  • value—a string to match part or all of the part number.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

isBulk  boolean  0..1  Optional. Set to true if the entitlement is a bulk entitlement; false if the entitlement is a simple entitlement. If not specified, isBulk defaults to false.
soldTo  SimpleQueryType  0..1 

Optional. A soldTo element contains:

  • value—a string to match part or all of the sold-to account.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

shipToEmail  SimpleQueryType  0..1 

Optional. A shipToEmail element contains:

  • value—a string to match part or all of the email address.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

contactEmail  SimpleQueryType  0..1   
shipToAddress  SimpleQueryType  0..1 

Optional. A shipToAddress element contains:

  • value—a string to match part or all of the postal address.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

emailTemplateVariation  SimpleQueryType  0..1 

Optional. An emailTemplateVariation element contains:

  • value—a string to match part or all of the email template variation name.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

startDate  DateQueryType  0..1 

Optional. A startDate element contains:

  • value—a date value to compare to the start date value.

  • searchType—which is one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON
isPermanent  boolean  0..1 

Optional. 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.
expirationDate  DateQueryType  0..1 

Optional. A expirationDate element contains:

  • value—a date value to compare to the expiration date value.

  • searchType—which is one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON

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  DateQueryType  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.
createdOn  DateQueryType  0..1 

Optional. A createdOn element contains:

  • value—a date value to compare to the creation date value.

  • searchType—which is one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON

versionDate  DateQueryType  0..1 

Optional. A versionDate element contains:

  • value—a date value to compare to the version date value.

  • searchType—which is one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON

lastModifiedDate  DateQueryType  0..1 

Optional. A lastModifiedDate element contains:

  • value—a date value to compare to the last modified date value.

  • searchType—which is one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON 
description  SimpleQueryType  0..1 

Optional. A description element contains:

  • value—a string to match part or all of the description.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

state  StateQueryType  0..1  Optional. See StateQueryType.
licenseTechnology  SimpleQueryType  0..1 

Optional. A licenseTechnology element contains:

  • value—a string to match part or all of the license technology.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

createdUserId  SimpleQueryType  0..1 

Optional. A createdUserId element contains:

  • value—a string to match part or all of the user name of the user who created the entitlement.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

accountUnitName  PartnerTierQueryType  0..1  Optional. See PartnerTierQueryType.
currentOwnerName  SimpleQueryType  0..1 

Optional. A currentOwnerName element contains:

  • value—a string to match part or all of the user name of the user who created the entitlement.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

maintStartDate  DateQueryType  0..1 

Optional. A maintStartDate element contains:

  • value—a date value to compare to the maintenance start date value.

  • searchType—which is one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON

Searches for entitlements that have regular line items that are linked with maintenance line items with a start date that matches the value and searchType specified here.

Note that all of the line items and maintenance line items on the matching entitlements are in the response, not just the ones directly related to the maintenance query parameter. In addition, the entitlements in the response may or may not themselves contain the matching maintenance line items.
maintIsPermanent  boolean  0..1 

Optional. Set to true if the maintenance is permanent; false if the maintenance expires.

Searches for entitlements that have regular line items that are linked with maintenance line items that are permanent (true) or expiring (false).

Note that all of the line items and maintenance line items on the matching entitlements are in the response, not just the ones directly related to the maintenance query parameter. In addition, the entitlements in the response may or may not themselves contain the matching maintenance line items.
maintExpirationDate  DateQueryType  0..1 

Optional. A maintExpirationDate element contains:

  • value—a date value to compare to the maintenance expiration date value.

  • searchType—which is one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON.

Searches for entitlements that have regular line items that are linked with maintenance line items with a expiration date that matches the value and searchType specified here.

Note that all of the line items and maintenance line items on the matching entitlements are in the response, not just the ones directly related to the maintenance query parameter. In addition, the entitlements in the response may or may not themselves contain the matching maintenance line items.
entitlementAttributes  entCustomAttributesQueryListType  0..1  See entCustomAttributesQueryListType.

FlexNet Operations SOAP Web Services Guide

July 2025