SOAP and REST Web Services Enhancements in 2024.02
The following enhancements were added to the SOAP and REST Web Services module in the 2024.02 release:
| • | New Endpoint in Software Container Delivery REST API |
| • | Ability to Search for Entitlements by Custom Attribute of Data Type “Boolean” |
New Endpoint in Software Container Delivery REST API
In the Software Container Delivery REST API, producer users can now call the new /event/{entity_name}/status endpoint using GET to understand if the registry service instance has processed a specified entity. If processing of an entity was not successful, the producer can then take appropriate steps.
In this release, only entities of type USER are supported.
Required parameters:
| • | entity_name (path parameter)—The user ID of the user whose status is queried. |
| • | entity_type (query parameter)—USER (the only entity type that is currently supported) |
The response returns one of the following status values:
| • | Processed—The entity has been processed successfully. |
| • | In-Progress—Processing of the entity is ongoing. |
| • | Cancelled—Processing of the entity did not complete due to an error. |
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. |