Skip to main content

 

Planview Customer Success Center

Search Service

POST /search/unified

Description:

Search the application for entities by name or BN

Parameters (body)

  • searchString: (String) The Barometer Number or name of an entity.
  • maxResults: (Int) The maximum number of search results.
  • entityTypes: (JSON Object) An array of entity types that the query should be filtered by. This include Rule, Reports and Scorecards.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/json;charset=UTF-8
  • Content-Type: application/json;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/search/unified
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8

Body: {
  "searchString": "System 1",
  "maxResults": 5,
  "entityTypes": ["SYS"]
}

Response:

{
    "count": 132,
    "topHit": {
        "name": "System 1",
        "bn": "041800000MQM",
        "controlLevel": "EDITABLE",
        "entityType": "SYS"
    },
    "matches": [
        {
            "entityTypeCode": "SYS",
            "entityTypeResults": [
                {
                    "name": "System Release B Release 1",
                    "bn": "ZZ180000000Z",
                    "controlLevel": "EDITABLE",
                    "entityType": "SYS"
                },
                {
                    "name": "System Release C Release 1",
                    "bn": "ZZ1800000017",
                    "controlLevel": "EDITABLE",
                    "entityType": "SYS"
                },
                {
                    "name": "System Release D Release 1",
                    "bn": "ZZ180000001F",
                    "controlLevel": "EDITABLE",
                    "entityType": "SYS"
                },
                {
                    "name": "System Release E Release 1",
                    "bn": "ZZ180000001G",
                    "controlLevel": "EDITABLE",
                    "entityType": "SYS"
                }
            ]
        }
    ]
}