SOAP and REST Web Services Enhancements

The searchDevices operation of the ManageDeviceService web service now returns the licenseState attribute value, if the responseConfig.addOnCounts in the request is set to true.

This change applies to all versions of the ManageDeviceService web service.

ManageDeviceService Web Service Returning Site Name

In version 6 of the ManageDeviceService web service, the getDevice, getDevicesQuery and searchDevices operations can return the siteName attribute value. You can use <responseConfig> to include or exclude the site name in the response.

In addition, in version 6, siteName is available as a search parameter for the getDevicesQuery and searchDevices operations.

Mass Entitlement Search in EntitlementOrderService Web Service

Version 6 of the EntitlementOrderService web service enables producers to perform a mass entitlement search using the getActivatableItemsQuery operation, which can now return a large number of entitlements and line items that match specified criteria.

To achieve this, the parameter tag <urn:activationIds> ... </urn:activationIds> was added, which accepts multiple activation IDs as input parameters to retrieve all line item details in a single request.

Note:In v6 of the EntitlementOrderService web service, the parameter tag <urn:activationId> ... </urn:activationId> is now wrapped inside the new parameter tag <urn:activationIds> ... </urn:activationIds>. To search for a single activation ID, pass the activation ID in <urn:activationId> ... </urn:activationId>.

Ability to Filter By Line Item State in getEntitlementLineItemPropertiesQuery

In the EntitlementOrderService web service (version 5), the optional element lineItemState is now available as a query parameter for a getEntitlementLineItemPropertiesQuery operation. The new element enables producers to filter requests by the line item state (Deployed, Inactive, Obsolete, or Draft).

This improvement is intended to increase performance by reducing the number of entitlement lines to be retrieved.

Notification Email When Reactivating a User Via SOAP Web Services

When a user is reactivated—that is, the user’s state is changed from Inactive to Active—using the Producer Portal UI, a user activation email is automatically sent to the user, informing them about the change of state.

To maintain parity of behavior between the Producer Portal UI and SOAP web services, a new configuration option Send email when user is reactivated via web services has been introduced (under System > Configure > FlexNet Operations > General Options). This configuration option lets producers choose whether an email should be automatically triggered when a user is reactivated using the SOAP web services updateUser or createUser operation.

By default, the configuration option is disabled; that is, no email is sent when a user is reactivated through web services.

Producers who enable the configuration option should ensure that the User Enabled email template contains appropriate content, that it is active and that its Send Indicator is set to true.

ProductPackagingService Returning Details For Products Using Specified Product Line

A new optional parameter productLine has been added to the ProductPackagingService web service (version 2). The new parameter can be used in the getProductsQuery operation for the requests getProductsQueryRequest and getProductCountRequest to return details of all products that are linked with a particular product line.

ProductPackingService Now Returning Additional License Model Details

You can now use the newly introduced version 3 of the SOAP web service ProductPackingService to return additional details for license models that match specified criteria. The getLicenseModelIdentifier operation now returns the following additional license model details:

•

Expiration (duration)

•

Embedded or Not Embedded

•

Counted or Uncounted

•

Grace Period.

The following shows sample code of the additional attribute details that can be returned:

<isCounted>false</isCounted>

<modelType>EMBEDDED</modelType>

<gracePeriodDays>SPECIFIED_AT_ENTITLEMENT_TIME</gracePeriodDays>

Ability to Search for Entitlements by Custom Attribute of Data Type “Boolean”

Producers can now search for entitlements that have a specified custom attribute of data type Boolean applied. The search functionality is available in the Producer Portal and in the EntitlementOrderService SOAP web service (version 6).

Important:This enhancement only applies to entitlements that were created after the custom attribute was created. Older entitlements need to be updated to enable filtering (for example, by adding a value to the custom attribute or saving the entitlement).

Searching for Boolean Custom Entitlement Attributes in the Producer Portal

Boolean custom attributes for entitlements are now listed in the dropdown list in the Search On Custom Entitlement Attributes section of the Advanced Search panel. (To access the Advanced Search panel, click Entitlements > List Entitlements By Order. On the List Entitlements By Order page, click Advanced Search.)

Upon selection of a Boolean custom attribute for entitlements from the dropdown list, producers can choose one of the following options:

•

Yes—Display only entitlements that had the selected custom attribute applied during creation.

•

No—Display only entitlements that did not have the selected custom attribute applied during creation.

•

Any—Display all entitlements, regardless of whether they had the selected custom attribute applied during creation.

Searching for Boolean Custom Entitlement Attributes Using the EntitlementOrderService Web Service

The ability to search for a specified Boolean custom attribute with the entity type Entitlement was added to the getEntitlementsQuery method of the EntitlementOrderService web service (version 6).

The getEntitlementsQuery method now accepts the optional search parameter booleanValue, with the valid values true and false:

•

true—Display only entitlements that had the specified custom attribute applied during creation.

•

false—Display only entitlements that did not have the specified custom attribute applied during creation.

DownloadPackagingService Returns Download Package Details

The getDownloadPackageQuery and getDownloadPackageCount methods of the DownloadPackagingService web service, versions 3 and 4, now support querying download packages based on custom attribute values. To achieve this, a new optional filter, AttributeDescriptor, has been added.

Create and Retrieve Account and Country Restrictions for Download Packages

You can now use the newly introduced version 4 of the SOAP web service DownloadPackagingService to create and retrieve information about account and country restrictions for download packages:

•

A new endpoint called CreateRestrict has been introduced which enables you to incorporate account and country restrictions or both into a download package.

•

The existing endpoint, getDownloadPackageQuery, has been enhanced to facilitate the retrieval of both types of restrictions.

SOAP and REST Web Services Enhancements

FlexNet Operations 2024 R1 On-Premises Release Notes

September 2024