Documentation
Table of Contents
> עצם יחס
העצמים הבאים קשורים ישירות ל־API correlation.
מתאם
לאובייקט המתאם יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| correlationid | string | (קריאה בלבד) מזהה המתאם. |
| שם (חובה) |
מחרוזת | שם המתאם. |
| description | string | תיאור המתאם. |
| status | integer | האם המתאם מופעל או מושבת. ערכים אפשריים הם: 0 - (ברירת מחדל) מופעלת; 1 - מושבת. |
שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.
פעולת מתאם
אובייקט פעולת המתאם מגדיר פעולה שתהיה מבוצע כאשר מתבצעת מתאם. יש לו את הדברים הבאים נכסים.
| Property | Type | תיאור |
|---|---|---|
| סוג (נדרש) |
מספר שלם | סוג הפעולה. ערכים אפשריים: 0 - סגור אירועים ישנים; 1 - סגור אירוע חדש. |
מסנן מתאם
אובייקט מסנן המתאם מגדיר קבוצה של תנאים שחייבים להיות נפגש כדי לבצע את פעולות המתאם המוגדרות. יש לו את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| evaltype (חובה) |
מספר שלם | שיטת הערכת מצב מסנן. ערכים אפשריים: 0 - ו/או; 1 - ו; 2 - או; 3 - ביטוי מותאם אישית. |
| תנאים (חובה) |
מערך | סט של תנאי סינון לשימוש לסינון תוצאות. |
| eval_formula | string | (לקריאה בלבד) ביטוי שנוצר שישמש להערכת תנאי סינון. הביטוי מכיל מזהים שמתייחסים לתנאי סינון ספציפיים לפי ה'נוסחה' שלו. הערך של eval_formula שווה לערך של נוסחה עבור מסננים עם ביטוי מותאם אישית. |
| formula | string | ביטוי מוגדר על ידי משתמש לשימוש להערכת תנאים של מסננים עם ביטוי מותאם אישית. הביטוי חייב להכיל מזהים שמתייחסים לתנאי סינון ספציפיים לפי ה'נוסחה' שלו. המזהים המשמשים בביטוי חייבים להתאים בדיוק לאלו שהוגדרו בתנאי הסינון: אין אפשרות להישאר ללא שימוש או להשמיט שום תנאי. נדרש עבור מסנני ביטויים מותאמים אישית. |
מצב מסנן מתאם
אובייקט תנאי מסנן המתאם מגדיר תנאי ספציפי שיש לבדוק לפני הפעלת פעולות המתאם.
| Property | Type | תיאור |
|---|---|---|
| סוג (נדרש) |
מספר שלם | סוג המצב. ערכים אפשריים: 0 - תג אירוע ישן; 1 - תג אירוע חדש; 2 - קבוצת מארח אירוע חדשה; 3 - זוג תג אירוע; 4 - ערך תג אירוע ישן; 5 - ערך תג אירוע חדש. |
| tag | string | תג אירוע (ישן או חדש). נדרש כאשר סוג התנאי הוא: 0, 1, 4, 5. |
| groupid | string | מזהה קבוצת מארח. נדרש כאשר סוג התנאי הוא: 2. |
| oldtag | string | תג אירוע ישן. נדרש כאשר סוג התנאי הוא: 3. |
| newtag | string | תג אירוע חדש. נדרש כאשר סוג התנאי הוא: 3. |
| value | string | ערך תג אירוע (ישן או חדש). נדרש כאשר סוג התנאי הוא: 4, 5. |
| formulaid | string | מזהה ייחודי שרירותי המשמש להפניה לתנאי מביטוי מותאם אישית. יכול להכיל רק אותיות רישיות. המזהה חייב להיות מוגדר על ידי המשתמש בעת שינוי תנאי הסינון, אך יופק מחדש בעת בקשתם לאחר מכן. |
| operator | integer | אופרטור תנאי. נדרש כאשר סוג התנאי הוא: 2, 4, 5. |
כדי להבין טוב יותר כיצד להשתמש במסננים עם שונים סוגי ביטויים, ראה דוגמאות על correlation.get ו שיטת correlation.create. דפים.
האופרטורים והערכים הבאים נתמכים עבור כל תנאי סוּג.
|מצב|שם תנאי|אופרטורים נתמכים|ערך צפוי| |--------|--------------|----------------|---- ----------| |2|קבוצת מארח|=, <>|מזהה קבוצת מארח.| |4|ערך תג אירוע ישן|=, <>, like, not like|string| |5|ערך תג אירוע חדש|=, <>, like, not like|string|