Complex Type: searchActivatableItemDataType

Optional. A parentBulkEntitlementId element contains:

• value—a string to match part or all of the entitlement ID of the parent bulk entitlement of a simple entitlement created when a web register key is redeemed.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Optional. An entitlementId element contains:

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

• searchType—one of the following simpleSearchType values.

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Use to perform a mass entitlement search using the getActivatableItemsQuery operation, which can return a large number of entitlements and line items that match specified criteria.

To achieve this, use the parameter tag:

<urn:activationIds> ... </urn:activationIds>

which accepts multiple activation IDs as input parameters to retrieve all line item details in a single request.

The parameter tag:

<urn:activationId> ... </urn:activationId> 

is wrapped inside the parameter tag:

<urn:activationIds> ... </urn:activationIds>

To search for a single activation ID, pass the activation ID in:

<urn:activationId> ... </urn:activationId>

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

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

Optional. A productType element contains one of the following:

• LICENSED_PRODUCT

• SUITE

• MAINTENANCE. Since maintenance is not attached to a license model, if selected, turn off the LicenseModel and LicenseTechnology attributes from the response.

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

Optional. A startDate element contains:

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

• searchType—one of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

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.

Optional. An expirationDate element contains:

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

• searchType—one of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

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)

Optional. An versionDate element contains:

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

• searchType—one of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

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

Optional. An orderId element contains:

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

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Optional. If true, return only activatable items with no order ID.

Note: Since this field is intended to return results without the specified attribute, setting this to false will have no effect on query results.

Optional. If true, return only activatable items that have a non-zero remaining count.

Note: This field is intended to return results without the specified attribute. Therefore, setting this value to false will have no effect on query results.

Optional. a soldTo element contains:

• value—a string to match part or all of the the account that has the right to fulfill or distribute activation IDs from this entitlement.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

A parentBulkEntSoldTo element contains:

• value—a string to match part or all of the the account to which the bulk entitlement was sold.

• searchType—one of the following simpleSearchType values::

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Note: Not available for the operation getActivatableItemsQuery. For queries using this parameter, use the operation getEntitlementLineItemPropertiesQuery.

One of the following:

• LINEITEM

• WEBREGKEY 

This parameter accepts multiple account names. Customers can provide multiple account unit names using repeated <urn:value>?</urn:value> elements.

NOTE: By default, you can pass up to ten account names, or as defined by the configuration option Maximum number of Account names accepted to search for Entitlement Line Item Properties.

Use the accountUnitName parameter for operations that require only a single account name.

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

Optional. A lineItemParentLineItemId element contains:

• value—a string to match part or all of the line item ID (activation ID) of a parent line item.

• searchType—one of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Use lineItemParentLineItemId with:

• getActivatableItemCount to return a count of immediate child line items of the parent line item

• getActivatableItemsQuery to return immediate child line items of the parent line item.

• getEntitlementLineItemPropertiesQuery to return a configurable set of properties of immediate child line items.

Optional. A createdOnDateTime element contains:

• value—a date and time value to compare to the created date and time value.

• searchType—one of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

Optional. A lastModifiedDateTime element contains:

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

• searchType—one of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

Use to filter the data either ascending or descending order by request input field sortBy attributes and ascending Boolean value as true or false:

• ENTITLEMENT_ID

• ACTIVATION_ID

• LINE_ITEM_ORDERABLE_NAME

• LINE_ITEM_ORDERABLE_VERSION

• LINE_ITEM_SKU

• LINE_ITEM_START_DATE

• LINE_ITEM_EXPIRATION_DATE

• LINE_ITEM_ORDER_ID

• LINE_ITEM_ORDER_LINE_NUMBER

• LINE_ITEM_FULFILLED_AMOUNT

• CONTACT

• SOLD_TO_NAME

• LINE_ITEM_ACTIVATABLE_ITEM_TYPE

• SOLD_TO_DISPLAY_NAME

• CURRENT_OWNER_ORG_NAMELINE_ITEM_LAST_MODIFIED

Example

Request sample of sortsBys:

<urn:sortBys>
    <!--1 or more repetitions:-->
    <urn:sortBy>
        <urn:sortKey>LINE_ITEM_ORDER_LINE_NUMBER  
        </urn:sortKey>
        <urn:ascending>true</urn:ascending>
    </urn:sortBy>
</urn:sortBys>

Used to return entitlement line items based on their license model(embedded or non-embedded).

• If isEmbeddedLicenseModel is set to true, the operation returns all the line items with an embedded license model type.

• If isEmbeddedLicenseModel is set to false, the operation returns all the line items with a non-embedded license model type.

Example

<urn:searchEntitlementLineItemPropertiesRequest>
    <urn:queryParams>
        <urn:isEmbeddedLicenseModel>true
        </urn:isEmbeddedLicenseModel>
    </urn:queryParams>
</urn:searchEntitlementLineItemPropertiesRequest> 

Use to filter the data by request input field lineitemstate.

• value—Specifiy Deployed, Inactive, Obsolete or Draft.

• searchType—One of the folowing:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Example

Request sample of lineItemState:

<urn:lineItemState>
    <urn:value>Deployed</urn:value>
    <urn:searchType>EQUALS</urn:searchType>
</urn:lineItemState>

Use to exclude expired activations from search results.

• true—When excludeExpired is set to true, all expired activations—those with expiration dates earlier than the current local date—will be excluded from the results.

• false—If excludeExpired is omitted or set to false, all activations, including expired ones, will be included.