4.3.1. ProjectsList

Описание

Метод возвращает список доступных проектов для пользователя с указанным user_id. Также отображается дополнительная информация о роли пользователя, количестве активных зондов и задач в проекте.

Запрос

{
  "user_id":(number),
  "methods":[
    {
      "method":"ProjectsList",
      "params":{
        "type":(string),
        "limit_value":(number),
        "page":(number)
      }
    }
  ]
}

где:

• user_id — целое число, идентификатор пользователя;

• type (опциональное поле) — строка, фильтр списка проектов. Список доступных фильтров:

  • own — владельцем которых является пользователь,

  • shared — к которым пользователю был предоставлен совместный доступ,

  • all — значение по умолчанию, все доступные пользователю проекты.

• limit_value (опциональное поле) — целое число, максимальное количество проектов в ответе, позволяет разбивать результат на страницы. Значение по умолчанию — 25;

• page (опциональное поле) — целое число, выбор страницы с результатом. Значение по умолчанию — 1.

Ответ

{
"reply":[
    {
    "method":"ProjectsList",
    "result":{
        "projects":[
        {
            "id":(number),
            "name":(string),
            "founder":(string),
            "role":(string),
            "live_apps_count":(number),
            "live_channels_count":(number),
            "live_streams_count":(number)
        }
        ],
        "current_page":(number),
        "total_pages":(number),
        "limit_value":(number)
      }
    }
  ]
}

где:

• id — целое число, идентификатор пользователя;

• name — строка, название проекта;

• founder — строка, имя владельца проекта или его email;

• role — строка, роль пользователя в проекте (подробнее в настройках проекта ➝ Организация совместного доступа):

  • owner — пользователь является владельцем проекта,

  • admin — пользователю предоставлен совместный доступ к проекту с правами администратора,

  • user — пользователю предоставлен совместный доступ к проекту с правами наблюдателя,

  • unknown — роль не определена. Запрос осуществляется для пользователя с правами Суперадмина (имеет доступ ко всем проектам, подробнее Глобальные роли).

• live_apps_count — целое число, количество активных зондов в проекте;

• live_channels_count — целое число, количество активных задач в проекте;

• live_streams_count — целое число, количество лицензируемых потоков (см. Система лицензирования);

• current_page — целое число, отображаемая страница результата;

• total_pages — целое число, суммарное количество страниц результата при заданном limit_value;

• limit_value — целое число, максимальное количество проектов в ответе.

Пример

Запрос утилитой cURL

curl http://172.16.1.41/ctrl_api/v1/json \
   -H "Content-Type: application/json" \
   --data '{"user_id":1,"methods":[{"method":"ProjectsList","params":{"type":"all","limit_value":20,"page":1}}]}'

Ответ

 {
   "reply": [
     {
       "method": "ProjectsList",
       "result": {
         "projects": [
           {
             "id": 1,
             "name": "Boro VoD Test",
             "founder": "Superadmin",
             "role": "owner",
             "live_apps_count": 2,
             "live_streams_count": 0,
             "live_channels_count": 0
           }
         ],
         "current_page": 1,
         "total_pages": 1,
         "limit_value": 20
       }
     }
   ]
 }