SOAP and REST Web Services Enhancements in 2024.11
The following enhancement was added to the SOAP and REST Web Services module in the 2024.11 release.
getEntitlementLineItemPropertiesQuery Returning Licenses for Multiple Accounts
The EntitlementOrderService web service has been updated to v8, with a modified getEntitlementLineItemPropertiesQuery which now allows searching by multiple account names. The <urn:value> element of the complex element <urn:accountUnitName> can be repeated multiple times to search by multiple account names.
This change enables producers to retrieve the licenses and detailed licensing information for specified accounts.
The number of accounts to search for can be limited using a new configuration option called Maximum number of Account names accepted to search for Entitlement Line Item Properties (under System > Configure > FlexNet Operations > General Options).
If the number of <urn:value> elements in the request exceeds the configured limit, an error message will be returned.
Using multiple <urn:value> elements
The following limitations apply when supplying multiple <urn:value> elements as search parameters:
| • | If the query also includes other search parameters, then for those parameters only the default values are considered. |
| • | The <urn:searchType> parameter is optional. If used, it accepts only EQUALS. Any other value passed for <urn:searchType> will result in an error message. |
| • | The <urn:partnerTier> will not be used and a default of search by ANY partner tier will be applied. |
Note:The limitations only apply when using multiple elements. If a single <urn:value> element is provided, then the behavior of the search is the same as in v7 (meaning that all allowed values for <urn:searchType> or <urn:partnerTier> can be used as search criteria).
Snippet of a sample request
<urn:searchEntitlementLineItemPropertiesRequest>
<urn:queryParams>
<urn:accountUnitName>
<!--1 or more repetitions:-->
<urn:value>MyAccount01</urn:value>
<urn:value>MyAccount02</urn:value>
<urn:value>MyAccount03</urn:value>
<urn:value>MyAccount04</urn:value>
<urn:value>MyAccount05</urn:value>
</urn:accountUnitName>
</urn:queryParams>
</urn:searchEntitlementLineItemPropertiesRequest>
For more details refer to the Change Log for 2024.11.
Effects on Entitlement Order REST Endpoints
Note the following changes to the request object for Entitlement Order REST endpoints.
Entitlement Order REST endpoints have two objects in the request: accountId and accountUnitName. No changes have been made to the accountId (PartnerTierQueryTypeDTO) object. However, the accountUnitName (AccountNamesQueryTypeDTO) object now accepts a string array for the field value. Currently, only a single value is supported. Searching by multiple account names is enabled only in the getEntitlementLineItemPropertiesQuery webservice operation.
Usage Example
{
"queryParams": {
"accountUnitName": {
"value": ["ACME"],
"searchType": "STARTS_WITH"
}
}
}