Перейти к содержанию

Структура

API методы для модуля orgschema

Метрики

Получение списка

GET /orgschema/api/kpi/list

Метод может быть использован для получения списка метрик.

curl 'https://{HOST}.platrum.ru/orgschema/api/kpi/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "is_gsd": true,
            "workers": [
                {
                    "id": 123,
                    "block_id": 123,
                    "user_id": "some_string",
                    "is_probation": true,
                    "is_primary": true,
                    "creation_date": "2019-01-01 21:00:15",
                    "deletion_date": "2019-01-01 21:00:15",
                    "is_deleted": true
                }
            ],
            "id": 123,
            "second_kpi_id": 123,
            "block_id": 123,
            "is_reverse": true,
            "name": "some_string",
            "description": "some_string",
            "interval_days": 123,
            "order": 123,
            "creation_date": "2019-01-01 21:00:15",
            "interval_count_for_averaging": 123
        },
        {
            "is_gsd": true,
            "workers": [
                {
                    "id": 123,
                    "block_id": 123,
                    "user_id": "some_string",
                    "is_probation": true,
                    "is_primary": true,
                    "creation_date": "2019-01-01 21:00:15",
                    "deletion_date": "2019-01-01 21:00:15",
                    "is_deleted": true
                }
            ],
            "id": 123,
            "second_kpi_id": 123,
            "block_id": 123,
            "is_reverse": true,
            "name": "some_string",
            "description": "some_string",
            "interval_days": 123,
            "order": 123,
            "creation_date": "2019-01-01 21:00:15",
            "interval_count_for_averaging": 123
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
is_gsd Является ли главной метрикой должности bool -
workers Сотрудники с текущей метрикой. При наличии доступа на просмотр всех метрик, вернутся все сотрудники работающие с этой метрикой. В случае отсутствия доступа, вернутся только подчинённые, если они имеются, либо пустой массив. array[worker] -
id ID int -
second_kpi_id ID второй метрики (для двойных метрик) int -
block_id ID отдела int -
is_reverse Является ли обратной bool -
name Название string -
description Описание string -
interval_days Период int 1/7
order Сортировка int -
creation_date Дата создания date -
interval_count_for_averaging Кол-во периодов для усреднения int -

Создание и обновление

GET /orgschema/api/kpi/save

Метод может быть использован как для сохранения изменений в существующей метрике, так и для создания новой. Параметры метрики передаются в теле запроса. Если передан пустой id, то создается новая метрика.

curl 'https://{HOST}.platrum.ru/orgschema/api/kpi/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"second_kpi_id":123,"block_id":123,"is_reverse":true,"name":"some_string","description":"some_string","interval_days":123,"order":123,"creation_date":"2019-01-01 21:00:15","interval_count_for_averaging":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID int -
second_kpi_id ID второй метрики (для двойных метрик) int -
block_id ID отдела int -
is_reverse Является ли обратной bool -
name Название string -
description Описание string -
interval_days Период int 1/7
order Сортировка int -
creation_date Дата создания date -
interval_count_for_averaging Кол-во периодов для усреднения int -

bool

Удаление

GET /orgschema/api/kpi/delete

Метод может быть использован для удаления метрик.

curl 'https://{HOST}.platrum.ru/orgschema/api/kpi/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"block_id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* Id метрики int -
block_id* Id блока, к которому относится метрика int -

bool

Сохранение значений

GET /orgschema/api/kpi/data/save

Метод может быть использован для сохранение значений и квоты.

curl 'https://{HOST}.platrum.ru/orgschema/api/kpi/data/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"kpi_id":123,"user_id":"some_string","end_period_date":"some_string","value":"some_string","quota":"some_string","is_default_quota":true}'

{
    "status": "success",
    "data": {
        "id": 123,
        "kpi_id": 123,
        "user_id": "some_string",
        "end_period_date": "some_string",
        "value": "some_string",
        "quota": "some_string",
        "creation_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
kpi_id Id метрики int -
user_id* Id пользователя string -
end_period_date Дата string -
value Значение string -
quota Значение квоты string -
is_default_quota Настройка квоты по умолчанию bool -
Параметр Описание Тип Значения
id ID int -
kpi_id int -
user_id string -
end_period_date string -
value string -
quota string -
creation_date date -

Блоки

Получение списка

GET /orgschema/api/block/list

Метод может быть использован для получения списка блоков структуры.

curl 'https://{HOST}.platrum.ru/orgschema/api/block/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "org_id": "some_string",
            "parent_id": 123,
            "number": "some_string",
            "name": "some_string",
            "position": "some_string",
            "color": "some_string",
            "is_hidden": true,
            "is_show_children_in_one_block": true,
            "color_chevron": "some_string",
            "order": 123,
            "creation_date": "2019-01-01 21:00:15"
        },
        {
            "id": 123,
            "org_id": "some_string",
            "parent_id": 123,
            "number": "some_string",
            "name": "some_string",
            "position": "some_string",
            "color": "some_string",
            "is_hidden": true,
            "is_show_children_in_one_block": true,
            "color_chevron": "some_string",
            "order": 123,
            "creation_date": "2019-01-01 21:00:15"
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
org_id ID настройки структуры string -
parent_id ID родителя int -
number Номер отдела string -
name Название отдела string -
position Название должности string -
color Цвет фона string -
is_hidden Видимость блока на структуре bool -
is_show_children_in_one_block Выводить дочерние отделы в едином блоке bool -
color_chevron Цвет блока string -
order Порядок сортировки int -
creation_date Дата создания date -

Создание и обновление

GET /orgschema/api/block/save

Метод может быть использован как для сохранения изменений в существующем блоке, так и для создания нового. Блок передается в теле запроса. Если передан пустой id, то создается новый блок.

curl 'https://{HOST}.platrum.ru/orgschema/api/block/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"org_id":"some_string","parent_id":123,"number":"some_string","name":"some_string","position":"some_string","color":"some_string","is_hidden":true,"is_show_children_in_one_block":true,"color_chevron":"some_string","order":123,"creation_date":"2019-01-01 21:00:15"}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID int -
org_id ID настройки структуры string -
parent_id ID родителя int -
number Номер отдела string -
name Название отдела string -
position Название должности string -
color Цвет фона string -
is_hidden Видимость блока на структуре bool -
is_show_children_in_one_block Выводить дочерние отделы в едином блоке bool -
color_chevron Цвет блока string -
order Порядок сортировки int -
creation_date Дата создания date -

bool

Удаление

GET /orgschema/api/block/delete

Метод может быть использован для удаления блоков.

curl 'https://{HOST}.platrum.ru/orgschema/api/block/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id Id блока int -

bool

Должности

Получение активного списка

GET /orgschema/api/worker/list-active

Метод позволяет получить список должностей, занимаемых сотрудниками.

curl 'https://{HOST}.platrum.ru/orgschema/api/worker/list-active' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "block_id": 123,
            "user_id": "some_string",
            "is_probation": true,
            "is_primary": true,
            "creation_date": "2019-01-01 21:00:15",
            "deletion_date": "2019-01-01 21:00:15",
            "is_deleted": true
        },
        {
            "id": 123,
            "block_id": 123,
            "user_id": "some_string",
            "is_probation": true,
            "is_primary": true,
            "creation_date": "2019-01-01 21:00:15",
            "deletion_date": "2019-01-01 21:00:15",
            "is_deleted": true
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
block_id ID отдела int -
user_id ID пользователя string -
is_probation Находится ли на испытательном сроке bool -
is_primary Является ли основной должностью bool -
creation_date Дата вступления в должность date -
deletion_date Дата снятия с должности date -
is_deleted Снят ли с должности bool -

Получение списка

GET /orgschema/api/worker/list

Метод позволяет получить список всех должностей сотрудников, в том числе и занимаемых ранее.

curl 'https://{HOST}.platrum.ru/orgschema/api/worker/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "block_id": 123,
            "user_id": "some_string",
            "is_probation": true,
            "is_primary": true,
            "creation_date": "2019-01-01 21:00:15",
            "deletion_date": "2019-01-01 21:00:15",
            "is_deleted": true
        },
        {
            "id": 123,
            "block_id": 123,
            "user_id": "some_string",
            "is_probation": true,
            "is_primary": true,
            "creation_date": "2019-01-01 21:00:15",
            "deletion_date": "2019-01-01 21:00:15",
            "is_deleted": true
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
block_id ID отдела int -
user_id ID пользователя string -
is_probation Находится ли на испытательном сроке bool -
is_primary Является ли основной должностью bool -
creation_date Дата вступления в должность date -
deletion_date Дата снятия с должности date -
is_deleted Снят ли с должности bool -

Создание и обновление

GET /orgschema/api/worker/save

Метод позволяет закрепить должность за работником или изменить существующую.

curl 'https://{HOST}.platrum.ru/orgschema/api/worker/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"block_id":123,"user_id":"some_string","is_probation":true,"is_primary":true,"creation_date":"2019-01-01 21:00:15","deletion_date":"2019-01-01 21:00:15","is_deleted":true}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID int -
block_id ID отдела int -
user_id ID пользователя string -
is_probation Находится ли на испытательном сроке bool -
is_primary Является ли основной должностью bool -
creation_date Дата вступления в должность date -
deletion_date Дата снятия с должности date -
is_deleted Снят ли с должности bool -

bool

Структура

Импорт

POST /orgschema/api/orgschema/import

Метод позволяет импортировать огрсхему.

curl 'https://{HOST}.platrum.ru/orgschema/api/orgschema/import' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"org":"array","block":"array"}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
org* Настройки структуры array -
block* Блоки структуры в виде плоского списка array -

bool

Экспорт

GET /orgschema/api/orgschema/export

Метод позволяет экспортировать огрсхему.

curl 'https://{HOST}.platrum.ru/orgschema/api/orgschema/export' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": {
        "org": "array",
        "block": "array"
    }
}

Без параметров.

Параметр Описание Тип Значения
org Настройки структуры array -
block Блоки структуры в виде плоского списка array -

Удаление

GET /orgschema/api/orgschema/delete

Метод позволяет удалить текущую структуру. Удалить можно только пустую структуру без работников. Перед удалением сохраняется текущая версия.

curl 'https://{HOST}.platrum.ru/orgschema/api/orgschema/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": true
}

Без параметров.

bool

Установка предыдущей версии

GET /orgschema/api/orgschema/install-version

Метод позволяет установить версии структуры. Перед изменением сохраняется текущая версия.

curl 'https://{HOST}.platrum.ru/orgschema/api/orgschema/install-version' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"version_id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
version_id ID версии структуры int -

bool

Получение списка версий

GET /orgschema/api/orgschema/list-versions

Метод позволяет получить список версий структуры за последние три дня.

curl 'https://{HOST}.platrum.ru/orgschema/api/orgschema/list-versions' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "date": "2019-01-01 21:00:15",
            "author_id": "some_string",
            "blocks": "array",
            "org": [
                {
                    "id": 123,
                    "name": "some_string",
                    "level": 123,
                    "probation_color": "some_string",
                    "level0": "map",
                    "level1": "map",
                    "level2": "map",
                    "level3": "map",
                    "level4": "map",
                    "level5": "map",
                    "level6": "map",
                    "creation_date": "2019-01-01 21:00:15",
                    "is_new_org": true
                }
            ],
            "block_fields": [
                {
                    "id": 123,
                    "is_show_under_block": true,
                    "is_show_name_at_content_level": true,
                    "data_type": "some_string",
                    "creation_date": "2019-01-01 21:00:15",
                    "update_date": "2019-01-01 21:00:15",
                    "key": "some_string",
                    "name": "some_string",
                    "order": 123,
                    "is_archived": true,
                    "is_system": true,
                    "is_default": true,
                    "author_id": "some_string",
                    "last_editor_id": "some_string"
                }
            ]
        },
        {
            "id": 123,
            "date": "2019-01-01 21:00:15",
            "author_id": "some_string",
            "blocks": "array",
            "org": [
                {
                    "id": 123,
                    "name": "some_string",
                    "level": 123,
                    "probation_color": "some_string",
                    "level0": "map",
                    "level1": "map",
                    "level2": "map",
                    "level3": "map",
                    "level4": "map",
                    "level5": "map",
                    "level6": "map",
                    "creation_date": "2019-01-01 21:00:15",
                    "is_new_org": true
                }
            ],
            "block_fields": [
                {
                    "id": 123,
                    "is_show_under_block": true,
                    "is_show_name_at_content_level": true,
                    "data_type": "some_string",
                    "creation_date": "2019-01-01 21:00:15",
                    "update_date": "2019-01-01 21:00:15",
                    "key": "some_string",
                    "name": "some_string",
                    "order": 123,
                    "is_archived": true,
                    "is_system": true,
                    "is_default": true,
                    "author_id": "some_string",
                    "last_editor_id": "some_string"
                }
            ]
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
date Дата создания date -
author_id ID автора string -
blocks Блоки array -
org Настройки array[orgschema.org] -
block_fields Доп. поля array[orgschema.block_field] -

Настройки структуры

Обновление

GET /orgschema/api/settings/save

Метод может быть использован как для сохранения изменений в текущих настройках структуры. Настройки передаются в теле запроса.

curl 'https://{HOST}.platrum.ru/orgschema/api/settings/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","level":123,"probation_color":"some_string","level0":"map","level1":"map","level2":"map","level3":"map","level4":"map","level5":"map","level6":"map","creation_date":"2019-01-01 21:00:15","is_new_org":true}'

{
    "status": "success",
    "data": {
        "id": 123,
        "name": "some_string",
        "level": 123,
        "probation_color": "some_string",
        "level0": "map",
        "level1": "map",
        "level2": "map",
        "level3": "map",
        "level4": "map",
        "level5": "map",
        "level6": "map",
        "creation_date": "2019-01-01 21:00:15",
        "is_new_org": true
    }
}
Параметр Описание Тип Значения
id ID int -
name string -
level int -
probation_color string -
level0 map -
level1 map -
level2 map -
level3 map -
level4 map -
level5 map -
level6 map -
creation_date date -
is_new_org bool -
Параметр Описание Тип Значения
id ID int -
name string -
level int -
probation_color string -
level0 map -
level1 map -
level2 map -
level3 map -
level4 map -
level5 map -
level6 map -
creation_date date -
is_new_org bool -

Получение

GET /orgschema/api/settings/get

Метод может быть использован для получения текущих настроек структуры.

curl 'https://{HOST}.platrum.ru/orgschema/api/settings/get' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": {
        "id": 123,
        "name": "some_string",
        "level": 123,
        "probation_color": "some_string",
        "level0": "map",
        "level1": "map",
        "level2": "map",
        "level3": "map",
        "level4": "map",
        "level5": "map",
        "level6": "map",
        "creation_date": "2019-01-01 21:00:15",
        "is_new_org": true
    }
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
name string -
level int -
probation_color string -
level0 map -
level1 map -
level2 map -
level3 map -
level4 map -
level5 map -
level6 map -
creation_date date -
is_new_org bool -

Дашборды

Получение списка

GET /orgschema/api/dashboard/list

Метод позволяет получить все доступные дашборды.

curl 'https://{HOST}.platrum.ru/orgschema/api/dashboard/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "user_ids_with_given_access": [
                "some_string",
                "some_string"
            ],
            "widgets": [
                {
                    "id": 123,
                    "dashboard_id": 123,
                    "kpi_id": 123,
                    "second_kpi_id": 123,
                    "user_id": "some_string",
                    "is_hide_left_bar": true,
                    "size_width": "some_string",
                    "size_height": "some_string",
                    "order": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "is_average_data": true
                }
            ],
            "column_count": 123,
            "id": 123,
            "name": "some_string",
            "owner_user_id": "some_string",
            "access": "array",
            "is_public": true,
            "widget_width": 123,
            "refresh_interval": 123,
            "order": 123,
            "creation_date": "2019-01-01 21:00:15",
            "system_id": "some_string"
        },
        {
            "user_ids_with_given_access": [
                "some_string",
                "some_string"
            ],
            "widgets": [
                {
                    "id": 123,
                    "dashboard_id": 123,
                    "kpi_id": 123,
                    "second_kpi_id": 123,
                    "user_id": "some_string",
                    "is_hide_left_bar": true,
                    "size_width": "some_string",
                    "size_height": "some_string",
                    "order": 123,
                    "creation_date": "2019-01-01 21:00:15",
                    "is_average_data": true
                }
            ],
            "column_count": 123,
            "id": 123,
            "name": "some_string",
            "owner_user_id": "some_string",
            "access": "array",
            "is_public": true,
            "widget_width": 123,
            "refresh_interval": 123,
            "order": 123,
            "creation_date": "2019-01-01 21:00:15",
            "system_id": "some_string"
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
user_ids_with_given_access Id пользователей, имеющих доступ к дашборду array[string] -
widgets Привязанные виджеты array[widget] -
column_count Количество колонок int -
id ID int -
name Название string -
owner_user_id Id владельца string -
access Доступы array -
is_public Статус публичности bool -
widget_width Ширина виджета int -
refresh_interval Интервал обновления int -
order Значение сортировки int -
creation_date Дата создания date -
system_id Системный id string -

Создание и обновление

GET /orgschema/api/dashboard/save

Метод может быть использован как для сохранения изменений в существующем дашборде, так и для создания нового. Дашборд передаётся в теле запроса.

curl 'https://{HOST}.platrum.ru/orgschema/api/dashboard/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","owner_user_id":"some_string","access":"array","is_public":true,"widget_width":123,"column_count":123,"refresh_interval":123,"order":123,"creation_date":"2019-01-01 21:00:15","system_id":"some_string"}'

{
    "status": "success",
    "data": {
        "id": 123,
        "name": "some_string",
        "owner_user_id": "some_string",
        "access": "array",
        "is_public": true,
        "widget_width": 123,
        "column_count": 123,
        "refresh_interval": 123,
        "order": 123,
        "creation_date": "2019-01-01 21:00:15",
        "system_id": "some_string"
    }
}
Параметр Описание Тип Значения
id ID int -
name Название string -
owner_user_id Id владельца string -
access Доступы array -
is_public Статус публичности bool -
widget_width Ширина виджета int -
column_count Количество колонок int -
refresh_interval Интервал обновления int -
order Значение сортировки int -
creation_date Дата создания date -
system_id Системный id string -
Параметр Описание Тип Значения
id ID int -
name Название string -
owner_user_id Id владельца string -
access Доступы array -
is_public Статус публичности bool -
widget_width Ширина виджета int -
column_count Количество колонок int -
refresh_interval Интервал обновления int -
order Значение сортировки int -
creation_date Дата создания date -
system_id Системный id string -

Удаление

GET /orgschema/api/dashboard/delete

Метод может быть использован для удаления дашборда. Также удаляет все связанные виджеты.

curl 'https://{HOST}.platrum.ru/orgschema/api/dashboard/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* Id дашборда int -

bool