SOAP Web Service Versioning

FlexNet Operations Web Services use a separate versioning system from the overall FlexNet Operations product. To provide producers with greater flexibility when managing their own Web Service client code, new Web Service versions are created as new features are added to existing services.

The base version of each Web Service that exists in the root of the Web Services directory is the original versions introduced in FlexNet Operations 2016 and, in some cases, modified in FlexNet Operations 2016 Release 2. New versions are indicated by a version designator: V1, V2, and so forth. Web Services with no additional versions listed offer only the base version. Producers can choose to use the newer version of a given Web Service or to continue using a prior release’s Web Service version in their Web Service clients.

To see a listing of FlexNet Operations Web Services, open a Web browser and navigate to

https://<host:port>/flexnet/services/

where host is your FlexNet Operations host and port is the port on which FlexNet Operations is running.

Working with Web Service Versions

As each Web Service changes in a way that could pose a risk for backwards compatibility, FlexNet Operations creates a new version of that Web Service. The base version of each service remains intact to preserve functionality of all existing Web Service clients.

To take advantage of a new Web Service version, producers must update their Web Service client code to reference the new version’s WSDL and endpoint URL, and then make any additional code alterations necessary to take advantage of the new version’s functionality.

For example, to use the v1 of the Product Packaging service, reference the WSDL at:

https://<host:port>/flexnet/services/v1/ProductPackagingService?wsdl

where host is your FlexNet Operations host and port is the port on which FlexNet Operations is running. Then make any additional code changes necessary to adapt your Web Service client to use the new Web Service version.

Web Service Version History

The following table identifies the available versions for each Web Service and identifies the release for which the version was introduced.

FlexNet Operations Web Services Versions

Web Service	Versions	Changes
Product Packaging	v2	Introduced in FlexNet Operations 2018 R1, v2 changes include: • Added optional parameter productLine for the getProductsQuery operation to return details of all products that are linked with a particular product line. • Changing organization to account and org to acct • Removed the deprecated createAccount (formerly createOrganization) method.
	v1	Introduced in FlexNet Operations 2016 Release 3, v1 changes include • New attributes to products to support the specification of upgrade start and end dates and the email template variation to use for product version upgrade notifications. • Web Service versioning introduced.
	base	The original Product Packaging service introduced in FlexNet Operations 2016.
Entitlement Order	v5	Introduced in FlexNet Operations 2021.09, v5 changes include: • Added optional parameter lineItemState to the getEntitlementLineItemPropertiesQuery operation. • Binding name format omits the “/”. • Added optional parameter isEmbeddedLicenseModel to the getEntitlementLineItemPropertiesQuery operation.
	v4	Introduced in FlexNet Operations 2018 R3.
	v3	Introduced in FlexNet Operations 2018 R1, v3 changes include: • Changing organization to account and org to acct
	v2	Introduced in FlexNet Operations 2017 R4, v2 changes include: • Added transferredFromLineItem and splitFromLineItem to the response for the getEntitlementLineItemPropertiesQuery
	v1	Introduced in FlexNet Operations 2016 R4, v1 changes include • Removal of entitledProducts from updateBulkEntitlement. • Web Service versioning introduced.
	base	The original Entitlement Order service introduced in FlexNet Operations 2016.
License	v1	Introduced in FlexNet Operations 2018 R1, v1 changes include: • Changing organization to account and org to acct
	base	The original License service introduced in FlexNet Operations 2016.
User Account Hierarchy	v5	Introduced in FlexNet Operations 2023.06, v5 changes include: • Added name field to the acctRolesList response in the getUsersQuery method.
	v4	Introduced in FlexNet Operations 2021.09, v4 changes include: • Binding name format omits the “/”.
	v3	Introduced in FlexNet Operations 2018 R3, v3 changes include: • Added createdDate, createdBy and lastModifiedBy fields to the getAccountsQuery. • Added createdBy and lastModifiedBy fields to the getUsersQuery
	v2	Introduced in FlexNet Operations 2018 R1, v2 changes include: • Rename user related fields from userAccount to user.
	base	The original User Account Hierarchy service introduced in FlexNet Operations 2018. It replaces the User Organization Hierarchy Service.
FlexNet Authentication	v1	Introduced in FlexNet Operations 2016 Release 4, v1 changes include • Removal of deprecated API, getUserToken().
	base	The original FlexNet Authentication service introduced in FlexNet Operations 2016.
Manage Device	v5	Introduced in FlexNet Operations 2022.11, v5 changes include: • The searchDevices operation now supports searching and filtering by the parameters addOnExpirationDate and hasLicense.
	v4	Introduced in FlexNet Operations 2020 R3 SP3, v4 changes include: • Added the createdOn attribute to getDeviceResponseData. This attribute enables users to view the device creation date.
	v3	Introduced in FlexNet Operations 2018 R1, v3 changes include: • Changing organization to account and org to acct.
	v2	Introduced in FlexNet Operations 2017 R4, v2 changes include: • Added the soldToOrgId attribute to getDevicesQuery. The soldTo attribute uses the display name when searching. The new parameter, soldToOrgId, uses the Account ID for searching. • Added the getAddonExpirationDate service. This new service allows users to retrieve the expiration override date after an addon is mapped to a device.
	v1	Introduced in FlexNet Operations 2017, v1 changes include • Introduction of a new User element for devices. • Removal of unsupported operations.
	base	The original Manage Device service introduced in FlexNet Operations 2016.
Download Packaging	v3	Introduced in FlexNet Operations 2022.10, v3 changes include: • Added search parameter LastModifiedDateTime to the following operations: • getDownloadPackageQuery • getDownloadPackageCount • getFileQuery • getFileCount The new parameter enables producers to import data about periodic updates into their back office system and make this data available to their end customers.
	v2	Introduced in FlexNet Operations 2016 Release 4, v2 changes include • The getDownloadPackageQuery is updated to accept product name and version to enable searching for a specified product via Web Services. The response is updated to include the system ID, version, and availability—ARCHIVE, CURRENT, or FUTURE—of the download package. • To export download packages into Excel, product association information is included in the response of the getDownloadPackageQuery method. When an existing download package ID is passed and ReturnContainedObjects is set to TRUE, associated product names and the versions (if any) are returned per download package result. Similarly, to export download files into Excel, the download packages each file is associated with must be populated. This information is included in the response of the getFileQuery method. When an existing file ID is passed and ReturnContainedObjects is set to TRUE, associated download package IDs (if any) are returned per download file result.
	v1	Introduced in FlexNet Operations 2016 Release 3, v1 changes include • Web Service versioning introduced. • No functional changes.
	base	The original Electronic Software Delivery service introduced in FlexNet Operations 2016. This service was previously called ESD Web Service.
Usage	v1	Introduced in FlexNet Operations 2018 R1, v1 changes include: • Changing organization to account and org to acct.
	base	The original Usage service introduced in FlexNet Operations 2016.