[comment]: # translation:outdated

[comment]: # ({02ea8022-02ea8022})
# usermacro.get

[comment]: # ({/02ea8022-02ea8022})

[comment]: # ({78b5ab06-28befc82})
### Opis

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

Ta metoda umożliwia pobieranie makr hosta i makr globalnych zgodnie z podanymi
parametrami.

::: noteclassic
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia
do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji [Role
użytkowników](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/78b5ab06-28befc82})

[comment]: # ({0f02ef4c-141835f9})
### Parametry

`(object)` Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

|Parametr|[Typ](/manual/api/reference_commentary#data-types)|Opis|
|--|--|------|
|globalmacro|flag|Zwraca makra globalne zamiast makr hosta.|
|globalmacroids|ID/array|Zwraca tylko makra globalne o podanych identyfikatorach.|
|groupids|ID/array|Zwraca tylko makra hosta należące do hostów lub szablonów z podanych grup hostów lub grup szablonów.|
|hostids|ID/array|Zwraca tylko makra należące do podanych hostów lub szablonów.|
|hostmacroids|ID/array|Zwraca tylko makra hosta o podanych identyfikatorach.|
|inherited|boolean|Jeśli ustawione na `true`, zwraca tylko makra użytkownika prototypu hosta dziedziczone z szablonu.|
|selectHostGroups|query|Zwraca grupy hostów, do których należy makro hosta, we właściwości [`hostgroups`](/manual/api/reference/hostgroup/object).<br><br>Używane tylko podczas pobierania makr hosta.|
|selectHosts|query|Zwraca hosty, do których należy makro hosta, we właściwości [`hosts`](/manual/api/reference/host/object).<br><br>Używane tylko podczas pobierania makr hosta.|
|selectTemplateGroups|query|Zwraca grupy szablonów, do których należy makro szablonu, we właściwości [`templategroups`](/manual/api/reference/templategroup/object).<br><br>Używane tylko podczas pobierania makr szablonu.|
|selectTemplates|query|Zwraca szablony, do których należy makro hosta, we właściwości [`templates`](/manual/api/reference/template/object).<br><br>Używane tylko podczas pobierania makr hosta.|
|sortfield|string/array|Sortuje wynik według podanych właściwości.<br><br>Możliwe wartości: `macro`.|
|countOutput|boolean|Te parametry opisano w [komentarzu referencyjnym](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/0f02ef4c-141835f9})

[comment]: # ({7223bab1-7223bab1})
### Zwracane wartości

`(integer/array)` Zwraca:

-   tablicę obiektów;
-   liczbę pobranych obiektów, jeśli został użyty parametr `countOutput`.

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

[comment]: # ({b41637d2-b41637d2})
### Przykłady

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

[comment]: # ({4540e2f0-7089e052})
#### Pobieranie makr hosta dla hosta

Pobierz wszystkie makra hosta zdefiniowane dla hosta „10198”.

[Żądanie](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10198"
    },
    "id": 1
}
```

Odpowiedź:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostmacroid": "9",
            "hostid": "10198",
            "macro": "{$INTERFACE}",
            "value": "eth0",
            "description": "",
            "type": "0",
            "automatic": "0"
        },
        {
            "hostmacroid": "11",
            "hostid": "10198",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0",
            "automatic": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/4540e2f0-7089e052})

[comment]: # ({885a2441-f0872791})
#### Pobieranie makr hosta dla szablonu

Pobierz makra hosta zdefiniowane dla szablonu „10265”, które zawierają „STATUS” w nazwie makra.

[Żądanie](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10265",
        "search": {
            "macro": "STATUS"
        }
    },
    "id": 1
}
```

Odpowiedź:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostmacroid": "6709",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.HOST}",
            "value": "",
            "description": "Nazwa hosta lub adres IP hosta strony statusu Apache.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "1",
                "priority": "1",
                "section_name": "",
                "label": "Host statusu Apache",
                "description": "Nazwa hosta lub adres IP hosta strony statusu Apache.",
                "required": "1",
                "regex": "",
                "options": []
            }
        },
        {
            "hostmacroid": "814",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.PATH}",
            "value": "server-status?auto",
            "description": "Ścieżka URL strony statusu Apache.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "1",
                "priority": "3",
                "section_name": "",
                "label": "Ścieżka strony statusu Apache",
                "description": "Ścieżka URL strony statusu Apache.",
                "required": "1",
                "regex": "",
                "options": []
            }
        },
        {
            "hostmacroid": "815",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.PORT}",
            "value": "80",
            "description": "Port strony statusu Apache.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "1",
                "priority": "2",
                "section_name": "",
                "label": "Port strony statusu Apache",
                "description": "W zakresie od 1 do 65535 włącznie.",
                "required": "1",
                "regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",
                "options": []
            }
        },
        {
            "hostmacroid": "816",
            "hostid": "10265",
            "macro": "{$APACHE.STATUS.SCHEME}",
            "value": "http",
            "description": "Schemat żądania, którym może być HTTP lub HTTPS.",
            "type": "0",
            "automatic": "0",
            "config": {
                "type": "2",
                "priority": "4",
                "section_name": "",
                "label": "Schemat żądania",
                "description": "Schemat żądania, którym może być HTTP lub HTTPS.",
                "required": "0",
                "regex": "",
                "options": [
                    {
                        "value": "http",
                        "text": "HTTP"
                    },
                    {
                        "value": "https",
                        "text": "HTTPS"
                    }
                ]
            }
        }
    ],
    "id": 1
}
```

[comment]: # ({/885a2441-f0872791})

[comment]: # ({93c3e1f5-29b64a7a})
#### Pobieranie makr globalnych

Pobierz wszystkie makra globalne.

[Żądanie](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "globalmacro": true
    },
    "id": 1
}
```

Odpowiedź:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "globalmacroid": "6",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/93c3e1f5-29b64a7a})

[comment]: # ({26db0ec2-26db0ec2})
### Źródło

CUserMacro::get() w *ui/include/classes/api/services/CUserMacro.php*.

[comment]: # ({/26db0ec2-26db0ec2})