mediatype.get

תיאור

integer/array mediatype.get(object parameters)

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

פרמטרים

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

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

החזר ערכים

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

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

דוגמאות

החזר ערכים

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

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

Retrieving media types as Admin

As an Admin type user, retrieve all media types that are enabled, with users that use these media types. The following example returns two media types:

• email media type with one user (since Zabbix 6.0.34, only Admin type user's own user);
• SMS media type with no users.

Request:

{
    "jsonrpc": "2.0",
    "method": "mediatype.get",
    "params": {
        "output": "extend",
        "filter": {
            "status": 0
        },
        "selectUsers": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "mediatypeid": "1",
            "type": "0",
            "name": "Email",
            "status": "0",
            "description": "",
            "maxattempts": "3",
            "users": [
                {
                    "userid": "3",
                    "username": "database-admin",
                    "name": "John",
                    "surname": "Doe",
                    "url": "",
                    "autologin": "0",
                    "autologout": "0",
                    "lang": "default",
                    "refresh": "30s",
                    "theme": "default",
                    "attempt_failed": "0",
                    "attempt_ip": "",
                    "attempt_clock": "0",
                    "rows_per_page": "50",
                    "timezone": "default",
                    "roleid": "2"
                }
            ]
        },
        {
            "mediatypeid": "3",
            "type": "2",
            "name": "SMS",
            "status": "0",
            "description": "",
            "maxattempts": "3",
            "users": []
        }
    ],
    "id": 1
}

מידע נוסף

• משתמש

מקור

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