[comment]: # translation:outdated

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

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

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

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

Deze methode maakt het mogelijk om host- en globale macro's op te halen volgens de opgegeven parameters.

::: noteclassic
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen kunnen worden ingetrokken in gebruikersrolinstellingen. Zie [Gebruikersrollen](/manual/web_interface/frontend_sections/users/user_roles) voor meer informatie.
:::

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

[comment]: # ({0bf7ebec-141835f9})
### Parameters

`(object)` Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

|Parameter|[Type](/manual/api/reference_commentary#data_types)|Omschrijving|
|--|--|------|
|globalmacro|flag|Retourneer globale macro's in plaats van hostmacro's.|
|globalmacroids|string/array|Retourneer alleen globale macro's met de opgegeven ID's.|
|groupids|string/array|Retourneer alleen hostmacro's die behoren tot hosts of sjablonen uit de opgegeven hostgroepen of sjabloongroepen.|
|hostids|string/array|Retourneer alleen macro's die behoren tot de opgegeven hosts of sjablonen.|
|hostmacroids|string/array|Retourneer alleen hostmacro's met de opgegeven ID's.|
|inherited|boolean|Indien ingesteld op `true`, retourneer alleen gebruikersmacro's van hostprototypes die zijn overgeërfd van een sjabloon.|
|selectHostGroups|query|Retourneer hostgroepen waartoe de hostmacro behoort in de eigenschap [hostgroups](/manual/api/reference/hostgroup/object).<br><br>Alleen gebruikt bij het ophalen van hostmacro's.|
|selectHosts|query|Retourneer hosts waartoe de hostmacro behoort in de eigenschap [hosts](/manual/api/reference/host/object).<br><br>Alleen gebruikt bij het ophalen van hostmacro's.|
|selectTemplateGroups|query|Retourneer sjabloongroepen waartoe de sjabloonmacro behoort in de eigenschap [templategroups](/manual/api/reference/templategroup/object).<br><br>Alleen gebruikt bij het ophalen van sjabloonmacro's.|
|selectTemplates|query|Retourneer sjablonen waartoe de hostmacro behoort in de eigenschap [templates](/manual/api/reference/template/object).<br><br>Alleen gebruikt bij het ophalen van hostmacro's.|
|sortfield|string/array|Sorteer het resultaat op de opgegeven eigenschappen.<br><br>Mogelijke waarden: `macro`.|
|countOutput|boolean|Deze parameters zijn gemeenschappelijk voor alle `get`-methoden en worden in detail beschreven op de [reference commentary](/manual/api/reference_commentary#common_get_method_parameters) pagina.|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectGroups<br>(verouderd)|query|Deze parameter is verouderd, gebruik in plaats daarvan `selectHostGroups` of `selectTemplateGroups`.<br>Retourneer hostgroepen en sjabloongroepen waartoe de hostmacro behoort in de eigenschap `groups`.<br><br>Alleen gebruikt bij het ophalen van hostmacro's.|

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

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

`(integer/array)` Retourneert ofwel:

- een reeks objecten;
- het aantal opgehaalde objecten, als de `countOutput` parameter heeft
    gebruikt.

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

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

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

[comment]: # ({4540e2f0-7089e052})
#### Ophalen van hostmacro's voor een host

Haal alle hostmacro's op die zijn gedefinieerd voor host "10198".

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

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

Reactie:

```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]: # ({93c3e1f5-29b64a7a})
#### Ophalen van globale macro's

Haal alle globale macro's op.

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

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

Reactie:

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

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

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

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

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