GET /dynamic_search/schemas

Gets the list of all schemas available to the user.

Gets the list of all schemas available to the user.

Table 1. GET /dynamic_search/schemas resource details
MIME Type

application/json

Table 2. GET /dynamic_search/schemas request parameter details
Parameter Type Optionality Data Type MIME Type Description

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.

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.

Table 3. GET /dynamic_search/schemas response codes
HTTP Response Code Unique Code Description

200

A list of all schemas was retrieved.

Response Description

A list of SchemaDTOs describing the Schemas this user can use to build query requests.
  • name - String - The unique name of the data area represented by this schema.
  • description - String - A description of the schema.
  • sample_query - A legal sample query that returns data from this schema.

Response Sample


[
  {
    "description": "String",
    "name": "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"
          }
        }
      ]
    }
  }
]