GET /dynamic_search/saved_queries/{id}

Returns a single query with the specified ID. The caller must have access to the query.

Returns a single query with the specified ID. The caller must have access to the query.

Table 1. GET /dynamic_search/saved_queries/{id} resource details
MIME Type

application/json

Table 2. GET /dynamic_search/saved_queries/{id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

id

path

Required

String

text/plain

The ID of the query which is to be retrieved.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /dynamic_search/saved_queries/{id} response codes
HTTP Response Code Unique Code Description

200

A single query with the specified ID.

404

5004

No query was found with the provided ID.

422

1015

Please provide correct field constraints

Response Description

A single SavedQueryDTO corresponding to the given UUID.
  • 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


{
  "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"
        }
      }
    ]
  }
}