Get multiple Time Profile items with link_id

Get multiple Time Profile items with link_id.

This can be used by 3d-patry management system. Link adds to each time profile link_id.

Query Parameters

limit integer required
Possible values: [10, 20, 30, 50]
Default value: 10
Number of items. Value by default is 10
page_number integer required
Possible values: >= 1
Default value: 1
Page number
order_by string
sorting expression:

[field name 1], [field name 2]... <order (asc or desc)>

filter string

Filtering expression:

[field name] [compare operator] [value] <logical operator>...


field name	see the list of available fields in `filter.available_fields[].field_name`
value	see the list of available values in `filter.available_fields[].options object`, may be missing
compare operator	see the list of available operators in `filter.available_fields[].compare_operators array`

Compare operators	Description	Example
eq	Equal	name eq 'Sherlock Holmes'
gt	Greater than	building gt 10
lt	Less than	building lt 10
nq	Not equal	name nq 'Sherlock Holmes'
ge	Greater than or equal	floor ge 5
le	Less than or equal	floor le 5
Logical operators
and	logical AND	floor le 10 and floor gt 3
or	logical OR	floor le 3 or floor gt 10
not	logical NOT	not floor le 3
group operations
()	group by priority	(name eq 'Sherlock Holmes' or building eq 221) and floor gt 10

Responses

application/json

Schema
Example (from schema)
Example

Schema

list_items object[]
list_options object
Available options for sorting, filtering and pagination of lists
pagination object
Available pagination options for tables
total_items integer
The total number of items found and reflected across all pages
items_limit integer
Possible values: [10, 25, 50]
Limiting the display of the amount of data for one page
total_pages integer
Possible values: >= 1
The number of pages that hold the requested data
current_page integer
Possible values: >= 1
Current page number
filter object
Available fields
field name compare operators type values
name eq, nq string
date_from eq, nq, lt, gt, ge, le timestamp
date_to eq, nq, lt, gt, ge, le timestamp
available_filtering boolean
is_filtered boolean
available_fields object[]
field_name string
compare_operators string[]
Possible values: [eq, gt, lt, nq, ge, le]
data_type string
Possible values: [string, integer, timestamp]
options object
anyOf
MOD1
MOD2
MOD3
MOD4
available_values string,integer[]
Possible values: >= 1
This model provide filter available values
sort object
is_sorted boolean
Direction of sorting
order string
Possible values: [asc, desc]
available_fields string[]
Possible values: [name, date_from, date_to]
Available for sorting fields names

field name	compare operators	type
name	eq, nq	string
date_from	eq, nq, lt, gt, ge, le	timestamp
date_to	eq, nq, lt, gt, ge, le	timestamp

{
  "list_items": [
    {
      "name": "Work week",
      "time_options": {
        "is_all_day": true,
        "date_from": 1540819272,
        "date_to": 1540819272
      },
      "repeat_options": {
        "repeat_enable": true,
        "repeat_format": {
          "repeat_type": "day",
          "repeat_end": {
            "format": "date",
            "date": 1540819272
          },
          "repeat_custom": {
            "repeat_point_type": "week",
            "repeat_looper": 5,
            "repeat_options": [
              "MON",
              "TUE",
              "WED",
              "THU",
              "FRI"
            ]
          }
        }
      },
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5"
    }
  ],
  "list_options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "category",
          "compare_operators": [
            "eq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "any string"
            ]
          }
        }
      ]
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "name"
      ]
    }
  }
}

{
  "list_items": [
    {
      "name": "Work week",
      "time_options": {
        "is_all_day": true,
        "date_from": 1540819272,
        "date_to": 1540819272
      },
      "repeat_options": {
        "repeat_enable": true,
        "repeat_format": {
          "repeat_type": "day",
          "repeat_end": {
            "format": "date",
            "date": 1540819272
          },
          "repeat_custom": {
            "repeat_point_type": "week",
            "repeat_looper": 5,
            "repeat_options": [
              "MON",
              "TUE",
              "WED",
              "THU",
              "FRI"
            ]
          }
        }
      },
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5"
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "name",
          "compare_operators": [
            "eq"
          ],
          "data_type": "string",
          "options": {}
        }
      ]
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "name",
        "date_from",
        "date_to"
      ]
    }
  }
}

Unauthorized

application/json

Schema
Example (from schema)
Example

Schema

error string

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Get multiple Time Profile items with link_id​

sorting expression:

Filtering expression:

Available fields​

Get multiple Time Profile items with link_id

Available fields