[comment]: # translation:outdated

[comment]: # ({16011390-16011390})
# mediatype.get

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

[comment]: # ({c6192697-10e7fdda})
### תיאור

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

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

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

[comment]: # ({/c6192697-10e7fdda})

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

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

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

|פרמטר|[סוג](/manual/api/reference_commentary#data_types)|תיאור|
|--|--|------|
|mediatypeids|string/array|החזר רק סוגי מדיה עם המזהים הנתונים.|
|mediaids|string/array|החזר רק סוגי מדיה המשמשים את המדיה הנתונה.|
|userids|string/array|החזר רק סוגי מדיה המשמשים את המשתמשים הנתונים.|
|selectMessageTemplates|query|החזר מאפיין [message\_templates](/manual/api/reference/mediatype/object#Message_template) עם מערך של הודעות מסוג מדיה.|
|selectUsers|query|החזר מאפיין [משתמשים](//manual/api/reference/user/object) עם המשתמשים שמשתמשים בסוג המדיה.|
|sortfield|string/array|מיין את התוצאה לפי המאפיינים הנתונים.<br><br>ערכים אפשריים הם: `mediatypeid`.|
|countOutput|boolean|הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט ב[פירוש ההתייחסות](/manual/api/reference_commentary#common_get_method_parameters).|
|עריכה|בוליאנית|^|
|excludeSearch|בולאני|^|
|filter|object|^|
|limit|מספר שלם|^|
|פלט|שאילתה|^|
|preservekeys|בולאני|^|
|חיפוש|אובייקט|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|בוליאני|^|
|sortorder|מחרוזת/מערך|^|
|startSearch|boolean|^|

[comment]: # ({/83836618-dde2e026})

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

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

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

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

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

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

[comment]: # ({7e63506a-173c5ab7})
### החזר ערכים

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

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

[comment]: # ({/7e63506a-173c5ab7})

[comment]: # ({new-59a804aa})
#### 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.4.19, only *Admin* type user's own user);
- SMS media type with no users.

[Request](/manual/api#performing-requests):

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

Response:

```json
{
    "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",
                    "userdirectoryid": "0",
                    "ts_provisioned": "0"
                }
            ]
        },
        {
            "mediatypeid": "3",
            "type": "2",
            "name": "SMS",
            "status": "0",
            "description": "",
            "maxattempts": "3",
            "users": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/new-59a804aa})

[comment]: # ({new-621ff52f})

#### Retrieve script and webhook media types

The following example returns three media types:

-   script media type with parameters;
-   script media type without parameters;
-   webhook media type with parameters.

[Request](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "mediatype.get",
    "params": {
        "output": ["mediatypeid", "name", "parameters"],
        "filter": {
            "type": [1, 4]
        }
    },
    "id": 1
}
```

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "mediatypeid": "10",
            "name": "Script with parameters",
            "parameters": [
                {
                    "sortorder": "0",
                    "value": "{ALERT.SENDTO}"
                },
                {
                    "sortorder": "1",
                    "value": "{EVENT.NAME}"
                },
                {
                    "sortorder": "2",
                    "value": "{ALERT.MESSAGE}"
                },
                {
                    "sortorder": "3",
                    "value": "Zabbix alert"
                }
            ]
        },
        {
            "mediatypeid": "13",
            "name": "Script without parameters",
            "parameters": []
        },
        {
            "mediatypeid": "11",
            "name": "Webhook",
            "parameters": [
                {
                    "name": "alert_message",
                    "value": "{ALERT.MESSAGE}"
                },
                {
                    "name": "event_update_message",
                    "value": "{EVENT.UPDATE.MESSAGE}"
                },
                {
                    "name": "host_name",
                    "value": "{HOST.NAME}"
                },
                {
                    "name": "trigger_description",
                    "value": "{TRIGGER.DESCRIPTION}"
                },
                {
                    "name": "trigger_id",
                    "value": "{TRIGGER.ID}"
                },
                {
                    "name": "alert_source",
                    "value": "Zabbix"
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/new-621ff52f})

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

-   [משתמש](/manual/api/reference/user/object#user)

[comment]: # ({/039ccba1-039ccba1})

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

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

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