SOAP API - navigateCaseByCriteria

The table summarizes the SOAP API - navigateCaseByCriteria.

Request Uses the NavigateCaseByCriteriaRequestelement (from the BusinessDataServices schema)
Parameter notes
  • sourceCaseReference. The case reference of the case data you want to navigate from. For example, BDS-2-com.example.gddemo.Customer-1-1. You must only specify one source case reference.
  • targetRoleName. The name of the association that was specified when the association was created using linkCase . For example, cars.
  • queryString. This contains the specified criteria that the case data must match. For information about criteria syntax, see "Case Data Query Language (DQL)" in the TIBCO® BPM Enterprise Case Data User Guide.
  • namedParameterAssignment (optional). You can assign a name to a condition when defining your dataview. This allows you to specify different values when using getCaseReferencesForDataView to search case data.
    • name. The name of the parameter.
    • value. The value of the parameter.
  • paginationOptions. 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 NavigateCaseByCriteriaResponseelement (from the BusinessDataServices schema)
Example Request:
<soapenv:Body>
  <api:NavigateCaseByCriteriaRequest>
    <sourceCaseReference>
      BDS-2-com.example.gddemo.Customer-12-0</sourceCaseReference>
      <targetRoleName>cars</targetRoleName>
      <targetCaseCriteria>
        <queryString>
          engine.model = :engineModel or model =
          :model
        </queryString>
        <namedParameterAssignment>
          <name>engineModel</name>
          <value>3%</value>
        </namedParameterAssignment>
        <namedParameterAssignment>
          <name>model</name>
          <value>VW</value>
        </namedParameterAssignment>
        <paginationOptions>
          <maxResults>5</maxResults>
        </paginationOptions>
      </targetCaseCriteria>
    </api:NavigateCaseByCriteriaRequest>
</soapenv:Body>
Response:
<SOAP-ENV:Body>
  <NavigateCaseByCriteriaResponse xmlns="http://api.bds.tibco.com">
    <caseReference
    xmlns="">BDS-2-com.example.gddemo.Car-17-1</caseReference>
    <caseReference
    xmlns="">BDS-2-com.example.gddemo.Car-19-1</caseReference>
    <hasMoreResults xmlns="">false</hasMoreResults>
  </NavigateCaseByCriteriaResponse>
</SOAP-ENV:Body>