valuemap.get

תיאור

integer/array valuemap.get(object parameters)

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

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

פרמטרים

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

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

פרמטר סוג תיאור
valuemapids string/array החזר רק מפות ערכים עם המזהים הנתונים.
selectMappings query החזר את מיפויי הערכים עבור מפת הערכים הנוכחית במאפיין מיפויים.

תומך ב'count'.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

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

החזר ערכים

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

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

דוגמאות

אחזור מפות ערך

אחזר את כל מפות הערכים המוגדרות.

בַּקָשָׁה:

{
     "jsonrpc": "2.0",
     "method": "valuemap.get",
     "params": {
         "output": "להרחיב"
     },
     "auth": "57562fd409b3b3b9a4d916d45207bbcb",
     "מזהה": 1
}

תְגוּבָה:

{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "valuemapid": "4",
             "name": "סטטוס החלפת סוללה APC"
         },
         {
             "valuemapid": "5",
             "name": "מצב סוללת APC"
         },
         {
             "valuemapid": "7",
             "name": "Dell Open Manage System"
         }
     ],
     "מזהה": 1
}

אחזר מפת ערך אחת עם המיפויים שלה.

בַּקָשָׁה:

{
     "jsonrpc": "2.0",
     "method": "valuemap.get",
     "params": {
         "output": "להרחיב",
         "selectMappings": "להרחיב",
         "valuemapids": ["4"]
     },
     "auth": "57562fd409b3b3b9a4d916d45207bbcb",
     "מזהה": 1
}

תְגוּבָה:

{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "valuemapid": "4",
             "name": "סטטוס החלפת סוללה APC",
             "מיפויים": [
                 {
                     "type": "0",
                     "value": "1",
                     "newvalue": "לא ידוע"
                 },
                 {
                     "type": "0",
                     "value": "2",
                     "newvalue": "לא מותקן"
                 },
                 {
                     "type": "0",
                     "value": "3",
                     "newvalue": "בסדר"
                 },
                 {
                     "type": "0",
                     "value": "4",
                     "newvalue": "נכשל"
                 },
                 {
                     "type": "0",
                     "value": "5",
                     "newvalue": "טמפרטורה גבוהה"
                 },
                 {
                     "type": "0",
                     "value": "6",
                     "newvalue": "החלף מיד"
                 },
                 {
                     "type": "0",
                     "value": "7",
                     "newvalue": "lowCapacity"
                 }
             ]
         }
     ],
     "מזהה": 1
}

מקור

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