integer/array templatedashboard.get(object parameters)
השיטה מאפשרת לאחזר לוחות מחוונים של תבניות בהתאם לנתון פרמטרים.
שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.
(object)
פרמטרים המגדירים את הפלט הרצוי.
השיטה תומכת בפרמטרים הבאים.
פרמטר | סוג | תיאור |
---|---|---|
dashboardids | string/array | החזר רק לוחות מחוונים של תבניות עם המזהים הנתונים. |
templateids | string/array | החזר רק לוחות מחוונים של תבניות השייכים לתבניות הנתונות. |
selectPages | query | החזר מאפיין pages עם דפי לוח מחוונים של תבנית, בסדר נכון. |
sortfield | string/array | מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: dashboardid וname . |
countOutput | boolean | הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות. |
עריכה | בוליאנית | |
excludeSearch | בולאני | |
filter | object | |
limit | מספר שלם | |
פלט | שאילתה | |
preservekeys | בולאני | |
חיפוש | אובייקט | |
searchByAny | boolean | |
searchWildcardsEnabled | בוליאני | |
sortorder | מחרוזת/מערך | |
startSearch | boolean |
(מספר שלם/מערך)
מחזיר אחד:
countOutput
נעשה שימוש.אחזר את כל לוחות המחוונים של התבניות עם ווידג'טים עבור תבנית שצוינה.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "templatedashboard.get",
"params": {
"output": "להרחיב",
"selectPages": "להרחיב",
"templateids": "10001"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}
תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"dashboardid": "23",
"name": "סקירת דוקר",
"templateid": "10001",
"display_period": "30",
"auto_start": "1",
"uuid": "6dfcbe0bc5ad400ea9c1c2dd7649282f",
"עמודים": [
{
"dashboard_pageid": "1",
"שם": "",
"display_period": "0",
"יישומונים": [
{
"widgetid": "220",
"type": "גרף",
"שם": "",
"x": "0",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"שדות": [
{
"type": "6",
"name": "גרפיד",
"value": "1125"
}
]
},
{
"widgetid": "221",
"type": "גרף",
"שם": "",
"x": "12",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"שדות": [
{
"type": "6",
"name": "גרפיד",
"value": "1129"
}
]
},
{
"widgetid": "222",
"type": "גרף",
"שם": "",
"x": "0",
"y": "5",
"width": "12",
"height": "5",
"view_mode": "0",
"שדות": [
{
"type": "6",
"name": "גרפיד",
"value": "1128"
}
]
},
{
"widgetid": "223",
"type": "גרף",
"שם": "",
"x": "12",
"y": "5",
"width": "12",
"height": "5",
"view_mode": "0",
"שדות": [
{
"type": "6",
"name": "גרפיד",
"value": "1126"
}
]
},
{
"widgetid": "224",
"type": "גרף",
"שם": "",
"x": "0",
"y": "10",
"width": "12",
"height": "5",
"view_mode": "0",
"שדות": [
{
"type": "6",
"name": "גרפיד",
"value": "1127"
}
]
}
]
}
]
}
],
"מזהה": 1
}
CTemplateDashboard::get() בתוך ui/include/classes/api/services/CTemplateDashboard.php.