correlation.get

תיאור

integer/array correlation.get(object parameters)

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

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

פרמטרים

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

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

פרמטר סוג תיאור
correlationids מחרוזת/מערך החזר רק מתאמים עם המזהים הנתונים.
selectFilter query החזר מאפיין filter עם תנאי המתאם.
selectOperations query החזר מאפיין operations עם פעולות המתאם.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

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

החזר ערכים

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

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

דוגמאות

אחזר מתאמים

אחזר את כל המתאמים המוגדרים יחד עם המתאם תנאים ופעולות. המסנן משתמש בסוג ההערכה "ו/או", אז המאפיין 'נוסחה' ריק ו-'eval_formula' נוצר באופן אוטומטי.

בַּקָשָׁה:

{
     "jsonrpc": "2.0",
     "method": "correlation.get",
     "params": {
         "output": "להרחיב",
         "selectOperations": "להרחיב",
         "selectFilter": "להרחיב"
     },
     "auth": "343baad4f88b4106b9b5961e77437688",
     "מזהה": 1
}

תְגוּבָה:

{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "correlationid": "1",
             "name": "מתאם 1",
             "תיאור": "",
             "status": "0",
             "מסנן": {
                 "evaltype": "0",
                 "נוסחה": "",
                 "תנאים": [
                     {
                         "type": "3",
                         "oldtag": "שגיאה",
                         "newtag": "בסדר",
                         "formulaid": "א"
                     }
                 ],
                 "eval_formula": "א"
             },
             "פעולות": [
                 {
                     "type": "0"
                 }
             ]
         }
     ],
     "מזהה": 1
}

מידע נוסף

מקור

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