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

Оргсхема

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

KPI

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

GET /orgschema/api/kpi/list

Метод позволяет получить KPI всех или нескольких должностей.

curl 'https://{HOST}.platrum.ru/orgschema/api/kpi/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"block_id":[123,123]}'
{
    "status": "success",
    "data": [
        {
            "id": 123,
            "second_kpi_id": 123,
            "block_id": 123,
            "is_gsd": true,
            "is_reverse": true,
            "name": "some_string",
            "description": "some_string",
            "interval_days": 123,
            "order": 123,
            "creation_date": "2019-01-01 21:00:15"
        },
        {
            "id": 123,
            "second_kpi_id": 123,
            "block_id": 123,
            "is_gsd": true,
            "is_reverse": true,
            "name": "some_string",
            "description": "some_string",
            "interval_days": 123,
            "order": 123,
            "creation_date": "2019-01-01 21:00:15"
        }
    ]
}
Параметр Описание Тип Значения
block_id ID блоков array[int] -
Параметр Описание Тип Значения
id ID int -
second_kpi_id ID второй статистики (для двойных статистик) int -
block_id ID отдела int -
is_gsd Является ли главной статистикой должности bool -
is_reverse Является ли обратной bool -
name Название string -
description Описание string -
interval_days Период int 1/7
order Сортировка int -
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",
            "ckp": "some_string",
            "color": "some_string",
            "is_hidden": 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",
            "ckp": "some_string",
            "color": "some_string",
            "is_hidden": 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 -
ckp ЦКП string -
color Цвет фона string -
is_hidden Видимость блока на оргсхеме bool -
color_chevron Цвет блока string -
order Порядок сортировки int -
creation_date Дата создания date -

Должности

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

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/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 '{"id":123,"org":"array","block":"array"}'
{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID int -
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": {
        "id": 123,
        "org": "array",
        "block": "array"
    }
}

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

Параметр Описание Тип Значения
id ID int -
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[orgschema.block]",
            "org": "array[orgschema.org]"
        },
        {
            "id": 123,
            "date": "2019-01-01 21:00:15",
            "author_id": "some_string",
            "blocks": "array[orgschema.block]",
            "org": "array[orgschema.org]"
        }
    ]
}

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

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