Это старая версия документа!
Раздел в процессе разработки
/** * POST - тип метода Action'а * Desctiprion - описание Action * request([ * "method" => "тип метода", * "url" => "api/v4/controllerName/actionName", - адрес запроса * (полный путь "api/v4/controllerNameComtroller/actionNameAction") 'file' => 'описание содержимого файла в случае передачи файлом' * 'params' => [ * [ * 'name' => 'Имя параметра', * 'type' => 'Тип параметра', * 'description' => 'Описание параметра', * 'required' => 'Флаг обязателен параметр или нет' * ], * ... * ] - Параметры в случае передачи через параметры * ]) - Передаваемые в Action значения * response([ * "status" => 'Статус код ответа', * "message" => 'Сообщение ответа', * "code" => 'код ответа' * ]) - Возвращаемое значение после выполнения Action * @throws - ошибки которые могут возникать в ходе работы * * @Authorization - флаг необходимости авторизации */
/**
* Get milestones.
* request([
* 'method' => 'GET',
* 'url' => '/api/v4/milestone/get',
* 'params' => [
* [
* 'name' => 'status',
* 'type' => 'string',
* 'required' => false
* ],
* [
* 'name' => 'name',
* 'type' => 'string',
* 'required' => false
* ]
* ]
* ])
* response([
* 'status' => 'OK',
* 'message' => MilestoneEntity[]
* 'code' => 0
* ])
* @Authorization('CmsUser', 'User')
*/
/**
* POST
* Create milestone
* request([
* "method" => "POST",
* "url" => "api/v4/milestone/create",
* "params" => [
* [
* 'name' => 'name',
* 'type' => 'string',
* 'description' => 'Milestone name',
* 'required' => true
* ],
* [
* 'name' => 'description',
* 'type' => 'string' | 'null',
* 'description' => 'Milestone description',
* 'required' => false
* ],
* [
* 'name' => 'startDate',
* 'type' => 'int' | 'null',
* 'description' => 'Milestone start date',
* 'required' => false
* ],
* [
* 'name' => 'endDate',
* 'type' => 'int' | 'null',
* 'description' => 'Milestone end date',
* 'required' => false
* ]
* ]
* ])
* response([
* "status" => 200,
* "message" => MilestoneEntity
* "code" => 0
* ])
* @throws AirlayException
*
* @Authorization('CmsUser')
*/
/**
* POST
* Update milestone
* request([
* "method" => "POST",
* "url" => "api/v4/milestone/update",
* "params" => [
* [
* 'name' => 'id',
* 'type' => 'ObjectId',
* 'description' => 'Milestone id',
* 'required' => true
* ],
* [
* 'name' => 'name',
* 'type' => 'string' | 'null',
* 'description' => 'Milestone name',
* 'required' => false
* ],
* [
* 'name' => 'description',
* 'type' => 'string' | 'null',
* 'description' => 'Milestone description',
* 'required' => false
* ],
* [
* 'name' => 'startDate',
* 'type' => 'int' | 'null',
* 'description' => 'Milestone start date',
* 'required' => false
* ],
* [
* 'name' => 'endDate',
* 'type' => 'int' | 'null',
* 'description' => 'Milestone end date',
* 'required' => false
* ]
* ]
* ])
* response([
* "status" => 200,
* "message" => MilestoneEntity
* "code" => 0
* ])
* @throws AirlayException
*
* @Authorization('CmsUser')
*/
/**
* POST
* Delete milestone
* request([
* "method" => "POST",
* "url" => "api/v4/milestone/delete",
* 'params' => [
* [
* 'name' => 'id',
* 'type' => 'objectId',
* 'description' => 'milestone id',
* 'required' => true
* ]
* ]
* ])
* response([
* "status" => 200,
* "message" => Ok
* "code" => 0
* ])
* @throws AirlayException
*
* @Authorization('CmsUser')
*/
/**
* POST
* Close milestone
* request([
* "method" => "POST",
* "url" => "api/v4/milestone/closeMilestone",
* 'params' => [
* [
* 'name' => 'id',
* 'type' => 'objectId',
* 'description' => 'milestone id',
* 'required' => true
* ]
* ]
* ])
* response([
* "status" => 200,
* "message" => MilestoneEntity
* "code" => 0
* ])
* @throws AirlayException
*
* @Authorization('CmsUser')
*/
/**
* POST
* Add issues to milestone
* request([
* "method" => "POST",
* "url" => "api/v4/milestone/addIssues",
* 'params' => [
* [
* 'name' => 'id',
* 'type' => 'objectId',
* 'description' => 'milestone id',
* 'required' => true
* ],
* [
* 'name' => 'issues',
* 'type' => 'objectId[]',
* 'description' => 'issues object ids',
* 'required' => true
* ]
* ]
* ])
* response([
* "status" => 200,
* "message" => MilestoneEntity
* "code" => 0
* ])
* @throws AirlayException
*
* @Authorization('CmsUser')
*/
/**
* POST
* Remove issue from milestone
* request([
* "method" => "POST",
* "url" => "api/v4/milestone/removeIssue",
* 'params' => [
* [
* 'name' => 'id',
* 'type' => 'objectId',
* 'description' => 'milestone id',
* 'required' => true
* ],
* [
* 'name' => 'issue',
* 'type' => 'objectId',
* 'description' => 'issue object id',
* 'required' => true
* ]
* ]
* ])
* response([
* "status" => 200,
* "message" => MilestoneEntity
* "code" => 0
* ])
* @throws AirlayException
*
* @Authorization('CmsUser')
*/