[comment]: # translation:outdated

[comment]: # ({7925fa72-7925fa72})
# report.get

[comment]: # ({/7925fa72-7925fa72})

[comment]: # ({c4ffda2f-22ec64b6})
### Beschreibung

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

Mit dieser Methode können geplante Berichte entsprechend den angegebenen
Parametern abgerufen werden.

::: noteclassic
Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen
zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter [Benutzerrollen](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/c4ffda2f-22ec64b6})

[comment]: # ({9bbdf58d-2bc4ba55})
### Parameter

`(object)` Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|reportids|ID/array|Gibt nur geplante Berichte mit den angegebenen Berichts-IDs zurück.|
|expired|boolean|Wenn auf `true` gesetzt, werden nur abgelaufene geplante Berichte zurückgegeben.|
|selectUsers|query|Gibt eine Eigenschaft [`users`](/manual/api/reference/report/object#users) mit Benutzern zurück, an die der Bericht gesendet werden soll.|
|selectUserGroups|query|Gibt eine Eigenschaft [`user_groups`](/manual/api/reference/report/object#user-groups) mit Benutzergruppen zurück, an die der Bericht gesendet werden soll.|
|sortfield|string/array|Sortiert das Ergebnis nach den angegebenen Eigenschaften.<br><br>Mögliche Werte: `reportid`, `name`, `status`.|
|countOutput|boolean|Diese Parameter sind in der [Referenzkommentierung](/manual/api/reference_commentary#common-get-method-parameters) beschrieben.|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/9bbdf58d-2bc4ba55})

[comment]: # ({7223bab1-7223bab1})
### Rückgabewerte

`(integer/array)` Gibt entweder Folgendes zurück:

-   ein Array von Objekten;
-   die Anzahl der abgerufenen Objekte, wenn der Parameter `countOutput` verwendet wurde.

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

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

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

[comment]: # ({65ef8cf5-b7379080})
#### Abrufen von Berichtsdaten

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

```json
{
    "jsonrpc": "2.0",
    "method": "report.get",
    "params": [
        "output": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "extend",
        "reportids": ["1", "2"]
    ],
    "id": 1
}
```

Antwort:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "reportid": "1",
            "userid": "1",
            "name": "Weekly report",
            "dashboardid": "1",
            "period": "1",
            "cycle": "1",
            "start_time": "43200",
            "weekdays": "31",
            "active_since": "2021-04-01",
            "active_till": "2021-08-31",
            "subject": "Weekly report",
            "message": "Report accompanying text",
            "status": "1",
            "description": "Report description",
            "state": "1",
            "lastsent": "1613563219",
            "info": "",
            "users": [
                {
                    "userid": "1",
                    "access_userid": "1",
                    "exclude": "0"
                },
                {
                    "userid": "2",
                    "access_userid": "0",
                    "exclude": "1"
                }
            ],
            "user_groups": [
                {
                    "usrgrpid": "7",
                    "access_userid": "0"
                }
            ]
        },
        {
            "reportid": "2",
            "userid": "1",
            "name": "Monthly report",
            "dashboardid": "2",
            "period": "2",
            "cycle": "2",
            "start_time": "0",
            "weekdays": "0",
            "active_since": "2021-05-01",
            "active_till": "",
            "subject": "Monthly report",
            "message": "Report accompanying text",
            "status": "1",
            "description": "",
            "state": "0",
            "lastsent": "0",
            "info": "",
            "users": [
                {
                    "userid": "1",
                    "access_userid": "1",
                    "exclude": "0"
                }
            ],
            "user_groups": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/65ef8cf5-b7379080})

[comment]: # ({7dcda109-7b8422b2})
### Siehe auch

-   [Benutzer](/manual/api/reference/user/object#users)
-   [Benutzergruppen](/manual/api/reference/user/object#user-groups)

[comment]: # ({/7dcda109-7b8422b2})

[comment]: # ({de82795f-de82795f})
### Quelle

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

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