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.

Status codes:

Code

Description
200

Success

Message Code Message text Parameters
SearchNotFound The requested saved search does not exist N/A

400

Input validation failure

Message Code Message text Parameters
BAD_JSON_FORMAT Bad JSON format: {0} 0 - "failed to parse request body"
BAD_MEDIA_TYPE Content-Type header is missing or has unsuitable value N/A
UNAUTHORIZED_DEVICE User has no permission for some of the devices in this request or some devices are not available N/A
403

Authentication failure

Message Code Message text Parameters
NO_PERMISSIONS There are no permissions to process the requested operation N/A
INVALID_SESSION_KEY The session key provided is invalid N/A
EXPIRED_SESSION_KEY The session key provided has expired N/A
BAD_COOKIE_HEADER Cookie header is missing or has non-expected value N/A
UNAUTHORIZED_DEVICE User has no permission for some of the devices in this request or some devices are not available N/A
50x

Internal Server Error

Message Code Message text Parameters
UNEXPECTED_ERROR_OCCURRED Unexpected error occurred N/A

Example Request:

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

Example Response:

Copy 
{
  "status": "Success",
  "messages": [
    {
      "code": "success",
      "message": "Success"
    }
  ],
  "data": {
    "savedSearchResults": [
      {
        "changeRequestId": 1
      },
      {
        "changeRequestId": 3
      },
      {
        "changeRequestId": 4
      },
      {
        "changeRequestId": 5
      },
      {
        "changeRequestId": 6
      }
    ],
    "resultsCount": 5
  }
}