SOAP API - navigateCase

The table summarizes the SOAP API - navigateCase.

Request Uses the NavigateCaseRequest element (from the BusinessDataServices schema)
Parameter notes
  • sourceCaseReference. The case reference of case data that has data associated with it. For example, a customer. You must specify only one source case reference.
  • targetRoleName: The name of the association that was specified when the association was created using linkCase. For example, orders.
  • queryOptions. Specifies the pagination options.
    • startPosition (optional). The position in the list of case references from which to start the page of results. The list is zero-based. To start at the first item, specify 0.
    • maxResults (optional). The number of items to include.
Response Returns a NavigateCaseResponse element (from the BusinessDataServices schema)
Example Request: 
<soapenv:Body>
<api:NavigateCaseRequest>
<sourceCaseReference>BDS-2-com.example.gddemo.Customer-5-0
</sourceCaseReference>
<targetRoleName>cars</targetRoleName>
</api:NavigateCaseRequest>
</soapenv:Body>
Response: 
<SOAP-ENV:Body>
<NavigateCaseResponse xmlns="http://api.bds.tibco.com">
<caseReference
xmlns="">BDS-2-com.example.gddemo.Car-8-1</caseReference>
<caseReference
xmlns="">BDS-2-com.example.gddemo.Car-10-1</caseReference>
</NavigateCaseResponse>
</SOAP-ENV:Body>