GET /dynamic_search/searches/{handle}/results

Gets the specific search performed by this user.

Gets the specific search performed by this user.

Table 1. GET /dynamic_search/searches/{handle}/results resource details
MIME Type

application/json

Table 2. GET /dynamic_search/searches/{handle}/results request parameter details
Parameter Type Optionality Data Type MIME Type Description

handle

path

Required

String

text/plain

null

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.

Table 3. GET /dynamic_search/searches/{handle}/results response codes
HTTP Response Code Unique Code Description

200

A list of searches that the user has made.

403

1090

null

404

1024

No search was found with the provided handle

404

1080

null

422

1150

null

500

1099

null

500

2010

null

Response Description

A List of ResultRowDTOs, with a column structure that matches the one described in the corresponding ResultHeader object
  • columns - Contains a map of columns and their values, both as strings.

Response Sample


[
	{
	  "description": "String",
	  "handle": "String",
	  "header": {
	    "columns": [
	      {
	        "column_name": "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"
	        }
	      }
	    ]
	  },
	  "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"
	        }
	      }
	    ]
	  },
	  "retention": {
	    "creation_date": 42,
	    "expires_at": 42,
	    "last_accessed_date": 42,
	    "retain_duration": 42
	  },
	  "search_type": "String <one of: SYNCH, ASYNCH>",
	  "status": "String <one of: DONE, ERROR, QUEUED>"
	}
]