Sidebar

ru:manual:api:reference:screen:create

screen.create

Описание

объект screen.create(объект/массив комплексныеЭкраны)

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

Параметры

(объект/массив) Создаваемые комплексные экраны.

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

Параметр Тип Описание
screenitems массив Создаваемые элементы комплексного экрана для комплексного экрана.
users массив Пользователь комплексного экрана, которому будет предоставлен общий доступ к комплексному экрану.
userGroups массив Группа пользователей комплексного экрана, которой будет предоставлен общий доступ к комплексному экрану.

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

(объект) Возвращает объект, который содержит ID созданных комплексных экранов под свойством screenids. Порядок возвращаемых ID совпадает с порядком переданных комплексных экранов.

Примеры

Создание комплексного экрана

Создание комплексного экрана с именем “Graphs” и размером в 2 строки и 3 колонки и добавление графика в верхнюю левую ячейку.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "screen.create",
    "params": {
        "name": "Graphs",
        "hsize": 3,
        "vsize": 2,
        "screenitems": [
            {
                "resourcetype": 0,
                "resourceid": "612",
                "rowspan": 1,
                "colspan": 1,
                "x": 0,
                "y": 0
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

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

Общий доступ к комплексному экрану

Создание комплексного экрана с двумя типами общего доступа (пользователю и группе пользователей).

Запрос:

{
    "jsonrpc": "2.0",
    "method": "screen.create",
    "params": {
        "name": "Screen sharing",
        "hsize": 3,
        "vsize": 2,
        "users": [
            {
                "userid": "4",
                "permission": "3"
            }
        ],
        "userGroups": [
            {
                "usrgrpid": "7",
                "permission": "2"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

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

Смотрите также

Исходный код

CScreen::create() в frontends/php/include/classes/api/services/CScreen.php.