5.4.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),
            "title":(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 - целое число, идентификатор пользователя;

• title - строка, название проекта;

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

• role - строка, роль пользователя в проекте (подробнее в руководстве пользователя Boro):

  owner - пользователь является владельцем проекта;

  admin - пользователю предоставлен совместный доступ к проекту с правами Администратора;

  user - пользователю предоставлен совместный доступ к проекту с правами Наблюдателя;

  engineer - пользователю предоставлен совместный доступ к проекту с правами Инженера;

  operator - пользователю предоставлен совместный доступ к проекту с правами Оператора;

  unknown - роль не определена. Запрос осуществляется для пользователя с правами суперпользователя (имеет доступ ко всем проектам).

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

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

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

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

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

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

Пример

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

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

Ответ

   {
   "reply":[
       {
       "method":"ProjectsList",
       "result":{
           "projects":[
           {
               "id":2,
               "title":"work",
               "founder":"Mark Twain",
               "role":"owner",
               "live_apps_count":5,
               "live_channels_count":100,
               "live_streams_count":150
           },
           {
               "id":3,
               "title":"myProject",
               "founder":"Julia Jonson",
               "role":"admin",
               "live_apps_count":2,
               "live_channels_count":5,
               "live_streams_count":5
           }
           ],
           "current_page":1,
           "total_pages":11,
           "limit_value":2
         }
       }
     ]
   }