report.create

Описание

object report.create(объект/массив reports)

Этот метод позволяет создавать новые запланированные отчеты.

Параметры

(object/array) Запланированные отчёты для создания.

В дополнение к стандартным свойствам запланированного отчёта, метод принимает следующие параметры.

Возвращаемые значения

(object) Возвращает объект, содержащий идентификаторы созданных запланированных отчётов в свойстве reportids. Порядок возвращаемых идентификаторов соответствует порядку переданных запланированных отчётов.

Примеры

Создание запланированного отчета

Создайте еженедельный отчет, который будет формироваться за предыдущую неделю каждый понедельник-пятницу в 12:00 с 2021-04-01 по 2021-08-31.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "report.create",
    "params": {
        "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",
        "users": [
            {
                "userid": "1",
                "access_userid": "1",
                "exclude": "0"
            },
            {
                "userid": "2",
                "access_userid": "0",
                "exclude": "1"
            }
        ],
        "user_groups": [
            {
                "usrgrpid": "7",
                "access_userid": "0"
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "reportids": [
            "1"
        ]
    },
    "id": 1
}

См. также

• Пользователи
• Группы пользователей

Источник

CReport::create() в ui/include/classes/api/services/CReport.php.