Skip to main content

API Reference: global-filter-lists


API Reference: global-filter-lists

Used to get the main filter components' lists

URL : /api/v1/global/filter-lists/

URL Parameters :

  • name=[string] : a valid data model name

Method : GET

Auth required : YES

Permissions required : None

Data constraints : None

Data example : None

Success Response

Code : 200 OK

Content example

Return a list for every filter component of the current data model. Each filter component is one of the parent data models that belongs to the main hierarchy.

{
  "expedition": [
    {
      "value": 1,
      "text": "DSEIS"
    }
  ],
  "site": [
    {
      "value": 41,
      "text": 1,
      "expedition_id": 1
    },
    {
      "value": 56,
      "text": 7,
      "expedition_id": 1
    }
  ],
  "hole": [
    {
      "value": 205,
      "text": "A",
      "site_id": 41
    },
    {
      "value": 220,
      "text": "B",
      "site_id": 41
    },
    {
      "value": 221,
      "text": "A",
      "site_id": 56
    },
    {
      "value": 228,
      "text": "C",
      "site_id": 41
    },
    {
      "value": 229,
      "text": "D",
      "site_id": 41
    }
  ]
}