[comment]: # ({8e76cf8c-8e76cf8c})
# iconmap.get

[comment]: # ({/8e76cf8c-8e76cf8c})

[comment]: # ({339631e1-04265e54})
### תיאור

`integer/array iconmap.get(object parameters)`

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

::: noteclassic
שיטה זו זמינה למשתמשים מכל סוג. הרשאות
כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה [משתמש
תפקידים](/manual/web_interface/frontend_sections/administration/user_roles)
למידע נוסף.
:::

[comment]: # ({/339631e1-04265e54})

[comment]: # ({a11aa21c-efcde208})
### פרמטרים

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

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

|פרמטר|[סוג](/manual/api/reference_commentary#data_types)|תיאור|
|--|--|------|
|iconmapids|string/array|החזר רק מפות אייקונים עם המזהים הנתונים.|
|sysmapids|string/array|החזר רק מפות אייקונים שנמצאות בשימוש במפות הנתונות.|
|selectMappings|query|החזר מאפיין [מיפויים](/manual/api/reference/iconmap/object#icon_mapping) עם מיפויי הסמלים שבהם נעשה שימוש.|
|sortfield|string/array|מיין את התוצאה לפי המאפיינים הנתונים.<br><br>ערכים אפשריים הם: `iconmapid` ו-`name`.|
|countOutput|boolean|הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט ב[פירוש ההתייחסות](/manual/api/reference_commentary#common_get_method_parameters).|
|עריכה|בוליאנית|^|
|excludeSearch|בולאני|^|
|filter|object|^|
|limit|מספר שלם|^|
|פלט|שאילתה|^|
|preservekeys|בולאני|^|
|חיפוש|אובייקט|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|בוליאני|^|
|sortorder|מחרוזת/מערך|^|
|startSearch|boolean|^|

[comment]: # ({/a11aa21c-efcde208})

[comment]: # ({7223bab1-7223bab1})
### החזר ערכים

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

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### דוגמאות

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({e9c544ac-016ff9fc})
#### אחזר מפת אייקונים

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

בַּקָשָׁה:

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

תְגוּבָה:

``` json
{
     "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
}
```

[comment]: # ({/e9c544ac-016ff9fc})

[comment]: # ({8df05cf6-8df05cf6})
### מידע נוסף

-   [מיפוי סמלים](object#icon_mapping)

[comment]: # ({/8df05cf6-8df05cf6})

[comment]: # ({2420d0f0-2420d0f0})
### מקור

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

[comment]: # ({/2420d0f0-2420d0f0})