API Changes from Version 4.2 to Version 5

This topic provides information about changes in Sentinel EMS REST API from version 4.2 to version 5.

Web Service

Version 4.2 and Earlier (URL)

Alternative in Version 5 (URL and Method)

Authentication    

Customer Login by Product Key

/ems/loginByProductKey.xml

Use the Basic Authentication Header

ISV User Login

/ems/verifyLogin.xml

Use the Basic Authentication Header

Partner Login

/ems/verifyPartnerLogin.xml

Use the Basic Authentication Header

Logout

/ems/closeSession.xml

Not required if Basic Authentication is used

Login by Contact

/ems/loginByContact.xml

Use the Basic Authentication Header

Namespace    

Add Namespace

/ems/addNamespace.xml

POST /ems/api/v5/namespaces

Edit Namespace

/ems/updateNamespace.xml

PUT /ems/api/v5/namespaces/{id}

PATCH /ems/api/v5/namespaces/{id}

Delete Namespace

/ems/deleteNamespace.xml

DELETE /ems/api/v5/namespaces/{id}

License Model    

Create License Model using License XML (REST)

/ems/v4_2/ws/LicenseModel.ws

POST /ems/api/v5/enforcements/{enforcementId}/licenseModels

Get License Model Using License ID (REST)

/ems/v4_2/ws/licenseModel/{licenseModelId}.ws

GET /ems/api/v5/enforcements/{enforcementId}/licenseModels/{id}

Update License Model Using License ID and License XML (REST)

/ems/v4_2/ws/licenseModel/{licenseModelId}.ws

PUT /ems/api/v5/enforcements/{enforcementId}/licenseModels/{id}

PATCH /ems/api/v5/enforcements/{enforcementId}/licenseModels/{id}

Get License Models using Enforcement ID (REST)

/ems/v4_2/ws/enforcement/{enforcementId}/licenseModel.ws

GET /ems/api/v5/enforcements/{enforcementId}/licenseModels

Deprecated

   

Search License Models

/ems/searchLicenseModelList.xml

GET /ems/api/v5/enforcements/{enforcementId}/licenseModels

Get License Model Detail by ID

/ems/getLicenseModelById.xml

GET /ems/api/v5/enforcements/{enforcementId}/licenseModels/{id}

Feature    

Create Feature (REST)

/ems/v4_2/ws/feature.ws

POST /ems/api/v5/features

Retrieve Features Details (REST)

/ems/v4_2/ws/feature/{featureId}.ws

GET /ems/api/v5/features/{id}

Update Feature Details for the Given Feature ID (REST)

/ems/v4_2/ws/feature/{featureId}.ws

PUT /ems/api/v5/features/{id}

PATCH /ems/api/v5/features/{id}

Delete Feature (REST)

/ems/v4_2/ws/feature/{featureId}.ws

DELETE /ems/api/v5/features/{id}

Search Features (REST)

/ems/v4_2/ws/searchFeature.ws

GET /ems/api/v5/features

Deprecated    

Retrieve Feature for the Given Feature ID

/ems/viewFeatureById.xml

GET /ems/api/v5/features/{id}

Add Feature

/ems/addFeature.xml

POST /ems/api/v5/features

Search Feature

/ems/searchFeatures.xml

GET /ems/api/v5/features

Edit Feature Description

/ems/updateFeatureDescription.xml

PUT /ems/api/v5/features/{id}

PATCH /ems/api/v5/features/{id}

Edit Feature License Model Association

/ems/updateFeatureLMAssociation.xml

PUT /ems/api/v5/features/{id}/featureLicenseModels

PATCH /ems/api/v5/features/{id}/featureLicenseModels

Delete Feature

/ems/deleteFeature.xml

DELETE /ems/api/v5/features/{id}

Product    

Create Product Using Product XML

/ems/v4_2/ws/product.ws

POST /ems/api/v5/products

Get Product Using Product ID

/ems/v4_2/ws/product/{productId}.ws

GET /ems/api/v5/products/{id}

Update Product Using Product ID and Product XML

/ems/v4_2/ws/product/{productId}.ws

PUT /ems/api/v5/products/{id}

PATCH /ems/api/v5/products/{id}

Search Products

/ems/v4_2/ws/searchProduct.ws

GET /ems/api/v5/products

Delete Products

/ems/v4_2/ws/feature/{featureId}.ws

DELETE /ems/api/v5/products/{id}

Deprecated    

Associate Features With a Product

/ems/associateFeaturesWithProduct.xml

PUT /ems/api/v5/products/{id}/productFeatures

PATCH /ems/api/v5/products/{id}/productFeatures

Disassociate Features from a Product

/ems/associateFeaturesWithProduct.xml

DELETE /ems/api/v5/products/{id}/productFeatures

Create New Product

/ems/createProduct.xml

POST /ems/api/v5/products

Retrieve Product for the Given Product Name and Version

/ems/getProductByNameAndVer.xml

GET /ems/api/v5/products/{id}

Retrieve Product for the Given Product ID

/ems/getProductById.xml

GET /ems/api/v5/products/{id}

Change Product Lifecycle Stage

/ems/changeProductLifeCycleStage.xml

PUT /ems/api/v5/products/{id}

PATCH /ems/api/v5/products/{id}

Update Catalog RefIds

/ems/updateCatalogRefIds.xml

PUT /ems/api/v5/products/{id}

PATCH /ems/api/v5/products/{id}

Search Products

/ems/searchProducts.xml

GET /ems/api/v5/products

Product Suite    

Retrieve Product Suite for the Given Suite ID

/ems/getSuiteById.xml

GET /ems/api/v5/productSuites/{id}

Search Suite for Name and Version

/ems/getSuiteByNameAndVer.xml

GET /ems/api/v5/productSuites

Create Product Suite

/ems/createSuite.xml

POST /ems/api/v5/productSuites

Search Suites

/ems/searchSuites.xml

GET /ems/api/v5/productSuites

User    

Create User

/ems/v4_2/ws/user.ws

POST /ems/api/v5/users

Retrieve Users

/ems/v4_2/user/{userId}.ws

GET /ems/api/v5/users/{id}

List Channel Partners

/ems/channelPartnerList.xml

GET /ems/api/v5/partners

Retrieve All Users

/ems/userList.xml

GET /ems/api/v5/users

Deprecated    

Retrieve User Details

/ems/userProfile.xml

GET /ems/api/v5/users/{id}

Role    

Retrieve All Roles

/ems/roleList.xml

GET /ems/api/v5/roles

Retrieve Role by the Given Role Name

/ems/roleProfile.xml

GET /ems/api/v5/roles/{id}

Customer and Contact  

Retrieve Customer by ID

/ems/getCustomerById.xml

GET /ems/api/v5/customers/{id}

Retrieve Customer by Customer Name

/ems/getCustomerByCustomerName.xml

GET /ems/api/v5/customers/{id}

Delete Customer by Customer ID

/ems/deleteCustomerById.xml

DELETE /ems/api/v5/customers/{id}

Create Customer

/ems/createCustomer.xml

POST /ems/api/v5/customers

Update Customer

/ems/updateCustomer.xml

PUT /ems/api/v5/customers/{id}

POST /ems/api/v5/customers/{id}

Search Customers

/ems/searchCustomers.xml

GET /ems/api/v5/customers

Add Customer to a Contact (only if Customer is null for a Contact)

/ems/associateContactWithCustomer.xml

PUT /ems/api/v5/contacts/{id}

PATCH /ems/api/v5/contacts/{id}

Change Contact Password

/ems/changeContactPassword.xml

PUT /ems/api/v5/contacts/

PATCH /ems/api/v5/contacts/

User Registration

/ems/registerUser.xml

Not Supported

Get Contact by ID or E-mail (REST)

/ems/v4_2/ws/contact/{contactId}.ws

GET /ems/api/v5/contacts/{id}

Create Contact (REST)

/ems/v4_2/ws/contact.ws

POST /ems/api/v5/contacts

Update Contact (REST)

/ems/v4_2/ws/contact/{contactId}.ws

PUT /ems/api/v5/contacts/{id}

PATCH /ems/api/v5/contacts/{id}

Search Contacts (REST)

/ems/v4_2/ws/searchContact.ws

GET /ems/api/v5/contacts

Delete Contact (REST)

/ems/v4_2/ws/contact/{contactId}.ws

DELETE /ems/api/v5/contacts/{id}

Deprecated    

Search Contacts

/ems/searchContacts.xml

POST /ems/api/v5/contacts

Create Contact

/ems/createContact.xml

POST /ems/api/v5/contacts

Retrieve Contact by ID

/ems/getContactById.xml

GET /ems/api/v5/contacts/{id}

Retrieve Contact by E-mail ID

/ems/getContactByEmailId.xml

GET /ems/api/v5/contacts/{id}

Delete Contact by ID

/ems/deleteContact.xml

DELETE /ems/api/v5/contacts/{id}

Update Contact

/ems/updateContact.xml

PUT /ems/api/v5/contacts/{id}

PATCH /ems/api/v5/contacts/{id}

Channel Partner

   

Create Channel Partner

/ems/v4_2/ws/partner.ws

POST /ems/api/v5/partners

Retrieve Channel Partner Details

/ems/v4_2/ws/partner/{partnerId}.ws

GET /ems/api/v5/partners/{id}

Search Channel Partners

/ems/v4_2/ws/searchPartner.ws

GET /ems/api/v5/partners

Update Channel Partner

/ems/v4_2/ws/partner/{partnerId}.ws

PUT /ems/api/v5/partners/{id}

PATCH /ems/api/v5/partners/{id}

Delete Channel Partner

/ems/v4_2/ws/partner/{partnerId}.ws

DELETE /ems/api/v5/partners/{id}

Entitlement    

Create Entitlement Using Entitlement XML

/ems/v4_2/ws/entitlement.ws

POST /ems/api/v5/entitlements

Modify Entitlement Using Entitlement XML

/ems/v4_2/ws/entitlement.ws

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Split and Transfer Entitlement

/ems/v4_2/ws/entitlement/{entId}/split-transfer.ws

POST /ems/api/v5/entitlements/{id}/splitTransfer

Get Entitlement Using Entitlement ID

/ems/v4_2/ws/entitlement/{entId}.ws

GET /ems/api/v5/entitlements/{id}

Search Entitlements

/ems/v4_2/ws/searchEntitlement.ws

GET /ems/api/v5/entitlements

Update Entitlement Using Entitlement ID and Entitlement XML

/ems/v4_2/ws/entitlement/{entId}.ws

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Delete Entitlement Using Entitlement ID

/ems/v4_2/ws/entitlement/{entId}.ws

DELETE /ems/api/v5/entitlements/{id}

Get Entitlement Item by Product Key

/ems/getEntitlementItemByProductKey.xml

GET /ems/api/v5/productKeys/{id}

View Entitlement Certificate

/ems/getEntitlementCertificateHTML.xml

Not Supported

Search Contact Entitlements

/ems/searchContactEntitlement.xml

GET /ems/api/v5/entitlements

Retrieve Previous Activation Details

/ems/getPreviousActivations.xml

GET /ems/api/v5/activations

Retrieve License Certificate of a Previous Activation

/ems/getLicenseCertificateHTML.xml

Not Supported

Deprecated    

Create Entitlement

/ems/createEntitlement.xml

POST /ems/api/v5/entitlements

Commit Entitlement

/ems/commitEntitlement.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Get Entitlement Item by ID

/ems/getEntitlementItemById.xml

GET /ems/api/v5/entitlements/{id}

Change Entitlement Item Status

/ems/changeLineItemStatus.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Change Product Key Status

/ems/changeProductKeyStatus.xml

PUT /ems/api/v5/productKeys/{id}

PATCH /ems/api/v5/productKeys/{id}

Search Entitlements

/ems/searchEntitlements.xml

GET /ems/api/v5/entitlements

Allow/Deny Activation for an Entitlement

/ems/changeEntitlementActivationState.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Renew an Entitlement

/ems/renewEntitlement.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Renew Line Item

/ems/renewLineItem.xml

PUT /ems/api/v5/productKeys/{id}

PATCH /ems/api/v5/productKeys/{id}

Update Entitlement Details

/ems/updateEntitlement.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Retrieve list of Line Items, with Product(s), Feature(s) and License Model, for a given Entitlement ID

/ems/getEntitlementDetailsById.xml

GET /ems/api/v5/entitlements/{id}

Add Entitlement Item

/ems/addEntitlementItem.xml

POST /ems/api/v5/entitlements/{id}/productKeys

Edit Entitlement Item

/ems/editEntitlementItem.xml

PUT /ems/api/v5/productKeys/{id}

PATCH /ems/api/v5/productKeys/{id}

Update Entitlement - Remove Products and Suites

/ems/removeEntitlementItem.xml

PUT /ems/api/v5/entitlements/{id}

Recharge Line Item

/ems/rechargeLineItem.xml

PUT /ems/api/v5/productKeys/{id}

PATCH /ems/api/v5/productKeys/{id}

Update Entitlement Attribute for All/Given Features

/ems/updateEntitlementAttributeForAllFeatures.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Update Attribute for All/Given Features in a Product in Entitlement

/ems/updateProductFeatureEntitlementAttributes.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Associate Existing or New Contact with an Anonymous Entitlement

/ems/updateEntitlementContact.xml

PUT /ems/api/v5/entitlements/{id}/contact

PATCH /ems/api/v5/entitlements/{id}/contact

Retrieve License Model Attributes for a Feature in a Line Item

/ems/getEntFeatureLMAttributes.xml

GET /ems/api/v5/entitlements/{id}

Update License Model Attributes in a Line Item

/ems/setEntFeatureLMAttributes.xml

PUT /ems/api/v5/entitlements/{id}

PATCH /ems/api/v5/entitlements/{id}

Retrieve Usage Log (REST)

/ems/retrieveUsageLog.ws

GET /ems/api/v5/reports/name=usageReport

Retrieve Billing Data (REST)

/ems/billingData.ws

GET /ems/api/v5/reports/name=usageReport

Freeing License Sessions /ems/customer/{customerId}/licenseSession/ {sessionId}.ws POST /ems/api/v5/activations/{id}/markRevoke
Retrieve Entitlement Details Registered Against Fingerprint /ems/v4_2/ws/customer/{customerId}/entitlement.ws GET /ems/api/v5/entitlements
Retrieve License Sessions /ems/v4_2/ws/customer/{customerId}/licenseSession.ws GET /ems/api/v5/activations

Activation

   

Create and Complete Activation

/ems/v4_2/ws/activation.ws

POST /ems/api/v5/activations/bulkActivate

External Activation using Push Keys

/ems/v4_2/ws/activation.ws

POST /ems/api/v5/activations/bulkActivate

Manual Activation

/ems/v4_2/ws/activation.ws

POST /ems/api/v5/activations/bulkActivate

Retrieve Activation Using Activation ID

/ems/v4_2/ws/activation/{activationId}.ws

GET /ems/api/v5/activations/aId={aId}

Create Activation By Product Key

/ems/createActivationByProductKey.xml

POST /ems/api/v5/activations/bulkActivate

Get Renewed License

/ems/getRenewedLicense.xml

GET /ems/api/v5/activations/{id}

Show Entitlement Activations by entId

/ems/showEntitlementActivations.xml

GET /ems/api/v5/activations

Advanced Search Activations

/ems/v4_2/ws/Activation.ws

GET /ems/api/v5/activations

Deprecated

 

 

Create Activation

/ems/createActivation.xml

POST /ems/api/v5/activations/bulkActivate

Complete Activation

/ems/completeActivation.xml

POST /ems/api/v5/activations/bulkActivate

Get Activation By ID

/ems/getActivationById.xml

GET /ems/api/v5/activations/{id}

Get Activation By AID

/ems/getActivationByAid.xml

GET /ems/api/v5/activations/aId={aId}

Search Activations

/ems/searchActivations.xml

GET /ems/api/v5/activations

Revocation    

Create Revocation Request

/ems/createRevocationRequest.xml

POST /ems/api/v5/activations/{id}/generatePermissionTickets

Deprecated

POST /ems/api/v5/activations/{id}/generatePermissionTicket

Mark an Activation as Revoked

/ems/MarkRevoked.xml

POST /ems/api/v5/activations/{id}/markRevoke

Custom Revocation

/ems/customRevoke.xml

POST /ems/api/v5/activations/{id}/customRevoke

Upload Revocation Ticket

/ems/uploadRevocationOutput.xml

POST /ems/api/v5/activations/{id}/submitRevokeProofs

Deprecated:

POST /ems/api/v5/activations/{id}/submitRevokeProof

Get Permission Ticket By RID

/ems/getPermissionTicketByRID.xml

POST /ems/api/v5/activations/{id}/generatePermissionTickets

Deprecated:

POST /ems/api/v5/activations/{id}/generatePermissionTicket

Confirm Revocation

/ems/ConfirmRevocation.xml

POST /ems/api/v5/activations/{id}/confirmRevoke

Reject Revocation

/ems/RejectRevocation.xml

POST /ems/api/v5/activations/{id}/rejectRevocation

Delete Revocation

/ems/deleteRevocations.xml

Not Supported

New    

Mark as Bulk Revoked

Not Available

POST /ems/api/v5/activations/bulkMarkRevoke

Fingerprint Registration for Lease Entitlements

 

Update Entitlement Association

/ws/FingerPrint.ws

PATCH /ems/api/v5/entitlements/{entitlementId}/entitlementFingerprints

Search Fingerprints in Entitlement

/ws/entitlement/{entId}/FingerPrint.ws

GET /ems/api/v5/entitlements/{entitlementId}/entitlementFingerprints

Remove Fingerprint from Entitlement

/ws/FingerPrint/{fingerPrintId}.ws

DELETE /ems/api/v5/entitlements/{entitlementId}/entitlementFingerprints/
{fingerprintId}

New    
Add Fingerprint

Not Available

POST /ems/api/v5/customers/{customerId}/fingerprints
Search Fingerprints Not Available GET /ems/api/v5/customers/{customerId}/fingerprints
Get Fingerprint Not Available GET /ems/api/v5/customers/{customerId}/fingerprints/{fingerprintId}
Update Fingerprint Not Available PATCH /ems/api/v5/customers/{customerId}/fingerprints/
{fingerprintId}

Update Product Key Association

Not Available PATCH /ems/api/v5/productKeys/{pkId}/productKeyFingerprints

Search in Product Key

Not Available GET /ems/api/v5/productKeys/{pkId}/productKeyFingerprints

Remove from Product Key

Not Available DELETE /ems/api/v5/productKeys/{pkId}/productKeyFingerprints/
{fingerprintId}

Update Variant Association

Not Available PATCH /ems/api/v5/productKeys/{pkId}/productVariants/
{productVariant}/productVariantFingerprints

Search in Variant

Not Available GET /ems/api/v5/productKeys/{pkId}/productVariants/{productVariant}/
productVariantFingerprints

Remove from Variant

Not Available DELETE /ems/api/v5/productKeys/{pkId}/productVariants/{productVariant}/
productVariantFingerprints/{fingerprintId}
Named Users    

Add Named Users

/ws/namedUser.ws

PATCH /ems/api/v5/productKeys/{pkId}/namedUsers

Overwrite Named Users

/ws/namedUser.ws

PATCH /ems/api/v5/productKeys/{pkId}/namedUsers

Get Named Users

/ws/entitlement/{eid}/namedUser.ws

GET /ems/api/v5/productKeys/{pkId}/namedUsers

Delete Named Users

/ws/entitlement/{eid}/namedUser.ws

DELETE /ems/api/v5/productKeys/{pkId}/namedUsers

Deploy Named Users

/ws/entitlement/{eid}/namedUser.ws

Not Supported
Template    

Get Entity Template Attributes

/ems/getEntityCustomAttributes.xml

No longer supported. Use resource-specific services.

View Entity By Attribute

/ems/searchEntityByCustomAttribute.xml

No longer supported. Use resource-specific services.

Update Custom Attribute

/ems/updateCustomAttribute.xml

No longer supported. Use resource-specific services.
ESD (Downloads)    

Retrieve Download by ID

/ems/v4_2/ws/download/{downloadId}.ws

GET /ems/api/v5/downloads/{id}

Search Vendor List Item

/ems/v4_2/ws/download/vendorList/listItem.ws

Not Supported

Search Download List Item

/ems/v4_2/ws/download/downloadList/listItem.ws

Not Supported

Search License List Item

/ems/v4_2/ws/download/licenseList/listItem.ws

Not Supported

Search Product List Item

/ems/v4_2/ws/download/productList/listItem.ws

Not Supported

Add List Type Name in Vendor List

/ems/v4_2/ws/download/vendorList/listItem.ws

Not Supported

Add List Type Name in Download List

/ems/v4_2/ws/download/downloadList/listItem.ws

Not Supported

Add List Type Name in Product List

/ems/v4_2/ws/download/productList/listItem.ws

Not Supported

Add List Type Name in License List

/ems/v4_2/ws/download/licenseList/listItem.ws

Not Supported

Retrieve Entitlement Downloads

/ems/v4_2/ws/download/Entitlement-item.ws

GET /ems/api/v5/downloads

Search Downloads

/ems/v4_2/ws/download.ws

GET /ems/api/v5/downloads

Get STS Token /ems/v4_2/ws/download/stsTokenESD.ws GET /ems/api/v5/stsToken

Create Download

/ems/v4_2/ws/download.ws

POST /ems/api/v5/downloads

Delete Download

/ems/v4_2/ws/download/{downloadId}.ws

DELETE /ems/api/v5/downloads

Lists

   

Create List Item

/ws/listItem.ws

PUT /ems/api/v5/listAttributes/{id}/options

PATCH /ems/api/v5/listAttributes/{id}/options

Update List Item

/ws/listType/{listItemId}.ws

PUT /ems/api/v5/listAttributes/{id}/options/{id}

Search List Item

/ws/searchListItem.ws

GET /ems/api/v5/listAttributes/{id}/options

Delete List Item

/ws/listType/{listItemId}.ws

DELETE /ems/api/v5/listAttributes/{id}/options/{id}

Search List Type

/ws/searchListType.ws

GET /ems/api/v5/listAttributes

Reports

   

Retrieve the List of Reports

/ems/v4_2/ws/report.ws

GET /ems/api/v5/reports

Get Report as XML or JasperXML

/ems/v4_2/ws/report/{reportId}.ws

GET /ems/api/v5/reports/{id}

List of Customers where Data is Tampered

/ems/v4_2/ws/retrieveCustomerTamperList.ws

GET /ems/api/v5/reports/name=customerTamperList

Data Tampering Details for Customer

/ws/retrieveCustomerTamperData.ws

GET /ems/api/v5/reports/name=customerTamperData

Raw Usage Report

/ws/retrieveUsageReport.ws

GET /ems/api/v5/reports/name=usageReport

Peak Concurrency Report

/ws/retrievePeakConcurrencyReport.ws

GET /ems/api/v5/reports/name=peakConcurrencyReport

Deprecated    

Provisioning Data Report

/ws/retrieveProvisioningDataReport.ws

GET /ems/api/v5/entitlements

Application Information

 

Get Release Information

/ems/releaseInfo.xml

Not Supported

Get Locale List

/ems/getLocales.xml

Not Supported