dashboard.get

תיאור

integer/array dashboard.get(object parameters)

השיטה מאפשרת לשלוף לוחות מחוונים בהתאם לנתון פרמטרים.

שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.

פרמטרים

(object) פרמטרים המגדירים את הפלט הרצוי.

השיטה תומכת בפרמטרים הבאים.

פרמטר סוג תיאור
dashboardids string/array החזר רק לוחות מחוונים עם המזהים הנתונים.
selectPages query החזר מאפיין pages עם דפי לוח מחוונים בסדר נכון.
selectUsers query החזר מאפיין משתמשים עם משתמשים שאיתם לוח המחוונים משותף.
selectUserGroups query החזר מאפיין userGroups עם קבוצות משתמשים שאיתן לוח המחוונים משותף.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערך אפשרי הוא: dashboardid.
countOutput boolean הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף פרשנות הפניה.
עריכה בוליאנית
excludeSearch בולאני
filter object
limit מספר שלם
פלט שאילתה
preservekeys בולאני
חיפוש אובייקט
searchByAny boolean
searchWildcardsEnabled boolean
sortorder מחרוזת/מערך
startSearch boolean

החזר ערכים

(מספר שלם/מערך) מחזיר אחד:

  • מערך של חפצים;
  • ספירת האובייקטים שאוחזרו, אם יש לפרמטר countOutput נעשה שימוש.

דוגמאות

החזר ערכים

(מספר שלם/מערך) מחזיר אחד:

  • מערך של חפצים;
  • ספירת האובייקטים שאוחזרו, אם יש לפרמטר countOutput נעשה שימוש.

מידע נוסף

מקור

CDashboard::get()‎ בתוך ui/include/classes/api/services/CDashboard.php.