Кампании

Кампании позволяют объединять разные объекты для удобства и для упрощения получения сводной статистики.

Список кампаний

{

 "action" : "campaign.list" 

}

ответ

{

  <общие поля>

 ,"list" : [

             {

                "id"   : идентификатор кампании

               ,"name" : "название кампании" 

             }

             ...

           ]

}

Чтение кампании

{

 "action" : "campaign.get" 

 ,"id" : идентификатор кампании

}

ответ

{

  <общие поля>

 ,"obj" : {
           "id"   : идентификатор кампании

           ,"name" : "название кампании" 

           ,"descr" : "описание кампании" 

           }
}

Создание/Изменение кампании

При изменении существующей кампании обновляются только указанные в запросе поля.

{

 "action" : "campaign.set" 

 ,"id"   : идентификатор кампании -- при отсутствии создаётся новая кампания

 ,"obj" : {

           "name" : "название кампании" -- при создании обязательно

          ,"descr" : "описание кампании" 

          }

  -- не обязательно

 ,"return_fresh_obj" : 0|1
}

ответ

{

  <общие поля>

 ,"id"   : идентификатор кампании -- при создании

}

Удаление кампании

{

 "action" : "campaign.delete" 

 ,"id" : идентификатор кампании
}

ответ

{

  <общие поля>

}

Список объектов кампании

{

 "action" : "campaign.member.list" 

,"id" : идентификатор кампании

}

ответ

{

  <общие поля>

,"list" : [

           {

            "type" : "тип объекта" 

           ,"id"   : "идентификатор объекта" 

           }

          ..............
          ]
}

Добавить объект в кампанию

Объект может входить в состав нескольких кампаний.

{

 "action" : "campaign.member.add" 

,"id" : идентификатор кампании

,"obj" : {
          "type" : "issue|cron|split|form|sequence|linkgroup|datarow" -- тип объекта

         ,"id"   : "идентификатор объекта" 
         }
}

ответ

{

  <общие поля>

}

Удалить объект из кампании

{

 "action" : "campaign.member.delete" 

,"id" : идентификатор кампании

,"obj" : {
          "type" : "тип объекта" 

         ,"id"   : "идентификатор объекта" 
         }
}

ответ

{

  <общие поля>

}