REST API - findByExample
The table summarizes the REST API - findByExample.
Request
Format | POST <baseurl>/globaldata/model/<caseType>/<version>/findbyexample |
Path parameters |
|
Query parameters | |
Body | casePayload: Contains the parameters in the caseDataType element (from the BusinessDataServices schema). This contains the searchable case attributes of the case data whose case references you want to find. Your request must be constructed to match the structure of the case data defined in your business object model. See Obtaining Information From TIBCO Business Studio . |
Response
JSON | Returns a JSON representation of the contents of a SearchResults element. |
XML | Returns the contents of a SearchResults element (from the BusinessDataServices schema) |
Example
Request | POST <baseurl>/globaldata/model/com.example.gddemo.car/2/findbyexample |
Body | <xml-fragment> <casePayload> <![CDATA[ <tns1:CarElement xmlns:tns1="http://example.com/gddemo" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <vehicleID>ID206</vehicleID> </tns1:CarElement> </casePayload> </xml-fragment> |
Response | { "caseReference": "BDS-2-com.example.gddemo.Car-42-0" } |
Copyright © TIBCO Software Inc. All Rights Reserved.