Documentation
Table of Contents
> עצם דוח
העצמים הבאים קשורים ישירות ל־API report.
להגיש תלונה
לאובייקט הדוח יש את המאפיינים הבאים:
| Property | Type | תיאור |
|---|---|---|
| reportid | string | (לקריאה בלבד) מזהה הדוח. |
| userid (נדרש) | string | מזהה המשתמש שיצר את הדוח. |
| שם (חובה) | מחרוזת | השם הייחודי של הדוח. |
| dashboardid (נדרש) | string | מזהה של לוח המחוונים שעליו מבוסס הדוח. |
| period | integer | תקופה שלגביה יוכן הדוח. ערכים אפשריים: 0 - (ברירת מחדל) היום הקודם; 1 - שבוע קודם; 2 - הקודם חודש; 3 - שנה קודמת. |
| cycle | integer | לוח זמנים חוזר של תקופה. ערכים אפשריים: 0 - (ברירת מחדל) מדי יום; 1 - שבועי; 2 - חודשי; 3 - שנתי . |
| start_time | integer | השעה ביום, בשניות, שבה הדוח יוכן לשליחה. ברירת מחדל: 0. |
| ימי השבוע | מספר שלם | ימי השבוע לשליחת הדוח. נדרש עבור דוחות שבועיים בלבד. ימי השבוע מאוחסנים בצורה בינארית כאשר כל סיביות מייצגות את יום השבוע המתאים. לדוגמה, 12 שווה ל-1100 בבינארי ופירושו שדוחות יישלחו כל רביעי וחמישי. ברירת מחדל: 0. |
| active_since | string | באיזה תאריך להתחיל. ערכים אפשריים: מחרוזת ריקה - (ברירת מחדל) לא צוין (מאוחסן כ-0); תאריך ספציפי ב-YYYY-MM -פורמט DD (מאוחסן כחותמת זמן של תחילת יום (00:00:00)). |
| active_till | string | באיזה תאריך להסתיים. ערכים אפשריים: מחרוזת ריקה - (ברירת מחדל) לא צוין (מאוחסן כ-0); תאריך ספציפי ב-YYYY-MM -פורמט DD (מאוחסן כחותמת זמן של סוף יום (23:59:59)). |
| subject | string | נושא ההודעה. |
| message | string | דווח על טקסט הודעה. |
| status | integer | האם הדוח מופעל או מושבת. ערכים אפשריים: 0 - מושבת; 1 - (ברירת מחדל) מופעל. |
| description | text | תיאור הדוח. |
| state | integer | (לקריאה בלבד) מצב הדוח. ערכים אפשריים: 0 - (ברירת מחדל) הדוח עדיין לא עובד; 1 - הדוח נוצר ובהצלחה נשלח לכל הנמענים; 2 - הפקת הדוחות נכשלה; "מידע" מכיל מידע שגיאה; 3 - הדוח נוצר, אך השליחה לחלק מהנמענים (או כולם) נכשלה; "מידע" מכיל מידע שגיאה. |
| lastsent | timestamp | (קריאה בלבד) חותמת Unix של הדוח האחרון שנשלח בהצלחה. |
| info | string | (לקריאה בלבד) תיאור שגיאה או מידע נוסף. |
שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.
משתמשים
לאובייקט המשתמשים יש את המאפיינים הבאים:
| Property | Type | תיאור |
|---|---|---|
| userid (נדרש) | string | מזהה המשתמש שאליו יש לשלוח את הדוח. |
| access_userid | string | מזהה המשתמש שבשמו יופק הדוח. 0 - (ברירת מחדל) צור דוח לפי נמען. |
| exclude | integer | האם להחריג את המשתמש מרשימת התפוצה. ערכים אפשריים: 0 - (ברירת מחדל) Include; 1 - Exclude. |
קבוצות משתמש
לאובייקט קבוצות המשתמשים יש את המאפיינים הבאים:
| Property | Type | תיאור |
|---|---|---|
| usrgrpid (נדרש) | מחרוזת | מזהה של קבוצת המשתמשים שאליה יש לשלוח את הדוח. |
| access_userid | string | מזהה המשתמש שבשמו יופק הדוח. 0 - (ברירת מחדל) צור דוח לפי נמען. |