11.Мой анализ

GET Группировка всех папок в “Мой анализ”#

Основная информация#

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

URL интерфейса: GET {{API_PATH_BI_V3}}/conf/subjects/folders/all

Content-Type: application/json

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

Передаваемые параметры#

Параметры запроса: данных образца ответов пока нет.

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": {
        "id": "__my_analysis__cfeddc85-59b0-46c1-8667-f44a63cfbdbf",
        "name": "cfeddc85-59b0-46c1-8667-f44a63cfbdbf",
        "createBy": "admin.kirill",
        "subjectFolders": [
            {
                "id": "__coop_root_group__",
                "name": "Совместная разработка",
                "createBy": "Неизвестный пользователь",
                "subjectFolders": [],
                "subjects": []
            }
        ],
        "subjects": []
    }
}

Failed (404)#

GET Получение ресурсов по теме#

Основная информация#

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

URL интерфейса: GET {{API_PATH_BI_V3}}/conf/subjects/items?subject=91963877617542e99e58dd88ad768c0c

Content-Type: application/json

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

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "data": {
        "id" : "91963877617542e99e58dd88ad768c0c" , //Topic ID
        "name" : "Analysis topic" , //topic name
        "tableNames": [
            "9d46d930cf824209ac0f3e9354f810a4"
        ], //Dataset original name list
        "reportIds": [
            "4c6209858e56437387f4383f7961ddb5"
        ], //Report ID list
        "widgetIds": [
            "d7362d7542124019acb2efa68dfc858e"
        ] //Component ID list
    }
}

Failed (404)#

POST Добавление тематической папки#

Основная информация#

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

URL интерфейса: POST {{API_PATH_BI_V3}}/conf/subjects/folder

Content-Type: application/json

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

Передаваемые параметры#

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

{
    "parentFolder": "c1b769ee97d04c88b25f383246d47162"
}

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": {
        "id": "b81a77288569412396904702bff05784",
        "name": "Новая папка"
    }
}

Failed (404)#

POST Добавление темы в папку#

Основная информация#

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

URL интерфейса: POST {{API_PATH_BI_V3}}/conf/subjects

Content-Type: application/json

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

Передаваемые параметры#

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

{
    "parentFolder": "b2f2617391f2481f8609ea0cb6a4029c"
}

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": {
        "id": "0c4cd4798feb4e18babfd77ba17a3932",
        "name": "Рабочая книга"
    }
}

Failed (404)#

PUT Переименование тематической папки#

Основная информация#

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

URL интерфейса: PUT {{API_PATH_BI_V3}}/conf/subjects/folders/name

Content-Type: application/json

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

Передаваемые параметры#

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

{
    "folder" : "b81a77288569412396904702bff05784" ,
    "newFolderName" : "Test Folder" 
}

Возвращаемые параметры (json + таблица)#

Success (200)#

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

Failed (404)#

PUT Переименование темы#

Основная информация#

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

URL интерфейса: PUT {{API_PATH_BI_V3}}/conf/subjects/name

Content-Type: application/json

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

Передаваемые параметры#

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

{
    "subject" : "b2f2617391f2481f8609ea0cb6a4029c" ,
    "newSubjectName" : "Workbook" 
}

Возвращаемые параметры (json + таблица)#

Success (200)#

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

Failed (404)#

DEL Удаление ресурса (темы или папки)#

Основная информация#

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

URL интерфейса: DEL {{API_PATH_BI_V3}}/conf/subjects?folder=b81a77288569412396904702bff05784&subject=7bd18a70191d4e04af44348e4a87681f

Content-Type: application/json

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

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)#

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

Failed (404)#

Дашборд#

POST Создание нового дашборда#

Основная информация#

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

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

Content-Type: application/json

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

Передаваемые параметры#

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

[
    {
        "parentSubject" : "4e32ebc5f5ec43f498cd64073cba4fe6",
        "biReportName" : "Dashboard"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "biReportId": "ba2f6e1abe3e44d39083f5d9875b63b1",
                "biReportName": "Dashboard"
            }
        }
    ]
}

Failed (404)#

PUT Переименование дашборда#

Основная информация#

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

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

Content-Type: application/json

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

Передаваемые параметры#

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

[
    {
        "biReport" : "ba2f6e1abe3e44d39083f5d9875b63b1",
        "newBiReportName" : "New dashboard name"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": true
        }
    ]
}

Failed (404)#

DEL Удаление дашборда#

Основная информация#

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

URL интерфейса: DEL {{API_PATH_BI_V3}}/dash?biReports=["ba2f6e1abe3e44d39083f5d9875b63b1"]

Content-Type: application/json

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

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": true
        }
    ]
}

Failed (404)#

POST Сохранение как дашборд#

Основная информация#

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

URL интерфейса: POST {{API_PATH_BI_V3}}/dash/saveas

Content-Type: application/json

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

Передаваемые параметры#

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

[
    {
        "biReport" : "aa442707c052489b95832498ff34171a" , 
        "newBiReportName" : "Dashboard name after saving" , 
        "parentSubject" : "4e32ebc5f5ec43f498cd64073cba4fe6"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "biReportId": "49330d859ba0466cb963d75957f3afd7",
                "biReportName": "Dashboard name after saving"
            }
        }
    ]
}

Failed (404)#

GET Получение информации о дашборде#

Основная информация#

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

URL интерфейса: GET {{API_PATH_BI_V3}}/dash/info?biReports=["49330d859ba0466cb963d75957f3afd7"]

Content-Type: application/json

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

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "biReportId": "49330d859ba0466cb963d75957f3afd7",
                "biReportName": "Dashboard name after saving"
            }
        }
    ]
}

Failed (404)#

GET Получение всех дашбордов для текущего пользователя#

Основная информация#

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

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

Content-Type: application/json

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

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "biReportId": "aa442707c052489b95832498ff34171a",
            "biReportName": "Dashboard"
        },
        {
            "biReportId": "49330d859ba0466cb963d75957f3afd7",
            "biReportName": "Dashboard name after saving"
        }
    ]
}

Failed (404)#

POST Сохранение как темы#

Основная информация#

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

URL интерфейса: POST {{API_PATH_BI_V3}}/dash/subject/saveas

Content-Type: application/json

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

Передаваемые параметры#

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

{
    "biReport" : "34c2a3b66cb2434f8b2efba232ec587c" ,
    //Dashboard ID or path such as "[\"Rename theme\", 
    // \"Create a new dashboard control test\"]"
    "newSubjectName" : "Subject name after saving" , //Subject name
    "parentFolder" : "674c7dd15af845fb97633d4a732ca447" 
    //parent folder ID or path; passing "" will be the current user's analysis root folder
}

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": {
        "subjectId" : "295026cc48fa4d32a8b8839ed32be4ae" , //Subject ID
        "subjectName" : "Subject name after saving" //Subject name
    }
}

Failed (404)#

POST Добавление пустых компонентов данных в раздел#

Основная информация#

Статус интерфейса: Завершен URL интерфейса: POST {{API_PATH_BI_V3}}/conf/widgets Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

DEL Удаление компонента#

Основная информация#

Статус интерфейса: Завершен URL интерфейса: DEL {{API_PATH_BI_V3}}/conf/widgets?widget=139f7242aacf4de995c57664d0debd8d Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

PUT Переименование компонента#

Основная информация#

Статус интерфейса: Завершен URL интерфейса: PUT {{API_PATH_BI_V3}}/conf/widgets/name Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

Данные#

POST Добавление таблицы данных к теме#

Основная информация#

Статус интерфейса: Завершен URL интерфейса: POST {{API_PATH_BI_V3}}/conf/analysis/tables Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

PUT Переименование таблицы данных темы#

Основная информация#

Статус интерфейса: Завершен URL интерфейса: PUT {{API_PATH_BI_V3}}/conf/analysis/tables/name Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)

DEL Удаление таблицы данных по теме#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: DEL {{API_PATH_BI_V3}}/conf/analysis/tables?table=d22c609f1ed44367a8017609e4189bbe Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

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

Возвращаемые параметры (json + таблица)#

Success (200)

Failed (404)