1.Управление пользователями

POST создание пользователя#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_V3}}/user Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "username": "ivanov.i",
        "realName": "Ivanov Ivan",
        "password": "123",
        "email": "ivanov.i@company.com",
        "mobile": "18300000001"
    },
    {
        "username": "petrov.p",
        "realName": "Petrov Petr", 
        "password": "123",
        "email": "petrov.p@company.com",
        "mobile": "18300000002"
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
username ivanov.i да String Имя пользователя
realName Ivanov Ivan да String ФИО пользователя
password 123 да String Пароль
email ivanov.i@company.ru нет String Почта
mobile 18300000001 нет String Номер телефона
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
data.data да Object Возвращаемые данные
data.data.id 2adba836-4984-458d-9827-3706067e767a да String ID созданного пользователя
data.data.name ivanov.i да String Имя созданного пользователя
json
{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "id": "2adba836-4984-458d-9827-3706067e767a",
                "name": "ivanov.i"
            }
        },
        {
            "status": true,
            "data": {
                "id": "2bc51f52-75fc-4fd9-8ea8-60f1af3dbe42",
                "name": "petrov.p"
            }
        }        
    ]
}

Failed (201)

json
{
    "status": 200,
    "data": [
        {
            "status": false,
            "errorMsg": "User ivanov.i already exist",
            "errorCode": ""
        },

        {
            "status" : false ,
            "errorMsg" : "Special char prohibit!" ,
            "errorCode" : "21300015"
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: DEL {{API_PATH_V3}}/user?user=["ivanov.i", "petrov.p"]

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры запроса.

Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
user ["ivanov.i", "petrov.p"] да Text Имя или ID пользователя

Параметры body запроса.

Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
да Text
json
{
    "data": [
        {
            "status" : true 
        },
        {
            "status" : true
        }
    ]
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "errorCode" : "E000101",
    "errorMsg" : "[com.tptj.plugin.hg.client.center.api.fun.caller.AbstractUserAuthApi.call][Request body data format exception user not exist 2035cdde-34eb-4653-99f0-bce4e4b2fdc9]"
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
errorCode E000101 да String Код ошибки
data.status [com.tptj.plugin.hg.client.center.api.fun.caller.AbstractUserAuthApi.call][Request body data format exception user not exist 2035cdde-34eb-4653-99f0-bce4e4b2fdc9] да String Конкретная причина ошибки
json
{
    "data": 
    [
        {
            "status" : true 
        },
        {
            "status" : true
        }
    ]
}
json
{
    "errorCode" : "E000101",
    "errorMsg" : "[com.tptj.plugin.hg.client.center.api.fun.caller.
    AbstractUserAuthApi.call][Request body data format exception user
    not exist 2035cdde-34eb-4653-99f0-bce4e4b2fdc9]"
}

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/user

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "user" : "ivanov.i",
        "realName" : "Ivanov Ivan",
        "password" : "123",
        "email" : "test1@qq.com"
    },
    {
        "user" : "petrov.p",
        "realName" : "Petrov Petr",
        "password" : "321",
        "email" : "test2@qq.com"
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
user ivanov.i да String Имя или ID пользователя
realName Ivanov Ivan нет String ФИО пользователя
password 123 нет String Пароль
mobile test1@qq.com нет String Номер телефона
json
[
    {
        "user" : "ivanov.i",
        "realName" : "Ivanov Ivan",
        "password" : "123",
        "email" : "test1@qq.com"
    },
    {
        "user" : "petrov.p",
        "realName" : "Petrov Petr",
        "password" : "321",
        "email" : "test2@qq.com"
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        },
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/user/department

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
    "user" : "ivanov.i" ,
    "add": [
        {
        "department" : "[\"Finance Department\"]" ,
        "post" : "Test Post 1"
        }
    ],
    "remove": [
        {
        "department" : "[\"Finance Department\", \"First Finance Department\"]"
        }
    ]
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
user zhangsan да String Имя пользователя
add да Array Добавление
add.department ["Finance Department"] да String Департамент, можно передать ID Департамента или массив иерархии отделов (JSON.stringify), [] означает корневой департамент, ["Finance Department"] означает корневой департамент- Finance Department
add.post Test Post 1 нет String Должность, эта должность должна быть уже добавлена в департамент. Если значение не передано, это означает, что пользователь будет добавлен в отдел
remove да Array Удаление, свойства такие же как у add
remove.department ["Finance Department", "Finance Department II"] да String
json
[
    {
    "user" : "ivanov.i" ,
    "add": [
        {
        "department" : "[\"Finance Department\"]" ,
        "post" : "Test Post 1"
        }
    ],
    "remove": [
        {
        "department" : "[\"Finance Department\", \"First Finance Department\"]"
        }
    ]
    }
]
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/user/role

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "user" : "ivanov.i",
        "add": [
            "Test Role"
        ],
        "remove": [

        ]
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
user ivanov.i да String Имя или ID пользователя
add да Array Добавление новых ролей пользователю
remove да Array Удаление ролей пользователя, атрибуты такие же как у add
json
[
    {
        "user" : "ivanov.i",
        "add": [
            "Test Role"
        ],
        "remove": [

        ]
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/user/enable

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "user" : "ivanov.i",
        "enable" : false
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
user ivanov.i да String Имя или ID пользователя
enable false да Boolean true/false enable/disable
json
[
    {
        "user" : "ivanov.i",
        "enable" : false
    }
]
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
value scope illustrate
1 FR/BI Platform View
4 FR/BI Mobile View
2 WITH A BI View
5 WITH A BI data analysis user (BI5.x version)
6 WITH A BI data processing user (BI5.x version)
3 WITH A BI Design User (BI6.x Version)

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/user/type

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "user" : "ivanov.i",
        "platformType": [
            3
        ]
    }
]
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
user ivanov.i да String Имя или ID пользователя
platformType 3 да Array Тип лицензии пользователя
json
[
    {
        "user" : "ivanov.i",
        "platformType": [
            3
        ]
    }
]
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_V3}}/user?username=&email=&page=&count=

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры запроса.

Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
username нет String Ключевое слово для фильтрации по имени пользователя или ФИО, нечеткое соответствие
email нет String Почта пользователя
page да String Номер страницы, по умолчанию 1
count да String Количество записей на странице, по умолчанию 200

Параметры body запроса:

json
{
    "status": 200,
    "data": {
        "total": 576,
        "items": [
            {
                "id": "033ad2b9-96c6-40d5-b69d-edcbbea099a2",
                "username": "SurUser337",
                "realName": "SurUser337",
                "email": "",
                "mobile": "",
                "enable": true
            },
            {
                "id": "03ea9cbc-d8d8-4189-b3ee-a4cb63e81971",
                "username": "user3",
                "realName": "user3",
                "email": "",
                "mobile": "",
                "enable": true
            }
        ]
    }
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Object Возвращаемые данные
data.total 4 да Integer Общее количество пользователей
data.items да Array
data.items.id old-platform-user-3 да String ID пользователя
data.items.username SurUser337 да String Имя пользователя
data.items.realName SurUser337 да String ФИО пользователя
data.items.email да String Почта пользователя
data.items.mobile да String Номер телефона
data.items.enable true да Boolean true/false enable/disable
json
{
    "status": 200,
    "data": {
        "total": 576,
        "items": [
            {
                "id": "033ad2b9-96c6-40d5-b69d-edcbbea099a2",
                "username": "SurUser337",
                "realName": "SurUser337",
                "email": "",
                "mobile": "",
                "enable": true
            },
            {
                "id": "03ea9cbc-d8d8-4189-b3ee-a4cb63e81971",
                "username": "user3",
                "realName": "user3",
                "email": "",
                "mobile": "",
                "enable": true
            }
        ]
    }
}

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_V3}}/user/detail?username=li&email=&mobile=&page=&count=

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры запроса.

Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
username iv нет String Ключевое слово для фильтрации по имени пользователя или ФИО, нечеткое соответствие
email нет String Почта пользователя, например example@qq.com
mobile нет String Номер телефона
page да Text Номер страницы, по умолчанию 1
count да Text Количество записей на странице, по умолчанию 200

Параметры body запроса:

Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
username iv нет String Ключевое слово для фильтрации по имени пользователя или ФИО, нечеткое соответствие
email нет String Почта пользователя, например example@qq.com
mobile нет String Номер телефона
page да Text Номер страницы, по умолчанию 1
count да Text Количество записей на странице, по умолчанию 200
json
{
    "status": 200,
    "data": {
        "total": 2,
        "items": [
            {
                "id": "2adba836-4984-458d-9827-3706067e767a",
                "username": "ivanov.i",
                "realName": "Ivanov Ivan",
                "email": "test1@qq.com",
                "mobile": "18300000001",
                "enable": true,
                "departmentPosts": [
                    {
                        "department": {
                            "id": "b2cc24c5-65ca-45fc-a744-40171670b70f",
                            "name": "Finance Department",
                            "fullPath": "Finance Department"
                        },
                        "post": {
                            "id": "4f5b7266-978b-4af7-aa48-472ee0cb4a37",
                            "name": "Test Post 1",
                            "description": "Job Description"
                        }
                    }
                ],
                "roles": [
                    {
                        "id": "3c58ed7c-bc78-4cfd-86e4-372cc31e1c7f",
                        "name": "Test Role",
                        "description": "zzzz"
                    }
                ]
            },
            {
                "id": "a0518f2b-3361-483f-9b32-8288c3996b74",
                "username": "Иван",
                "realName": "Ivan",
                "email": "",
                "mobile": "",
                "enable": true,
                "departmentPosts": [
                    {
                        "department": {
                            "id": "b09df129-0a8a-4011-b561-553c7de02caa",
                            "name": "Отдел финансов",
                            "fullPath": "Отдел финансов"
                        }
                    }
                ],
                "roles": []
            }
        ]
    }
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Object Возвращаемые данные
data.total 2 да Integer Общее количество пользователей
data.items да Array
data.items.id 2adba836-4984-458d-9827-3706067e767a да String ID созданного пользователя
data.items.username ivanov.i да String Имя пользователя
data.items.realName Ivanov Ivan да String ФИО пользователя
data.items.email да String Почта пользователя
data.items.mobile да String Номер телефона
data.items.enable true да Boolean true/false enable/disable
data.items.departmentPosts да Array
data.items.departmentPosts.department да Object Департамент
data.items.departmentPosts.department.id b2cc24c5-65ca-45fc-a744-40171670b70f да String ID департамента
data.items.departmentPosts.department.name Finance Department да String Имя департамента
data.items.departmentPosts.department.fullPath Finance Department да String Полный путь к департаменту, разделенный by
data.items.departmentPosts.post да Object Должность
data.items.departmentPosts.post.id 4f5b7266-978b-4af7-aa48-472ee0cb4a37 да String ID должности
data.items.departmentPosts.post.name Test Post 1 да String Имя должности
data.items.roles да Array Роль
data.items.roles.id 3c58ed7c-bc78-4cfd-86e4-372cc31e1c7f да String ID роли
data.items.roles.name Test Role да String Имя роли
data.items.roles.description zzzz да String Описание роли
json
{
    "status": 200,
    "data": {
        "total": 2,
        "items": [
            {
                "id": "2adba836-4984-458d-9827-3706067e767a",
                "username": "ivanov.i",
                "realName": "Ivanov Ivan",
                "email": "test1@qq.com",
                "mobile": "18300000001",
                "enable": true,
                "departmentPosts": [
                    {
                        "department": {
                            "id": "b2cc24c5-65ca-45fc-a744-40171670b70f",
                            "name": "Finance Department",
                            "fullPath": "Finance Department"
                        },
                        "post": {
                            "id": "4f5b7266-978b-4af7-aa48-472ee0cb4a37",
                            "name": "Test Post 1",
                            "description": "Job Description"
                        }
                    }
                ],
                "roles": [
                    {
                        "id": "3c58ed7c-bc78-4cfd-86e4-372cc31e1c7f",
                        "name": "Test Role",
                        "description": "zzzz"
                    }
                ]
            },
            {
                "id": "a0518f2b-3361-483f-9b32-8288c3996b74",
                "username": "Иван",
                "realName": "Ivan",
                "email": "",
                "mobile": "",
                "enable": true,
                "departmentPosts": [
                    {
                        "department": {
                            "id": "b09df129-0a8a-4011-b561-553c7de02caa",
                            "name": "Отдел финансов",
                            "fullPath": "Отдел финансов"
                        }
                    }
                ],
                "roles": []
            }
        ]
    }
}

POST Синхронизация пользовательских наборов данных#

Функция: При вызове этого интерфейса будет синхронизирована информация о пользователе, обновлены последние данные о пользователе в источнике данных.

Статус интерфейса: Опубликован

Параметры запроса

данных образца ответов пока нет

Success (200)

json
{
    "status": 200,
    "data": "success"
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус успеха
data success да String Статус

Failed (201)

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
errorCode 403 да String Код ошибки
errorMsg FORBIDDEN!NO PRIVILEGE! да String Ошибка аутентификации, доступ запрещен

POST Создание департаментов#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/department

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "parentDepartment" : "[]" ,
        "departmentName" : "Finance Department"
    },
    {
        "parentDepartment" : "[\"Finance Department\"]" ,
        "departmentName" : "First Finance Department"
    },
    {
        "parentDepartment" : "[\"Finance Department\"]" ,
        "departmentName" : "Second Finance Department" 
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
parentDepartment [] да String Департамент, можно передать ID департамента или массив иерархии департаментов (JSON.stringify), [] означает корневой департаментов, ["Finance Department"] означает корневой департамент- Finance Department
departmentName Finance Department да String Название департамента
json
[
    {
        "parentDepartment" : "[]" ,
        "departmentName" : "Finance Department"
    },
    {
        "parentDepartment" : "[\"Finance Department\"]" ,
        "departmentName" : "First Finance Department"
    },
    {
        "parentDepartment" : "[\"Finance Department\"]" ,
        "departmentName" : "Second Finance Department" 
    }
]
json
{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "id": "b2cc24c5-65ca-45fc-a744-40171670b70f",
                "name": "Finance Department"
            }
        },
        {
            "status": true,
            "data": {
                "id": "bf44d71d-de90-4de2-b8bb-4f3f9530ad8c",
                "name": "First Finance Department"
            }
        },
        {
            "status": true,
            "data": {
                "id": "c8d861db-8e27-48f3-9371-ed149ca0496c",
                "name": "Second Finance Department"
            }
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
parentDepartment [] да String Департамент, можно передать ID департамента или массив иерархии департаментов (JSON.stringify), [] означает корневой департаментов, ["Finance Department"] означает корневой департамент- Finance Department
departmentName Finance Department да String Название департамента
json
{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "id": "b2cc24c5-65ca-45fc-a744-40171670b70f",
                "name": "Finance Department"
            }
        },
        {
            "status": true,
            "data": {
                "id": "bf44d71d-de90-4de2-b8bb-4f3f9530ad8c",
                "name": "First Finance Department"
            }
        },
        {
            "status": true,
            "data": {
                "id": "c8d861db-8e27-48f3-9371-ed149ca0496c",
                "name": "Second Finance Department"
            }
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: DEL {{API_PATH_V3}}/department?department=["["Finance Department"]"]

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры запроса.

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
department ["["Finance Department"]"] да Text Список ID департаментов или пути к ним

Параметры body запроса.

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
да Text
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/department

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
    "departmentId" : "[\"Finance Department\", \"Second Finance Department\"]",
    "departmentName" : "Second Finance Department new",
    "parentDepartment" : "[\"Finance Department\"]"
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
departmentId "["Finance Department", "Second Finance Department"]" да String ID департамента или строка с иерархией департаментов
departmentName "Second Finance Department new" да String Новое название департамента
parentDepartment "["Finance Department"]" да String Родительский департамент, можно передать ID департамента или массив с иерархическим порядком департаментов (JSON.stringify), [] означает корневой департамент, [""Finance Department"] означает корневой департамент- Finance Department
json
[
    {
    "departmentId" : "[\"Finance Department\", \"Second Finance Department\"]",
    "departmentName" : "Second Finance Department new",
    "parentDepartment" : "[\"Finance Department\"]"
    }
]
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/department/position

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
    "department" : "[\"Finance Department\"]",
    "add": [
        "Test Post 1"
    ],
    "remove": [
        
    ]
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
department ["Finance Department"] да String ID департамента или строка с иерархией департаментов
add Test Post 1 нет Array Добавление должности
remove Members нет Array Отвязывание должности
json
[
    {
    "department" : "[\"Finance Department\"]",
    "add": [
        "Test Post 1"
    ],
    "remove": [
        
    ]
    }
]
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/department/user

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "department" : "[\"Finance Department\", \"Second Finance Department\"]",
        "post" : "Test Post 1",
        "add": [
            "ivanov.i"
        ],
        "remove": [

        ]
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
department "["Finance Department", "Second Finance Department"]" да String Департамент, можно передать ID департамента или массив с иерархическим порядком департаментов (JSON.stringify), [] означает корневой департамент, [""Finance Department"] означает корневой департамент- Finance Department
post Test Post 1 нет String Должность, можно передать ID или название должности
add ivanov.i нет Array Добавление пользователей
remove нет Array Отвязывание пользователей
json
[
    {
        "department" : "[\"Finance Department\", \"Second Finance Department\"]",
        "post" : "Test Post 1",
        "add": [
            "ivanov.i"
        ],
        "remove": [

        ]
    }
]
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_V3}}/department?department=["Finance Department"]

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры запроса.

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
department ["Finance Department"] да Text Департамент, можно передать ID департамента или массив с иерархическим порядком департаментов (JSON.stringify),[] означает корневой департамент, ["Finance Department"] означает корневой департамент - Finance Department

Параметры body запроса:

json
{
    "status": 200,
    "data": [
        {
            "id": "b2cc24c5-65ca-45fc-a744-40171670b70f",
            "pId": null,
            "name": "Finance Department",
            "type": "department"
        },
        {
            "id": "4f5b7266-978b-4af7-aa48-472ee0cb4a37",
            "pId": "b2cc24c5-65ca-45fc-a744-40171670b70f",
            "name": "Test Post 1",
            "type": "position"
        },
        {
            "id": "bf44d71d-de90-4de2-b8bb-4f3f9530ad8c",
            "pId": "b2cc24c5-65ca-45fc-a744-40171670b70f",
            "name": "First Finance Department",
            "type": "department"
        },
        {
            "id": "c8d861db-8e27-48f3-9371-ed149ca0496c",
            "pId": "b2cc24c5-65ca-45fc-a744-40171670b70f",
            "name": "Second Finance Department",
            "type": "department"
        },
        {
            "id": "4f5b7266-978b-4af7-aa48-472ee0cb4a37",
            "pId": "c8d861db-8e27-48f3-9371-ed149ca0496c",
            "name": "Test Post 1",
            "type": "position"
        }
    ]
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.id b2cc24c5-65ca-45fc-a744-40171670b70f да String ID узла
data.pld null да String ID родительского узла
data.name Finance department да String Название узла
data.type department да String Тип узла, должность в департаменте

POST Поиск пользователей департамента#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/department/user

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
    "department" : "[\"Finance Department\",\"Second Finance Department\"]",
    "post" : "Test Post 1",
    "recursive" : true
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
department ["Finance Department"] да String Департамент, можно передать ID департамента или массив с иерархическим порядком департаментов (JSON.stringify),[] означает корневой департамент, ["Finance Department"] означает корневой депатамент - Finance Department
post Test post 1 нет String ID должности или Название должности. Если не передано, будет выполнен поиск пользователей в департаменте
recursive true нет Boolean Искать ли пользователей в поддепартаментах. По умолчанию false. Когда установлено в true, будет искать пользователей во всех должностях в департаментах и всех его поддепартаментов, игнорируя параметр post
json
{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": [
                {
                    "id": "c6e466ac-b778-49b1-b08f-22e982195074",
                    "username": "ivanov.i",
                    "realName": "Ivanov Ivan",
                    "email": "ivanov.i@company.com",
                    "mobile": "18300000001",
                    "enable": true
                }
            ]
        }
    ]
}
Название параметра Значение параметра Обязательное поле ? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
data.data да Array Возвращаемые данные
data.data.id c6e466ac-b778-49b1-b08f-22e982195074 да String ID созданного пользователя
data.data.username ivanov.i да String Имя созданного пользователя
data.data.realName Ivanov Ivan да String ФИО пользователя
data.data.email ivanov.i@company.ru да String Почта пользователя, например example@company.ru
data.data.mobile да String Номер телефона
data.data.enable true да Boolean Доступен ли пользователь?

POST Создание должности#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/position

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "positionName" : "Test Post 1",
        "description" : "Job Description"
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
positionName Test Post 1 да String Название новой должности
description Job Description да String Описание новой должности
json
{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "id": "4f5b7266-978b-4af7-aa48-472ee0cb4a37",
                "name": "Test Post 1"
            }
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
data.data да Object Возвращаемые данные
data.data.id 542c5517-bbbb-459f-801f-d0deffade008 да String ID созданной должности
data.data.name Test Post 1 да String Название созданной должности

Статус интерфейса: Опубликован

URL интерфейса: DEL {{API_PATH_V3}}/position?position=["Testing Position 1"]

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры запроса.

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
position ["Test Post 1"] да Text ID или название должности

Параметры body запроса.

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
нет Text
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных

POST Создание роли#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/role

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

json
[
    {
        "roleName" : "Test Role",
        "description" : "zzzz"
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
roleName Test Role да String Название новой роли
description zzzz нет String Описание новой роли
json
{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "id": "bdc6fe4e-b921-4b94-8fce-161cbc50f6ad",
                "name": "Test Role"
            }
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных
data.data да Object Возвращаемые данные
data.data.id bdc6fe4e-b921-4b94-8fce-161cbc50f6ad да String ID новой роли
data.data.name Test Role да String Название новой роли

Статус интерфейса: Опубликован

URL интерфейса: DEL {{API_PATH_V3}}/role?role=["Test Role"]

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры запроса.

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
role ["Test Role"] да Text

Параметры body запроса.

Название параметра Значение параметра Обязательное поле? Тип параметра Описание
да Text
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/role

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "role" : "Test Role",
        "name" : "Test Role A",
        "description" : "Test role description 1"
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
role Test Role да String ID или название роли
name Test Role A нет String Новое название роли
description Test role description 1 нет String Новое описание роли
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/role/user

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    {
        "id" : "Test Role A",
        "add": [
            "petrov.p",
            "ivanov.i"
        ]
    }
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
id Test Role A да String ID или название роли
add ivanov.i нет Array Добавить нового привязанного пользователя
json
{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data да Array Возвращаемые данные
data.status true да Boolean Результат выполнения единичных данных

POST Поиск пользователей роли#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/role/user

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Параметры body запроса.

json
[
    "Test Role A" 
]
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
- Normal Character 1 да String
да String
json
{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": [
                {
                    "id": "2adba836-4984-458d-9827-3706067e767a",
                    "username": "ivanov.i",
                    "realName": "Ivanov Ivan",
                    "email": "test1@qq.com",
                    "mobile": "18300000001",
                    "enable": true
                },
                {
                    "id": "2bc51f52-75fc-4fd9-8ea8-60f1af3dbe42",
                    "username": "petrov.p",
                    "realName": "Petrov Petr",
                    "email": "test2@qq.com",
                    "mobile": "18300000002",
                    "enable": true
                }
            ]
        }
    ]
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data yes Array Возвращаемые данные
data.status true yes Boolean Результат выполнения единичных данных
data.data yes Array Возвращаемые данные
data.data.id 2adba836-4984-458d-9827-3706067e767a yes String ID пользователя
data.data.username ivanov.i yes String Имя пользователя
data.data.realName Ivanov Ivan yes String ФИО пользователя
data.data.email test1@qq.com yes String Почта пользователя, например example@qq.com
data.data.mobile 1830000001 yes String Номер телефона
data.data.enable true yes Boolean Доступен ли пользователь?
← НазадСистемные требования и типовые конфигурации Вперёд →10.Подготовка данных (публичные данные)