Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Announcement: Try the Ask AI chatbot for answers to your technical questions about Juniper products and solutions.

close
external-header-nav
Documentation
Menu
License Guide
Quick Starts
Validated Designs
Home Documentation JSA Series Virtual Appliance REST API Version 17.0 References Dynamic_search Endpoints Dynamic_search Endpoints

REST API Version 17.0 References

keyboard_arrow_up
close
keyboard_arrow_left
REST API Version 17.0 References
Table of Contents Expand all
list Table of Contents
file_download PDF
{ "lLangCode": "en", "lName": "English", "lCountryCode": "us", "transcode": "en_US" }
English
ON THIS PAGE
keyboard_arrow_right

POST /dynamic_search/saved_queries

date_range 24-May-22
arrow_backward
arrow_forward

SUMMARY Creates a query to be saved for use in dynamic searches. A query represents a request for data. Queries are not the same as searches, which are the results of a request for data. The benefit of saving a query is that it may be referenced in dynamic searches and can be reused.

Creates a query to be saved for use in dynamic searches. A query represents a request for data. Queries are not the same as searches, which are the results of a request for data. The benefit of saving a query is that it may be referenced in dynamic searches and can be reused.

Table 1: POST /dynamic_search/saved_queries resource details:

POST /dynamic_search/saved_queries resource details

MIME Type

application/json

Table 2: POST /dynamic_search/saved_queries request body details:

POST /dynamic_search/saved_queries request body details

Parameter Data Type MIME Type Description Sample

query

Object

application/json

The query to save.

{ "name": "sampleQuery", "query": "Please see the query example above" }

Table 3: POST /dynamic_search/saved_queries response codes:

POST /dynamic_search/saved_queries response codes

HTTP Response Code Unique Code Description

201

The query object created by the request.

409

5000

Caller has reached the maximum number of queries.

422

5002

The query must have a valid name.

422

1001

Error processing a supplied Field object (or one of its sub-objects).

422

1002

Error processing a supplied Filter object (or one of its sub-objects)

422

1003

Error processing a supplied Function object (or one of its sub-objects).

422

1004

Error processing a supplied Operator object (or one of its sub-objects).

422

1005

Error processing a supplied Range object (or one of its sub-objects).

422

1006

Error processing a supplied Sort object (or one of its sub-objects).

422

1007

Error combining elements of the Query object.

422

1012

A range was specified, but no sort provided

Response Description

The JSON representation of the query created by the request
  • id - String - A UUID to serve as a unique identifier for the query. This field is read-only.
  • query - String - The JSON representation of the query. This field is required.
  • name - String - A descriptive name for the query to make it easier to recall. This field is required.
  • creation_time - Long - The time in milliseconds since epoch that this query was created. This field is read-only.

Response Sample

content_copy zoom_out_map
{
  "name": "sampleQuery",
  "id":"b0ace98d-0172-4830-997d-40498ade00e3",
  "creation_time": 1583437712766,
  "query": {
    "fields": [
      {
        "argument_fields": [
          {
            "contextual_type": "String",
            "data_type": "String",
            "localized_name": "String",
            "semantic_type": "String"
          }
        ],
        "contextual_type": "String",
        "data_type": "String",
        "filter": {
          "argument": "Object",
          "left_filter": {
            "argument": "Object",
            "left_filter": {
              "argument": "Object",
              "operator": {
                "connective": "String <one of: AND, OR, NOT>",
                "data_type": "String",
                "localized_name": "String",
                "name": "String"
              },
              "parameter": "String"
            },
            "operator": {
              "connective": "String <one of: AND, OR, NOT>",
              "data_type": "String",
              "localized_name": "String",
              "name": "String"
            },
            "parameter": "String",
            "right_filter": {
              "argument": "Object",
              "operator": {
                "connective": "String <one of: AND, OR, NOT>",
                "data_type": "String",
                "localized_name": "String",
                "name": "String"
              },
              "parameter": "String"
            }
          },
          "operator": {
            "connective": "String <one of: AND, OR, NOT>",
            "data_type": "String",
            "localized_name": "String",
            "name": "String"
          },
          "parameter": "String",
          "right_filter": {
            "argument": "Object",
            "left_filter": {
              "argument": "Object",
              "operator": {
                "connective": "String <one of: AND, OR, NOT>",
                "data_type": "String",
                "localized_name": "String",
                "name": "String"
              },
              "parameter": "String"
            },
            "operator": {
              "connective": "String <one of: AND, OR, NOT>",
              "data_type": "String",
              "localized_name": "String",
              "name": "String"
            },
            "parameter": "String",
            "right_filter": {
              "argument": "Object",
              "operator": {
                "connective": "String <one of: AND, OR, NOT>",
                "data_type": "String",
                "localized_name": "String",
                "name": "String"
              },
              "parameter": "String"
            }
          }
        },
        "function": {
          "aggregate": true,
          "argument_types": [
            {
              "position": 42,
              "type": "String"
            }
          ],
          "localized_name": "String",
          "name": "String",
          "return_data_type": "String"
        },
        "localized_name": "String",
        "semantic_type": "String"
      }
    ],
    "filters": [
      {
        "argument": {
          "argument_fields": [
            {
              "contextual_type": "String",
              "data_type": "String",
              "localized_name": "String",
              "semantic_type": "String"
            }
          ],
          "contextual_type": "String",
          "data_type": "String",
          "filter": "Object",
          "function": {
            "aggregate": true,
            "argument_types": [
              {
                "position": 42,
                "type": "String"
              }
            ],
            "localized_name": "String",
            "name": "String",
            "return_data_type": "String"
          },
          "localized_name": "String",
          "semantic_type": "String"
        },
        "left_filter": {
          "argument": {
            "argument_fields": [
              {
                "contextual_type": "String",
                "data_type": "String",
                "localized_name": "String",
                "semantic_type": "String"
              }
            ],
            "contextual_type": "String",
            "data_type": "String",
            "filter": "Object",
            "function": {
              "aggregate": true,
              "argument_types": [
                {
                  "position": 42,
                  "type": "String"
                }
              ],
              "localized_name": "String",
              "name": "String",
              "return_data_type": "String"
            },
            "localized_name": "String",
            "semantic_type": "String"
          },
          "left_filter": {
            "argument": {
              "argument_fields": [
                {
                  "contextual_type": "String",
                  "data_type": "String",
                  "localized_name": "String",
                  "semantic_type": "String"
                }
              ],
              "contextual_type": "String",
              "data_type": "String",
              "filter": "Object",
              "function": {
                "aggregate": true,
                "argument_types": [
                  {
                    "position": 42,
                    "type": "String"
                  }
                ],
                "localized_name": "String",
                "name": "String",
                "return_data_type": "String"
              },
              "localized_name": "String",
              "semantic_type": "String"
            },
            "operator": {
              "connective": "String <one of: AND, OR, NOT>",
              "data_type": "String",
              "localized_name": "String",
              "name": "String"
            },
            "parameter": "String"
          },
          "operator": {
            "connective": "String <one of: AND, OR, NOT>",
            "data_type": "String",
            "localized_name": "String",
            "name": "String"
          },
          "parameter": "String",
          "right_filter": {
            "argument": {
              "argument_fields": [
                {
                  "contextual_type": "String",
                  "data_type": "String",
                  "localized_name": "String",
                  "semantic_type": "String"
                }
              ],
              "contextual_type": "String",
              "data_type": "String",
              "filter": "Object",
              "function": {
                "aggregate": true,
                "argument_types": [
                  {
                    "position": 42,
                    "type": "String"
                  }
                ],
                "localized_name": "String",
                "name": "String",
                "return_data_type": "String"
              },
              "localized_name": "String",
              "semantic_type": "String"
            },
            "operator": {
              "connective": "String <one of: AND, OR, NOT>",
              "data_type": "String",
              "localized_name": "String",
              "name": "String"
            },
            "parameter": "String"
          }
        },
        "operator": {
          "connective": "String <one of: AND, OR, NOT>",
          "data_type": "String",
          "localized_name": "String",
          "name": "String"
        },
        "parameter": "String",
        "right_filter": {
          "argument": {
            "argument_fields": [
              {
                "contextual_type": "String",
                "data_type": "String",
                "localized_name": "String",
                "semantic_type": "String"
              }
            ],
            "contextual_type": "String",
            "data_type": "String",
            "filter": "Object",
            "function": {
              "aggregate": true,
              "argument_types": [
                {
                  "position": 42,
                  "type": "String"
                }
              ],
              "localized_name": "String",
              "name": "String",
              "return_data_type": "String"
            },
            "localized_name": "String",
            "semantic_type": "String"
          },
          "left_filter": {
            "argument": {
              "argument_fields": [
                {
                  "contextual_type": "String",
                  "data_type": "String",
                  "localized_name": "String",
                  "semantic_type": "String"
                }
              ],
              "contextual_type": "String",
              "data_type": "String",
              "filter": "Object",
              "function": {
                "aggregate": true,
                "argument_types": [
                  {
                    "position": 42,
                    "type": "String"
                  }
                ],
                "localized_name": "String",
                "name": "String",
                "return_data_type": "String"
              },
              "localized_name": "String",
              "semantic_type": "String"
            },
            "operator": {
              "connective": "String <one of: AND, OR, NOT>",
              "data_type": "String",
              "localized_name": "String",
              "name": "String"
            },
            "parameter": "String"
          },
          "operator": {
            "connective": "String <one of: AND, OR, NOT>",
            "data_type": "String",
            "localized_name": "String",
            "name": "String"
          },
          "parameter": "String",
          "right_filter": {
            "argument": {
              "argument_fields": [
                {
                  "contextual_type": "String",
                  "data_type": "String",
                  "localized_name": "String",
                  "semantic_type": "String"
                }
              ],
              "contextual_type": "String",
              "data_type": "String",
              "filter": "Object",
              "function": {
                "aggregate": true,
                "argument_types": [
                  {
                    "position": 42,
                    "type": "String"
                  }
                ],
                "localized_name": "String",
                "name": "String",
                "return_data_type": "String"
              },
              "localized_name": "String",
              "semantic_type": "String"
            },
            "operator": {
              "connective": "String <one of: AND, OR, NOT>",
              "data_type": "String",
              "localized_name": "String",
              "name": "String"
            },
            "parameter": "String"
          }
        }
      }
    ],
    "range": {
      "limit": 42,
      "offset": 42
    },
    "sorts": [
      {
        "direction": "String",
        "field": {
          "argument_fields": [
            {
              "contextual_type": "String",
              "data_type": "String",
              "localized_name": "String",
              "semantic_type": "String"
            }
          ],
          "contextual_type": "String",
          "data_type": "String",
          "filter": {
            "argument": "Object",
            "left_filter": {
              "argument": "Object",
              "left_filter": {
                "argument": "Object",
                "operator": {
                  "connective": "String <one of: AND, OR, NOT>",
                  "data_type": "String",
                  "localized_name": "String",
                  "name": "String"
                },
                "parameter": "String"
              },
              "operator": {
                "connective": "String <one of: AND, OR, NOT>",
                "data_type": "String",
                "localized_name": "String",
                "name": "String"
              },
              "parameter": "String",
              "right_filter": {
                "argument": "Object",
                "operator": {
                  "connective": "String <one of: AND, OR, NOT>",
                  "data_type": "String",
                  "localized_name": "String",
                  "name": "String"
                },
                "parameter": "String"
              }
            },
            "operator": {
              "connective": "String <one of: AND, OR, NOT>",
              "data_type": "String",
              "localized_name": "String",
              "name": "String"
            },
            "parameter": "String",
            "right_filter": {
              "argument": "Object",
              "left_filter": {
                "argument": "Object",
                "operator": {
                  "connective": "String <one of: AND, OR, NOT>",
                  "data_type": "String",
                  "localized_name": "String",
                  "name": "String"
                },
                "parameter": "String"
              },
              "operator": {
                "connective": "String <one of: AND, OR, NOT>",
                "data_type": "String",
                "localized_name": "String",
                "name": "String"
              },
              "parameter": "String",
              "right_filter": {
                "argument": "Object",
                "operator": {
                  "connective": "String <one of: AND, OR, NOT>",
                  "data_type": "String",
                  "localized_name": "String",
                  "name": "String"
                },
                "parameter": "String"
              }
            }
          },
          "function": {
            "aggregate": true,
            "argument_types": [
              {
                "position": 42,
                "type": "String"
              }
            ],
            "localized_name": "String",
            "name": "String",
            "return_data_type": "String"
          },
          "localized_name": "String",
          "semantic_type": "String"
        }
      }
    ]
  }
}
arrow_backward PREVIOUS GET /dynamic_search/saved_queries
NEXT arrow_forward DELETE /dynamic_search/saved_queries/{id}
external-footer-nav