Create/Update multiple Time Profile items by link_id

Create or Update multiple Time Profile items.

This request is used by Link management system. Link adds to each time profile link_id.

They can be added to multiple panels and removed by link_id param using POST /access/timeprofile/link/delete

application/json

Request Body required

• list_items object[]

  list of time profiles

• 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 required

  is filtering available

  is_filtered boolean required

  is filter applied

  available_fields object[] required

  list of available fields to filter by

  field_name string required

  data_type string required

  Possible values: [string, integer, timestamp]

  options object

  anyOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  available_values object[]

  Possible values: >= 1

  This model provide filter available values

  available_range integer[]

  Possible values: >= 2, <= 2

  This model provide filter integer range

  available_values_localized string[]

  the field is used only for UI localization and is not a filter value.

  has_date boolean

  Default value: false

  true - has date, false - doesn't

  has_time boolean

  Default value: false

  true - has time, false - doesn't

  has_milliseconds boolean

  Default value: false

  true - has milliseconds, false - doesn't

  sort object

  sort options that can be applied to time profiles

  is_sorted boolean required

  Direction of sorting

  order string

  Possible values: [asc, desc]

  sorting order, asc - ascending, desc - descending

  available_fields string[] required

  Possible values: [name, date_from, date_to]

  Available for sorting fields names

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• result object[]

  resulting array of ids

  link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

  success boolean

  status of operation

  extended_info string

  Possible values: [created, updated, deleted, entity_not_found, number_taken_by_another_identifier, bound_time_profile_doesnt_exist, face_id_not_supported, number_of_face_identifiers_exceeded, number_of_identifiers_exceeded]

  Entity state information result

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

Wrong repeat options

application/json

• Schema
• Example (from schema)
• Wrong repeat_type
• Wrong format
• Wrong repeat_point_type
• Wrong repeat_options
• Wrong repeat_looper range
• Wrong Week Options
• Wrong year range
• Wrong Year Options
• Wrong Day Of Month
• Wrong months range
• Wrong day Numbers

---

Schema

• error string

  Possible values: [Wrong repeat_type, Wrong format enum name, Wrong repeat_point_type enum name, Wrong repeat_options enum name, Wrong repeat_looper range, Set in WeekOptions can't be empty, Wrong year range, Set in YearOptions can't be empty, Wrong DayOfMonth range, Wrong months range, Set in dayNumbers can't be empty, Wrong Time Profile Uid]

  error type/info

{
  "error": true
}

{
  "error": "Wrong repeat_type"
}

{
  "error": "Wrong format enum name"
}

{
  "error": "Wrong repeat_point_type enum name"
}

{
  "error": "Wrong repeat_options enum name"
}

{
  "error": "Wrong repeat_looper range"
}

{
  "error": "Set in WeekOptions can't be empty"
}

{
  "error": "Wrong year range"
}

{
  "error": "Set in YearOptions can't be empty"
}

{
  "error": "Wrong DayOfMonth range"
}

{
  "error": "Wrong months range"
}

{
  "error": "Set in dayNumbers can't be empty"
}

Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...