SOAP and REST Web Services Enhancements in 2024.09

The following enhancement was added to the SOAP and REST Web Services module in the 2024.09 release.

Product Packaging Data Extract Now Includes Product Version

When exporting a set of products using the Product Packaging Data Extract job (controlled by the Data Extract REST APIs), the resulting ProductsLicenseModel-<date and time>.csv file now includes a ProductVersion column which specifies the product version for each product listed in the file.

Inclusion of the ProductVersion column in the CSV file is controlled by a new configuration option called Show product version in extract file (under System > Configure > FlexNet Operations > General Options). By default, the option is not selected (meaning that the CSV file does not include product version information).

This enhancement enables producers to differentiate between products that have different versions.

Managing Upgrade Relationship Using EntitlementOrderService Web Service (Version 7)

Version 7 of the EntitlementOrderService SOAP web service now enables producers to add or remove an Upgrade relationship between two valid line items. In the updateEntitlementLineItem method, the parentLineItem element now includes the element lineItemType, which supports the new value NEW.

This functionality was already available in the Producer Portal, and this enhancement now creates parity between the Producer Portal and SOAP web services.

For a list of files that have been changed for this functionality, see Change Log for 2024.09.

Sample code for creating an Upgrade relationship

Provide valid activation IDs for the lineItemData and parentLineItem elements, and specify the value UPGRADE for lineItemType, as shown in the following example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:v7.webservices.operations.flexnet.com">
  <soapenv:Header/>
  <soapenv:Body>
    <urn:updateEntitlementLineItemRequest>
      <urn:lineItemData>
        <urn:entitlementIdentifier>
          <urn:primaryKeys>
            <urn:entitlementId>8380-7252-e0fc-4ddf-a203-0170-7120-de80</urn:entitlementId>
          </urn:primaryKeys>
        </urn:entitlementIdentifier>
        <urn:lineItemData>
          <urn:lineItemIdentifier>
            <urn:primaryKeys>
              <!-- Activation ID of line item that should be linked to a parent-->
              <urn:activationId>6e37-c975-5c79-47c9-a312-59ed-dafb-d872</urn:activationId>
            </urn:primaryKeys>
          </urn:lineItemIdentifier>
          <urn:description>Upgrade relationship added</urn:description>
          <urn:parentLineItem>
          <urn:uniqueId/>
            <urn:primaryKeys>
            <!-- Activation ID of line item that that will become a Parent reference -->
            <urn:activationId>5fe9-3acb-9b1a-4eec-8dc4-7792-9dc1-6fb7</urn:activationId>
              </urn:primaryKeys>
              <!-- New element added. Upgrade relation to be set with the Parent reference -->
              <urn:lineItemType>UPGRADE</urn:lineItemType>
            </urn:parentLineItem>
          </urn:lineItemData>
        <urn:autoDeploy>false</urn:autoDeploy>
      </urn:lineItemData>
    </urn:updateEntitlementLineItemRequest>
  </soapenv:Body>
</soapenv:Envelope>

Sample code for removing an Upgrade relationship

Provide valid activation IDs for the lineItemData and parentLineItem elements, and specify the value NEW for lineItemType, as shown in the following example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:v7.webservices.operations.flexnet.com">
  <soapenv:Header/>
  <soapenv:Body>
    <urn:updateEntitlementLineItemRequest>
      <urn:lineItemData>
        <urn:entitlementIdentifier>
          <urn:primaryKeys>
            <urn:entitlementId>8380-7252-e0fc-4ddf-a203-0170-7120-de80</urn:entitlementId>
          </urn:primaryKeys>
        </urn:entitlementIdentifier>
        <urn:lineItemData>
          <urn:lineItemIdentifier>
            <urn:primaryKeys>
              <urn:activationId>9875-c692-7e64-4c80-89ab-9c8e-adcc-4f5b</urn:activationId>
            </urn:primaryKeys>
          </urn:lineItemIdentifier>
          <urn:description>Unlink parent relation</urn:description>
          <urn:parentLineItem>
          <urn:uniqueId/>
            <urn:primaryKeys>
              <urn:activationId>5fe9-3acb-9b1a-4eec-8dc4-7792-9dc1-6fb7</urn:activationId>
            </urn:primaryKeys>
            <urn:lineItemType>NEW</urn:lineItemType>
          </urn:parentLineItem>
        </urn:lineItemData>
        <urn:autoDeploy>false</urn:autoDeploy>
      </urn:lineItemData>
    </urn:updateEntitlementLineItemRequest>
  </soapenv:Body>
</soapenv:Envelope>

New Configuration to Control Number of Accounts for Which to Retrieve User Information

Release 2024.07 introduced an enhancement, Returning User Information for Multiple Accounts, which enables producers to retrieve user information for multiple accounts using a single API request using getUsersQuery of the UserAcctHierarchyService (version 6). The number of accounts for which user information could be retrieved was limited to 10 accounts.

The 2024.09 release introduces a new configuration option, Number of accounts and associated user information to retrieve via SOAP API (under System > Configure > FlexNet Platform Server > General Options), which allows producers to modify this limit. The default setting is 10. Setting the option to -1 allows querying an unlimited number of accounts. Producers should bear in mind that specifying -1 might have a negative impact on system performance.

Event Notification Service REST API Supporting Event Notifications for Device Events

Producers can now use the Event Notification Service API to trigger an event notification whenever a specific event related to devices occurs. Real-time data about the event is delivered to a specified webhook URL where the data can be consumed programmatically to update the producer’s upstream or downstream systems.

The following parameters have been added to the /notificationService endpoint: