תמונה.קבל

תיאור

integer/array image.get(object parameters)

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

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

פרמטרים

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

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

פרמטר סוג תיאור
imageids string/array החזר רק תמונות עם המזהים הנתונים.
sysmapids string/array החזר תמונות המשמשות במפות הנתונות.
select_image flag החזר מאפיין image עם התמונה המקודדת Base64.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

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

החזר ערכים

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

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

דוגמאות

אחזר תמונה

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

בַּקָשָׁה:

{
     "jsonrpc": "2.0",
     "method": "image.get",
     "params": {
         "output": "להרחיב",
         "select_image": נכון,
         "imageids": "2"
     },
     "auth": "038e1d7b1735c6a5436ee9eae095879e",
     "מזהה": 1
}

תְגוּבָה:

{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "imageid": "2",
             "imagetype": "1",
             "name": "Cloud_(24)",
             /aTJbhJ/TNkWc9/xXW592Xb9iPkKnUfH8BKdLgFy0lDyQAAAAASUVORK5CYII="
         }
     ],
     "מזהה": 1
}

מקור

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