Search Products
Returns a list of Products for the specified Vendor ID and parameters.
| Method Type | URI |
|---|---|
| GET |
/v90/ws/vendor/{vendorId}/product.ws ?productName={productName} &lifeCycleStage={lifeCycleStage} &refId1={refId1} &refId2={refId2} &pageIndex={pageIndex} &pageSize={pageSize} |
Example URL: http://hostname:8080/ems/v90
/ws/vendor/1/product.ws?productName=Print&lifeCycleStage=Commit&refId1=CRM15
&refId2=CRMN35&pageIndex=5&pageSize=10
URI Parameters
| Parameter | Description | Type |
|---|---|---|
| vendorId | (Required) Identifier of the Vendor in the database. | Integer |
| productName | (Optional) Product name. | String |
| refId1 | (Optional) Reference ID 1. Identifier of the Product in another system, such as CRM/ERP. | String |
| refId2 | (Optional) Reference ID 2. | String |
| pageIndex | (Optional) The starting page number. | Integer (>0) |
| pageSize | (Optional) The number of customers retrieved by one request. | Integer (>0) |
| identifier | (Optional) System generated unique identifier for the Product. | Integer |
| lifeCycleStage |
(Optional) Status of the Product. Valid values: Draft, Commit, EOL |
String |
| enforcementId | (Optional) Identifier of the Enforcement in the database. | Integer |
NOTE By default, a GET call returns a maximum of 200 entries per page. You can change this by modifying the pageIndex and pageSize values. (To change the default maximum number of returned entries for all GET calls for Products, Entitlements, and Customers, modify the Max Records per Page (Web Services) value in the Sentinel LDK-EMS Administration Console. For details, see the Sentinel LDK–EMS Configuration Guide.)
Sample Response
HTTP Status Code: 200
Success
Response Header:
X-Total-Count: The total number of entries. You can use X-Total-Count to calculate the total number of pages by dividing X-Total-Count by pageSize (X-Total-Count÷pageSize=number of pages). For example, suppose your application returns an X-Total-Count of 17 and the pageSize is 15. 17÷15=1.333 or 2 pages in total because each page includes a maximum of 15 entries. Similarly, suppose your application returns an X-Total-Count of 1103 and the pageSize is 15. 1103÷15=73.533 or 74 pages in total.
Response Body
<listResponse type="product" count="4"> <instance id="50" name="vvvvvvvv" identifier="34" type="BASE" lifeCycleStage="Commit" descr="" cloneProtection="true" refId1="" lockType="SL-AdminMode" enabled="true" deployed="true"/> <instance id="20" name="MYNewPRD" identifier="16" type="BASE" lifeCycleStage="Commit" descr="" cloneProtection="false" refId1="" lockType="SL-AdminMode" enabled="true" deployed="true"/> <instance id="21" name="mODpRD" identifier="16" type="MODIFICATION" lifeCycleStage="Commit" descr="" cloneProtection="true" refId1="" lockType="SL-AdminMode" enabled="true" deployed="false"/> <instance id="11" name="myBassss" identifier="7" type="BASE" lifeCycleStage="Commit" descr="" cloneProtection="true" refId1="" lockType="SL-AdminMode" enabled="true" deployed="true"/> </listResponse>
NOTE The order of the search result is decided on the basis of PRDId which acts as a unique identifier for each product in the database.
Failure
Response Body:
<listResponse type="product" count="0"/>