FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: tns:searchBulkEntitlementDataType

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
description  SimpleQueryType  0..1  Brief description of the bulk entitlement.
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

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

Deprecated in favor of the channelPartners element.
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

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

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—one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON

createdOn  DateQueryType  0..1 

Optional. A createdOn element contains:

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

  • searchType—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—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—one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON

state  StateQueryType  0..1 

Optional. A state element contains:

  • value—a StateType value of TEST, DRAFT, DEPLOYED, INACTIVE, OBSOLETE to match part or all of the state value.

  • searchType—one of the following simpleSearchType values:

  • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

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

customAttributes  customAttributesQueryListType  0..1  Any custom attributes associated with the bulk entitlement. See customAttributesQueryListType.
allowPortalLogin  boolean  0..1  True if the entitlement ID can be used to log in to the self-service portal; otherwise, false.
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

FlexNet Operations SOAP Web Services Guide

July 2025