OPTIONS dynamic_search

Returns the available options for this resource.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

DynamicSearchOptionsViewModel
NameDescriptionTypeAdditional information
LogicalOperators

The different logical operators supported by the dynamic search.

Collection of DynamicSearchLogicalOperatorViewModel

None.

SourceTypes

The different source types supported by the dynamic search.

Collection of DynamicSearchSourceTypeViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "logicalOperators": [
    {
      "name": "And",
      "displayName": "AND",
      "position": 1
    },
    {
      "name": "Or",
      "displayName": "OR",
      "position": 2
    }
  ],
  "sourceTypes": [
    {
      "name": "Objects",
      "displayName": "Objects",
      "position": 1,
      "sourceFields": [
        {
          "name": "ObjectType",
          "displayName": "Type",
          "position": 1,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            },
            {
              "name": "NotEquals",
              "displayName": "!=",
              "position": 2,
              "typeaheadUrl": ""
            }
          ]
        },
        {
          "name": "ObjectId",
          "displayName": "Object Id",
          "position": 2,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            },
            {
              "name": "NotEquals",
              "displayName": "!=",
              "position": 2,
              "typeaheadUrl": ""
            },
            {
              "name": "Greater",
              "displayName": ">",
              "position": 4,
              "typeaheadUrl": ""
            },
            {
              "name": "Less",
              "displayName": "<",
              "position": 5,
              "typeaheadUrl": ""
            },
            {
              "name": "GreaterEqual",
              "displayName": ">=",
              "position": 6,
              "typeaheadUrl": ""
            },
            {
              "name": "LessEqual",
              "displayName": "<=",
              "position": 7,
              "typeaheadUrl": ""
            }
          ]
        },
        {
          "name": "SubjectId",
          "displayName": "Subject Id",
          "position": 3,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            },
            {
              "name": "NotEquals",
              "displayName": "!=",
              "position": 2,
              "typeaheadUrl": ""
            },
            {
              "name": "Contains",
              "displayName": "Contains",
              "position": 3,
              "typeaheadUrl": ""
            }
          ]
        },
        {
          "name": "AnatomicalRegion",
          "displayName": "Anatomical Region",
          "position": 4,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            }
          ]
        }
      ]
    },
    {
      "name": "RelatedObjects",
      "displayName": "Related Objects",
      "position": 2,
      "sourceFields": [
        {
          "name": "ObjectType",
          "displayName": "Type",
          "position": 1,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            },
            {
              "name": "NotEquals",
              "displayName": "!=",
              "position": 2,
              "typeaheadUrl": ""
            }
          ]
        },
        {
          "name": "ObjectId",
          "displayName": "Object Id",
          "position": 2,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            },
            {
              "name": "NotEquals",
              "displayName": "!=",
              "position": 2,
              "typeaheadUrl": ""
            },
            {
              "name": "Greater",
              "displayName": ">",
              "position": 4,
              "typeaheadUrl": ""
            },
            {
              "name": "Less",
              "displayName": "<",
              "position": 5,
              "typeaheadUrl": ""
            },
            {
              "name": "GreaterEqual",
              "displayName": ">=",
              "position": 6,
              "typeaheadUrl": ""
            },
            {
              "name": "LessEqual",
              "displayName": "<=",
              "position": 7,
              "typeaheadUrl": ""
            }
          ]
        },
        {
          "name": "SubjectId",
          "displayName": "Subject Id",
          "position": 3,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            },
            {
              "name": "NotEquals",
              "displayName": "!=",
              "position": 2,
              "typeaheadUrl": ""
            },
            {
              "name": "Contains",
              "displayName": "Contains",
              "position": 3,
              "typeaheadUrl": ""
            }
          ]
        },
        {
          "name": "AnatomicalRegion",
          "displayName": "Anatomical Region",
          "position": 4,
          "comparisonOperators": [
            {
              "name": "Equals",
              "displayName": "=",
              "position": 1,
              "typeaheadUrl": ""
            }
          ]
        }
      ]
    }
  ]
}