REST API - executeQuery

The table summarizes the REST API - executeQuery.

Request

Format
GET <baseurl>/resourcequery/<modelversion>
Path parameters modelversion: Used to restrict the organization model entities (organization units, positions, groups, etc.) that are considered in the evaluation of the query. Can be obtained from listModelVersions .
Query parameters
  • query=string (required): Must conform to Resource Query Language (RQL) syntax rules. See Appendix D - Resource Query Language of the TIBCO Business Studio BPM Implementation guide.
  • singleresult=false (optional, default=false): Pass "true" to get one resource, chosen at random from the query result.

Response

JSON Returns a JSON representation of the content of the executeQueryResponse element.
XML Returns the content of the executeQueryResponse element (from the ResourceQueryService schema).

Example

Request
GET <baseurl>/resourcequery/-1?query=position%28name%3d%27Tester%27%29
Response
{

       "xml-fragment":

       {

           "resource":

           [

               {

                   "@guid": "tibco-admin",

                   "@name": "tibco-admin",

                   "@push-enabled": "false"

               },

               {

                   "@guid": "AF8224B6-FF4F-435D-8D58-DD81100766CD",

                   "@name": "Mr Clint Hill",

                   "@push-enabled": "false"

               }

           ]

       }

}