GET /settings/periods

GET 
/settings/periods

GET /settings/periods

Request

Query Parameters

type string[]
date_from string

Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31]. Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31].

date_to string

Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31]. Custom date range syntax. Equal: 2020-01-01; From: [2020-01-01;]; To: [;2025-12-31]; Between: [2020-01-01;2025-12-31].

from int32
take int32
search string
sort string[]

Responses

200

OK

text/plain

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64

uid uuid

type stringnullable

name stringnullable

date_from date

date_to date

is_locked boolean

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "name": "string",
      "date_from": "2024-07-29",
      "date_to": "2024-07-29",
      "is_locked": true
    }
  ],
  "aggregations": [
    null
  ]
}

application/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64

uid uuid

type stringnullable

name stringnullable

date_from date

date_to date

is_locked boolean

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "name": "string",
      "date_from": "2024-07-29",
      "date_to": "2024-07-29",
      "is_locked": true
    }
  ],
  "aggregations": [
    null
  ]
}

text/json

Schema

Schema

total int64nullable
from int64nullable
take int64nullable

entities

object[]

nullable

Array [

id int64

uid uuid

type stringnullable

name stringnullable

date_from date

date_to date

is_locked boolean

]

aggregations undefined[]nullable

Example (from schema)

{
  "total": 0,
  "from": 0,
  "take": 0,
  "entities": [
    {
      "id": 0,
      "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "name": "string",
      "date_from": "2024-07-29",
      "date_to": "2024-07-29",
      "is_locked": true
    }
  ],
  "aggregations": [
    null
  ]
}

Loading...