iconmap.get

תיאור

integer/array iconmap.get(object parameters)

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

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

פרמטרים

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

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

פרמטר סוג תיאור
iconmapids string/array החזר רק מפות אייקונים עם המזהים הנתונים.
sysmapids string/array החזר רק מפות אייקונים שנמצאות בשימוש במפות הנתונות.
selectMappings query החזר מאפיין מיפויים עם מיפויי הסמלים שבהם נעשה שימוש.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

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

החזר ערכים

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

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

דוגמאות

אחזר מפת אייקונים

אחזר את כל הנתונים על מפת הסמלים "3".

בַּקָשָׁה:

{
     "jsonrpc": "2.0",
     "method": "iconmap.get",
     "params": {
         "iconmapids": "3",
         "output": "להרחיב",
         "selectMappings": "להרחיב"
     },
     "auth": "038e1d7b1735c6a5436ee9eae095879e",
     "מזהה": 1
}

תְגוּבָה:

{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "מיפויים": [
                 {
                     "iconmappingid": "3",
                     "iconmapid": "3",
                     "iconid": "6",
                     "inventory_link": "1",
                     "expression": "שרת",
                     "sortorder": "0"
                 },
                 {
                     "iconmappingid": "4",
                     "iconmapid": "3",
                     "iconid": "10",
                     "inventory_link": "1",
                     "expression": "מתג",
                     "sortorder": "1"
                 }
             ],
             "iconmapid": "3",
             "name": "סמלים מסוג מארח",
             "default_iconid": "2"
         }
     ],
     "מזהה": 1
}

מידע נוסף

מקור

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