Run an advanced search

The savedsearch method allows you to run an advanced search that is currently saved in FireFlow by specifying the name of the search.

Resource Name: /FireFlow/api/savedsearch

Request Method: GET

Header requirements:

Key Value
Cookie FireFlow_Session=[sessionID]. The sessionId is retrieved from the authentication request.
Request Query Parameters:

Parameter

Type

Description
savedSearchName

String

The name of the saved search you want to run.

Note: There is no requirement to name saved searches uniquely. If more than one saved search with the specified name exists, the first one will be returned.
Response:

Element

Type

Description
status

String

One of the following:

    Success
    Failure
messages

Object containing the code and the message.

Strings that indicate whether the request succeeded or failed.
data

Object containing the savedSearchResults and the resultsCount.

See below.
savedSearchResults

A list of changeRequestId

The change request IDs returned for the search.
resultsCount

Integer

The number of search results.

Example Request:

https://192.168.11.40/FireFlow/api/savedsearch?savedSearchName=Show-results

Example Response:

{

"status": "Success",

"messages": [

{

"code": "success",

"message": "Success"

}

],

"data": {

"savedSearchResults": [

{

"changeRequestId": 1

},

{

"changeRequestId": 3

},

{

"changeRequestId": 4

},

{

"changeRequestId": 5

},

{

"changeRequestId": 6

}

],

"resultsCount": 5

}

}