integer/array report.get(object parameters)
השיטה מאפשרת לשלוף דוחות מתוזמנים בהתאם לנתון פרמטרים.
שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.
(object)
פרמטרים המגדירים את הפלט הרצוי.
השיטה תומכת בפרמטרים הבאים.
פרמטר | סוג | תיאור |
---|---|---|
reportids | string/array | החזר רק דוחות מתוזמנים עם מזהי הדוחות הנתונים. |
expired | boolean | אם מוגדר ל-'true' מחזיר רק דוחות מתוזמנים שפג תוקפם, אם 'false' - רק דוחות מתוזמנים פעילים. |
selectUsers | query | החזר מאפיין משתמשים שאליו מוגדר הדוח להישלח. |
selectUserGroups | query | החזר מאפיין user_groups שאליו מוגדר הדוח להישלח. |
sortfield | string/array | מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: reportid , name , status . |
countOutput | boolean | הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף פרשנות הפניה. |
excludeSearch | בולאני | |
filter | object | |
limit | מספר שלם | |
פלט | שאילתה | |
preservekeys | בולאני | |
חיפוש | אובייקט | |
searchByAny | boolean | |
searchWildcardsEnabled | בוליאני | |
sortorder | מחרוזת/מערך | |
startSearch | boolean |
(מספר שלם/מערך)
מחזיר אחד:
countOutput
נעשה שימוש.בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "report.get",
"פארמים": [
"output": "להרחיב",
"selectUsers": "להרחיב",
"selectUserGroups": "להרחיב",
"reportids": ["1", "2"]
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}
תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"reportid": "1",
"userid": "1",
"name": "דוח שבועי",
"dashboardid": "1",
"תקופה 1",
"מחזור": "1",
"start_time": "43200",
"ימי חול": "31",
"active_since": "2021-04-01",
"active_till": "2021-08-31",
"subject": "דוח שבועי",
"message": "דווח על טקסט נלווה",
"status": "1",
"description": "תיאור הדוח",
"state": "1",
"lastsent": "1613563219",
"מידע": "",
"משתמשים": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
},
{
"userid": "2",
"access_userid": "0",
"exclude": "1"
}
],
"קבוצות משתמש": [
{
"usrgrpid": "7",
"access_userid": "0"
}
]
},
{
"reportid": "2",
"userid": "1",
"name": "דוח חודשי",
"dashboardid": "2",
"period": "2",
"מחזור": "2",
"start_time": "0",
"ימי חול": "0",
"active_since": "2021-05-01",
"active_till": "",
"subject": "דוח חודשי",
"message": "דווח על טקסט נלווה",
"status": "1",
"תיאור": "",
"state": "0",
"lastsent": "0",
"מידע": "",
"משתמשים": [
{
"userid": "1",
"access_userid": "1",
"exclude": "0"
}
],
"קבוצות משתמש": []
}
],
"מזהה": 1
}
CReport::get() בתוך ui/include/classes/api/services/CReport.php.