2.Управление каталогами

Общее управление#

GET Поиск каталога#

Каталог запроса - это каталог платформы, который виден после входа пользователя в платформу принятия решений Подробное описание полей можно найти в структуре таблицы в Инструкции Администратора . Интерфейс не поддерживает постраничный запрос

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

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

URL интерфейса: GET {{API_PATH_V3}}/entry?keyword=TableName&entry=["First-level directory","Second-level directory"]

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

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

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

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

Success (200)#

json

{
    "data": [
        {
            "id" : "old-platform-folder-entry-74" , //Role id or role name
            "pId": "old-platform-folder-entry-73",
            "text" : "Infographic" ,
            "path": null,
            "description" : "" , //Create a new role description
            "deviceType": 3,
            "entryType": 3,
            "mobileNodeIcon": null,
            "sortIndex": 2,
            "isParent": true,
            "open": false,
            "privilegeDetailBeanList": null,
            "cover": "i",
            "icon": null,
            "fullParentName": null,
            "parentNames": null,
            "parentDeviceType": 0
        },
        {
            "id" : "55c9d50f-a73a-4832-b6d4-6899bc598c7d" , //Role id or role name
            "pId": "old-platform-folder-entry-74",
            "text" : "Column chart deformation" ,
            "path" : "demo/analytics/bar chart deformation.cpt" ,
            "description" : "" , //Create a new role description
            "deviceType": 3,
            "entryType": 102,
            "mobileNodeIcon": null,
            "sortIndex": 1,
            "isParent": false,
            "open": false,
            "privilegeDetailBeanList": null,
            "cover": null,
            "icon": null,
            "fullParentName": null,
            "parentNames": null,
            "parentDeviceType": 0,
            "showType": 1, 
            "parameters": [] 
        },
        {
            "id" : "old-platform-reportlet-entry-562" , //Role id or role name
            "pId": "old-platform-folder-entry-74",
            "text" : "National Flag Column Chart" ,
            "path" : "demo/Oldchart/advanced/Flag Column Chart.cpt" ,
            "description" : "" , //Create a new role description
            "deviceType": 3,
            "entryType": 102,
            "mobileNodeIcon": null,
            "sortIndex": 2,
            "isParent": false,
            "open": false,
            "privilegeDetailBeanList": null,
            "cover": "i",
            "icon": null,
            "fullParentName": null,
            "parentNames": null,
            "parentDeviceType": 0,
            "showType": 1, 
            "parameters": [] 
        }
    ]
}

Failed (404)#

PUT Перемещение узла#

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

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

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

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

json

[
    {
        "targetEntry" : "[\"Test Dir(test_api)\"]",
        "prevEntry" : "",
        "moveEntries": [
            "[\"Test Dir3(test_api)\"]"
        ]
    }
]

Название параметра	Значение параметра	Обязательное поле ?	Тип параметра	Описание
targetEntry	["Test Dir(test_api)"]	Да	String	Целевой каталог, куда будет перемещен каталог (для корневого каталога передайте [] или decision-directory-root)
prevEntry		Да	String	Предыдущий каталог после перемещения. Если перемещаемый каталог будет первым, передайте пустое значение
moveEntries	["Test Dir3(test_api)"]	Да	Array	Каталоги для перемещения

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

Success (200)

json

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

Название параметра	Значение параметра	Обязательное поле ?	Тип параметра	Описание
status	200	Да	Integer	Status
data		Да	Array
data.status	true	Да	Boolean	Status

Failed (404)

DEL Удаление узла#

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

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

URL интерфейса: DEL {{API_PATH_V3}}/entry?entries=["["First-level directory"]"]

Content-Type: application/json

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

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

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

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

Success (200)#

json

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

Failed (404)#

Управление каталогами#

POST Добавление каталога#

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

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

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

Content-Type: application/json

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

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

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

json

[
    {
        "parentDirectory":"[]",
        "directoryName":"First-level directory",
        "description":"",
        "device":{
            "phoneDevice":"true",
            "pcDevice":"true",
            "padDevice":"true"
        }    
    }
]

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

Success (200)#

json

{
    "status": 200,
    "data": [
        {
            "status": true,
            "data": {
                "id": "94efd6a0-3e5b-45f8-b94d-0d36591340ec",
                "pId": "decision-directory-root",
                "text": "First-level directory",
                "path": null,
                "description": "",
                "deviceType": 7,
                "entryType": 3,
                "mobileNodeIcon": null,
                "sortIndex": 9,
                "isParent": false,
                "open": false,
                "privilegeDetailBeanList": null,
                "cover": null,
                "icon": null,
                "fullParentName": null,
                "parentNames": null,
                "parentDeviceType": 0
            }
        }
    ]
}

Failed (404)#

PUT Редактирование каталога#

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

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

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

Content-Type: application/json

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

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

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

json

[
    {
        "directory" : "[\"First-level directory\",\"Second-level directory II\"]" , 
        "directoryName" : "Second-level directory II new" , 
        "description" : "Directory description",
        "device": {
            "phoneDevice" : "false",
            "pcDevice" : "false",
            "padDevice" : "false"
        } 
    }
]

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

Success (200)#

json

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

Failed (404)#

Управление ссылками#

POST Добавление ссылки#

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

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

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

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

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

Success (200)#

Failed (404)#

PUT Редактирование ссылки#

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

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

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

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

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

Success (200)#

Failed (404)#

Управление шаблонами#

POST Добавление шаблона#

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

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

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

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

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

Success (200)#

Failed (404)#

PUT Редактирование шаблона#

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

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

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

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

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

Success (200)#

Failed (404)#

Управление главной страницей#

GET Поиск главной страницы#

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

Статус интерфейса: Опубликован URL интерфейса: GET {{API_PATH_V3}}/entry/homepage Способ аутентификации: Аутентификация не требуется

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

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

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

Success (200)#

Failed (404)#

POST Добавление главной страницы#

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

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

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

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

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

Success (200)#

Failed (404)#

PUT Изменение главной страницы#

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

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

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

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

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

Success (200)#

Failed (404)#

Управление избранным#

GET Просмотр избранного#

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

Статус интерфейса: Опубликован URL интерфейса: GET {{API_PATH_V3}}/entry/favorite Способ аутентификации: Аутентификация не требуется

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

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

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

Success (200)#

Failed (404)#

POST Добавление в избранное#

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

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

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

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

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

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

Success (200)#

Failed (404)#

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

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

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

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

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

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

Success (200)#

Failed (404)#

Управление BI-шаблонами#

POST Добавление BI-шаблона#

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

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

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

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

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

Success (200)#

Failed (404)#

PUT Изменение BI-шаблона#

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

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