Список панелей задач
Этот метод используется для получения подробностей панели задач для конкретной страницы или для всех страниц.
Метод
GET.
URI ресурса
/ibm/ioc/api/taskbar-service/taskbars
Например, чтобы получить подробности панели задач на странице Sunshine.OperatorOperations:
https://web-server.cn.example.com/ibm/ioc/api/taskbar-service/taskbars?page=Sunshine.OperatorOperationsПараметры запроса
| Имя | Тип | Описание |
|---|---|---|
| page | Строка | Строковый ID страницы, панель задач которой перечисляется. Если этот параметр не задан, в список включаются ресурсы панелей задач для всех страниц. |
Свойства ответа
Возвращается массив объектов, каждый из которых представляет панель задач на определенной странице. Каждый объект панели задач содержит свойство
page для ID страницы и массив с именем groups, который детализирует группы кнопок на этой панели задач.
| Имя | Тип | Описание |
|---|---|---|
| groups | Массив | Массив объектов, каждый из которых представляет группу кнопок на панели задач. Например, это может быть группа, содержащая кнопки Мои представления и Дополнительные действия. |
| page | Строка | Строковый ID страницы. |
| Имя | Тип | Описание |
|---|---|---|
| id | Строка | ID группы панели задач. |
| lastUpdateDate | Число | Отметка времени для даты последнего обновления группы задач. |
| solution | Строка | Имя решения. |
| page | Строка | Строковый ID страницы. |
| groupName | Строка | Имя группы панели задач. |
| ordinal | Число | Числовая позиция группы панели задач на панели задач. |
| buttons | Массив | Массив объектов кнопок, представляющих содержимое группы панели задач. Каждый объект кнопки содержит ID и массив authorizations, в котором перечислены группы пользователей с доступом к этой кнопке. Объект кнопки также содержит порядковый номер, определяющий положение кнопки панели задач в группе, а также подробности метки и значков кнопки. |
Пример содержимого ответа
Следующий пример ответа относится к вызову службы для получения панели задач страницы Sunshine.OperatorOperations.
[
{
"groups": [
{
"id": 48,
"lastUpdateDate": 1538061171392,
"solution": "Sunshine",
"page": "Sunshine.OperatorOperations",
"groupName": "UserGroup_OperatorOperations",
"ordinal": 0,
"buttons": [
{
"id": 55,
"buttonName": "MyView",
"label": {
"group": "SunshineTheme",
"key": "MyView",
"i18nLabel": "My View"
},
"moduleName": "ioc/taskbar/MyViewTaskbarButtonHandler",
"ordinal": 10,
"darkIcon": "/ibm/ioc/theme/images/taskbar/dark/MyView.png",
"greyIcon": "/ibm/ioc/theme/images/taskbar/light/MyView.png",
"globalName": "MyView",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
},
{
"id": 56,
"buttonName": "MoreActions",
"label": {
"group": "SunshineTheme",
"key": "MoreActions",
"i18nLabel": "More Actions"
},
"moduleName": "ioc/taskbar/MoreActionsTaskbarButtonHandler",
"ordinal": 20,
"darkIcon": "/ibm/ioc/theme/images/taskbar/dark/MoreActions.png",
"greyIcon": "/ibm/ioc/theme/images/taskbar/light/MoreActions.png",
"globalName": "MoreActions",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
}
]
},
{
"id": 46,
"lastUpdateDate": 1538061171300,
"solution": "Sunshine",
"page": "Sunshine.OperatorOperations",
"groupName": "StatusGroup_OperatorOperations",
"ordinal": 10,
"buttons": [
{
"id": 50,
"buttonName": "KpiDashboard",
"label": {
"group": "SunshineTheme",
"key": "KpiDashboard",
"i18nLabel": "Dashboard"
},
"moduleName": "ioc/kpidashboard/KpiDashboardTaskbarButtonHandler",
"ordinal": 10,
"darkIcon": "/ibm/ioc/theme/images/taskbar/dark/Dashboard.png",
"greyIcon": "/ibm/ioc/theme/images/taskbar/light/Dashboard.png",
"globalName": "KpiDashboard",
"selectedIcon": "/ibm/ioc/theme/images/taskbar/selected/Dashboard.png",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
},
{
"id": 51,
"buttonName": "MyActivities",
"label": {
"group": "SunshineTheme",
"key": "Activities",
"i18nLabel": "Activities"
},
"moduleName": "ioc/sop/MyActivitiesTaskbarButtonHandler",
"ordinal": 10,
"darkIcon": "/ibm/ioc/theme/images/taskbar/dark/MyActivities.png",
"greyIcon": "/ibm/ioc/theme/images/taskbar/light/MyActivities.png",
"globalName": "Activities",
"selectedIcon": "/ibm/ioc/theme/images/taskbar/selected/MyActivities.png",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
}
]
},
{
"id": 45,
"lastUpdateDate": 1538061171268,
"solution": "Sunshine",
"page": "Sunshine.OperatorOperations",
"groupName": "DataGroup_OperatorOperations",
"ordinal": 30,
"buttons": [
{
"id": 49,
"buttonName": "FilterPanel",
"label": {
"group": "SunshineTheme",
"key": "FilterPanel",
"i18nLabel": "Filter"
},
"moduleName": "water/filter/FilterPanelTaskbarButtonHandler",
"ordinal": 20,
"darkIcon": "/ibm/ioc/theme/images/taskbar/dark/DataFilter.png",
"greyIcon": "/ibm/ioc/theme/images/taskbar/light/DataFilter.png",
"globalName": "FilterPanel",
"selectedIcon": "/ibm/ioc/theme/images/taskbar/selected/DataFilter.png",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
}
]
},
{
"id": 47,
"lastUpdateDate": 1538061171340,
"solution": "Sunshine",
"page": "Sunshine.OperatorOperations",
"groupName": "SupportingGroup_OperatorOperations",
"ordinal": 50,
"buttons": [
{
"id": 52,
"buttonName": "MeasurementView",
"label": {
"group": "SunshineTheme",
"key": "Measurements",
"i18nLabel": "Measurements"
},
"moduleName": "water/measurement/MeasurementsViewerTaskbarButtonHandler",
"ordinal": 10,
"darkIcon": "/ibm/ioc/theme/images/taskbar/dark/SupportingContent.png",
"greyIcon": "/ibm/ioc/theme/images/taskbar/light/SupportingContent.png",
"globalName": "MeasurementView",
"selectedIcon": "/ibm/ioc/theme/images/taskbar/selected/SupportingContent.png",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
},
{
"id": 53,
"buttonName": "ReadingBarChartView",
"label": {
"group": "SunshineTheme",
"key": "ReadingBarChartView",
"i18nLabel": "Reading Bar Chart"
},
"moduleName": "water/measurement/ReadingBarChartTaskbarButtonHandler",
"ordinal": 10,
"darkIcon": "/ibm/water/widgets/images/taskbar/dark/BarChart.png",
"greyIcon": "/ibm/water/widgets/images/taskbar/light/BarChart.png",
"globalName": "ReadingBarChartView",
"selectedIcon": "/ibm/water/widgets/images/taskbar/selected/BarChart.png",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
},
{
"id": 54,
"buttonName": "ReadingLineChartView",
"label": {
"group": "SunshineTheme",
"key": "ReadingLineChartView",
"i18nLabel": "Reading Line Chart"
},
"moduleName": "water/measurement/ReadingLineChartTaskbarButtonHandler",
"ordinal": 10,
"darkIcon": "/ibm/water/widgets/images/taskbar/dark/LineChart.png",
"greyIcon": "/ibm/water/widgets/images/taskbar/light/LineChart.png",
"globalName": "ReadingLineChartView",
"selectedIcon": "/ibm/water/widgets/images/taskbar/selected/LineChart.png",
"authorizations": [
"SunshineAdmin",
"SunshineOperator",
"SolutionAdmins",
"SystemAdmins"
]
}
]
}
],
"page": "Sunshine.OperatorOperations"
}
]Коды возврата HTTP
Метод HTTP GET возвращает следующие коды состояния:
| Код | Описание |
|---|---|
| 200 | ОК |
| 401 | Не авторизовано |
| 403 | Запрещено |
| 404 | Не найдено |
| 500 | Внутренняя ошибка сервера. |