13.Настройки общего доступа и совместной работы

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

URL интерфейса: PUT {{API_PATH_BI_V3}}/cooperation/subject/depost

Content-Type: application/json

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

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

json
{
    "department" : "3eed535e-eb0c-4af9-b9ad-8cd8b95f1ad0",
    "position" : "Test Post1",
    "subject" : "4e32ebc5f5ec43f498cd64073cba4fe6" ,
    "folder" : "" ,
    "authority": {
        "use" : true ,
        "edit" : true
    }
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
department 3eed535e-eb0c-4af9-b9ad-8cd8b95f1ad0 да String ID или путь департамента
position Test Post1 да String ID или название должности
subject 4e32ebc5f5ec43f498cd64073cba4fe6 да String ID или путь темы, может быть передан только один из subject или folder
folder да String ID или путь папки темы, может быть передан только один из subject или folder
authority да Object Права доступа
authority.use true да Boolean Право использования
authority.edit true да Boolean Право редактирования
json
{
    "status": 200,
    "data": "success"
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data success да String Статус операции (успешна или нет)

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

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

Content-Type: application/json

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

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

json
{
    "role" : "Test role" , //role ID or name
    "subject" : "23b62271204c4d5fa22f6ff1eeb5cad4" , 
    //Subject ID or path. Only one of the subject ID and folder can be passed at the same time.
    "folder" : "" , 
    //Theme folder ID or path, only one of them and subject can be passed at the same time.
    "authority": {
        "use" : true , //use permission
        "edit" : true //Edit permission
    }
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
role Test Role да String ID или название роли
subject 23b62271204c4d5fa22f6ff1eeb5cad4 да String ID или путь темы, может быть передан только один из subject или folder
folder да String ID или путь папки темы, может быть передан только один из subject или folder
authority да Object Права доступа
authority.use true да Boolean Право использования
authority.edit true да Boolean Право редактирования
json
{
    "status": 200, 
    "data" : "success" //The operation is successful
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data success да String Статус операции (успешна или нет)

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

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

Content-Type: application/json

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

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

json
{
    "user" : "test" , //user ID or name
    "subject" : "23b62271204c4d5fa22f6ff1eeb5cad4" , 
    //Subject ID or path. Only one of the subject ID and folder can be passed at the same time.
    "folder" : "" , 
    //Theme folder ID or path, only one of them and subject can be passed at the same time.
    "authority": {
        "use" : true , //use permission
        "edit" : true //Edit permission
    }
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
user test да String ID или имя пользователя
subject 23b62271204c4d5fa22f6ff1eeb5cad4 да String ID или путь темы, может быть передан только один из subject или folder
folder да String ID или путь папки темы, может быть передан только один из subject или folder
authority да Object Права доступа
authority.use true да Boolean Право использования
authority.edit true да Boolean Право редактирования
json
{
    "status": 200, 
    "data" : "success" //The operation is successful
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data success да String Статус операции (успешна или нет)

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

URL интерфейса: PUT {{API_PATH_BI_V3}}/share/dash/depost

Content-Type: application/json

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

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

json
{
    "depPosts": [
        {
            "department" : "3eed535e-eb0c-4af9-b9ad-8cd8b95f1ad0",
            "position" : "Test Post1"
        } 
    ],
    "biReport" : "0389ffa715b845b3b6bf51894d65c7dd" ,
    "authority": {
        "view" : true
    }
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
depPosts да Array Список должностей в департаменте
depPosts.department 3eed535e-eb0c-4af9-b9ad-8cd8b95f1ad0 да String ID или путь департамента
depPosts.position Test Post1 да String ID или название должности
biReport 0389ffa715b845b3b6bf51894d65c7dd да String ID или путь дашборда
authority да Object Права доступа
authority.view true да Boolean Разрешение на просмотр
json
{
    "status": 200,
    "data": "success"
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data success да String Статус операции (успешна или нет)

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

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

Content-Type: application/json

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

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

json
{
    "roles": [
        "Test Role2"
    ],
    "biReport" : "0389ffa715b845b3b6bf51894d65c7dd" ,
    "authority": {
        "view" : true
    }
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
roles Test Role2 да Array Список названий или ID ролей
biReport 0389ffa715b845b3b6bf51894d65c7dd да String ID или путь дашборда
authority да Object Права доступа
authority.view true да Boolean Разрешение на просмотр
json
{
    "status": 200,
    "data": "success"
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data success да String Статус операции (успешна или нет)

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

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

Content-Type: application/json

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

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

json
{
    "users": [
        "morozov.m"
    ],
    "biReport" : "0389ffa715b845b3b6bf51894d65c7dd" ,
    "authority": {
        "view" : true
    }
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
users morozov.m да Array Список имен или ID пользователей
biReport 0389ffa715b845b3b6bf51894d65c7dd да String ID или путь дашборда
authority да Object Права доступа
authority.view true да Boolean Разрешение на просмотр
json
{
    "status": 200,
    "data": "success"
}
Название параметра Значение параметра Обязательное поле? Тип параметра Описание
status 200 да Integer Статус
data success да String Статус операции (успешна или нет)