Инструменты пользователя

Инструменты сайта


ru:airlay:api:air-lay-v4

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
ru:airlay:api:air-lay-v4 [2021/05/20 12:18]
Лев [Структура запроса]
ru:airlay:api:air-lay-v4 [2021/06/20 13:49] (текущий)
Лев [Label]
Строка 13: Строка 13:
 <code> <code>
     /**     /**
-     * POST - тип метода Action'а 
      * Desctiprion - описание Action      * Desctiprion - описание Action
      * request([      * request([
Строка 41: Строка 40:
 </code> </code>
 =====Контроллеры===== =====Контроллеры=====
 +
 +
 +
 +
 +==== Label====
 +=== getAction ===
 +<code php>
 +    /**
 +     * Get labels
 +     * request([
 +         'method' => 'GET',
 +         'url' => '/api/v4/label/get'
 +         'params' => [
 +             [
 +                 'name' => 'type',
 +                 'type' => 'string',
 +                 'description' => 'label type',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => LabelsEntity[],
 +         'code' => 0
 +     * ])
 +     *
 +     * @Authorization(['CmsUser', 'User'])
 +     *
 +     * @throws AirlayException
 +     */
 +</code>
 +
 +=== createAction ===
 +<code php>
 +    /**
 +     * Create label
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/label/create'
 +         'params' => [
 +              [
 +                 'name' => 'name',
 +                 'type' => 'string',
 +                 'description' => 'label name',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'color',
 +                 'type' => 'string',
 +                 'description' => 'label color',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'type',
 +                 'type' => 'string',
 +                 'description' => 'label type',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => LabelEntity,
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== updateAction ===
 +<code php>
 +    /**
 +     * Update label
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/label/update'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'ObjectId',
 +                 'description' => 'label id',
 +                 'required' => true
 +              ],
 +              [
 +                 'name' => 'name',
 +                 'type' => 'string'|null,
 +                 'description' => 'label name',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'color',
 +                 'type' => 'string'|null,
 +                 'description' => 'label color',
 +                 'required' => false
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => LabelEntity,
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== deleteAction ===
 +<code php>
 +    /**
 +     * Delete label
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/label/delete'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'ObjectId',
 +                 'description' => 'label id',
 +                 'required' => true
 +              ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'Ok',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +==== Issue ====
 +=== getAction ===
 +<code php>
 +    /**
 +     * Get issues
 +     * request([
 +         'method' => 'GET',
 +         'url' => '/api/v4/issue/get'
 +         'params' => [
 +              [
 +                 'name' => 'milestoneIds',
 +                 'type' => 'ObjectId[]',
 +                 'description' => 'milestones filter',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'assignIds',
 +                 'type' => 'ObjectId[]',
 +                 'description' => 'assigns filter',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'priorityIds',
 +                 'type' => 'ObjectId[]',
 +                 'description' => 'priorities filter',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'statusId',
 +                 'type' => 'ObjectId|null',
 +                 'description' => 'status id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'name',
 +                 'type' => 'string',
 +                 'description' => 'name starts with',
 +                 'required' => false
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => IssueEntity[],
 +         'code' => 0
 +     * ])
 +     *
 +     * @Authorization(['CmsUser', 'User'])
 +     */
 +</code>
 +
 +=== createAction ===
 +<code php>
 +    /**
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/create'
 +         'params' => [
 +              [
 +                 'name' => 'name',
 +                 'type' => 'string',
 +                 'description' => 'issue name',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'description',
 +                 'type' => 'string',
 +                 'description' => 'issue description',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'assignId',
 +                 'type' => 'objectId|null',
 +                 'description' => 'issue assign user id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'priorityId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'priority id',
 +                 'required' => false
 +             ],,
 +             [
 +                 'name' => 'statusId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'status id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'milestoneId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'milestone id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'endDate',
 +                 'type' => 'int'|null,
 +                 'description' => 'close date',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'spentTime',
 +                 'type' => 'int'|null,
 +                 'description' => 'spent time',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'estimatedTime',
 +                 'type' => 'int'|null,
 +                 'description' => 'estimated time',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'progress',
 +                 'type' => 'int'|null,
 +                 'description' => 'percentage of issue completed',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'parents',
 +                 'type' => 'ObjectId[]',
 +                 'description' => 'parent issue ids',
 +                 'required' => false
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => IssueEntity,
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== updateAction ===
 +<code php>
 +    /**
 +     * Update issue
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/update'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'issue id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'name',
 +                 'type' => 'string',
 +                 'description' => 'issue name',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'statusId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'status id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'description',
 +                 'type' => 'string',
 +                 'description' => 'issue description',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'assignId',
 +                 'type' => 'objectId|null',
 +                 'description' => 'issue assign user id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'priorityId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'priority id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'milestoneId',
 +                 'type' => 'objectId'|null,
 +                 'description' => 'milestone id',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'endDate',
 +                 'type' => 'int'|null,
 +                 'description' => 'close date',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'spentTime',
 +                 'type' => 'int'|null,
 +                 'description' => 'spent time',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'estimatedTime',
 +                 'type' => 'int'|null,
 +                 'description' => 'estimated time',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'progress',
 +                 'type' => 'int'|null,
 +                 'description' => 'percentage of issue completed',
 +                 'required' => false
 +             ],
 +             [
 +                 'name' => 'parents',
 +                 'type' => 'ObjectId[]',
 +                 'description' => 'parent issue ids',
 +                 'required' => false
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => IssueEntity,
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== deleteAction ===
 +<code php>
 +    /**
 +     * Delete issue
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/delete'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'issue id',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'OK',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== addObserverAction ===
 +<code php>
 +   /**
 +     * Add observer
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/addObserver'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'issue id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'type',
 +                 'type' => 'string' ('user' | 'organization' | 'group' | 'department'),
 +                 'description' => 'type of observer',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'observerId',
 +                 'type' => 'objectId',
 +                 'description' => 'observers id',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'OK',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== removeObserverAction ===
 +<code php>
 +    /**
 +     * Remove observer
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/removeObserver'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'issue id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'observerId',
 +                 'type' => 'objectId',
 +                 'description' => 'observers id',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'OK',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== getCommentsAction ===
 +<code php>
 +    /**
 +     * Get issue comments
 +     * request(
 +         'method' => 'GET',
 +         'url' => '/api/v4/issue/getComments',
 +         'params' => [
 +              [
 +                  'name' => 'issueId',
 +                  'type' => 'ObjectId',
 +                  'required' => true,
 +                  'description' => 'Issue id'
 +              ],
 +              [
 +                  'name' => 'skip',
 +                  'type' => 'int',
 +                  'required' => false,
 +                  'description' => 'Skip comments in result'
 +              ],
 +              [
 +                  'name' => 'limit',
 +                  'type' => 'int',
 +                  'required' => false,
 +                  'description' => 'Limit comments in result'
 +              ]
 +         ]
 +     * )
 +     * response(
 +         '200' => [
 +              'status' => 200,
 +              'message' => CommentEntity[]
 +              'code' => 0
 +         ]
 +     * )
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization
 +     */
 +</code>
 +
 +=== addCommentAction ===
 +<code php>
 +    /**
 +     * Add new comment to issue.
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/addComment'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'Issue id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'text',
 +                 'type' => 'string',
 +                 'description' => 'comments text',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'CommentEntity',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization
 +     */
 +</code>
 +
 +=== updateCommentAction ===
 +<code php>
 +    /**
 +     * Update comment.
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/updateComment'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'Comment id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'text',
 +                 'type' => 'string',
 +                 'description' => 'Comment text',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'CommentEntity',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization
 +     */
 +</code>
 +
 +=== removeCommentAction ===
 +<code php>
 +    /**
 +     * Remove comment from issue.
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/removeComment'
 +         'params' => [
 +             [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'Comment id',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'Ok',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization
 +     */
 +</code>
 +
 +=== addRelatedObjectAction ===
 +<code php>
 +    /**
 +     * Add related object.
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/addRelatedObject'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'issue id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'relatedObject',
 +                 'type' => 'json',
 +                 'description' => 'related object content',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'OK',
 +         'code' => 0
 +     * ])
 +     * @throws AirlayException
 +     * @Authorization
 +     */
 +</code>
 +
 +=== removeRelatedObjectAction ===
 +<code php>
 +    /**
 +     * Remove related object.
 +     * request([
 +         'method' => 'POST',
 +         'url' => '/api/v4/issue/removeRelatedObject'
 +         'params' => [
 +              [
 +                 'name' => 'id',
 +                 'type' => 'objectId',
 +                 'description' => 'issue id',
 +                 'required' => true
 +             ],
 +             [
 +                 'name' => 'index',
 +                 'type' => 'int',
 +                 'description' => 'number of object to remove',
 +                 'required' => true
 +             ]
 +         ]
 +     * ])
 +     * response([
 +         'status' => 200,
 +         'message' => 'OK',
 +         'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization
 +     */
 +</code>
 +
 +
 +
 ==== Milestone ==== ==== Milestone ====
 +=== getAction ===
 <code php> <code php>
     /**     /**
-     POST +     Get milestones. 
-     *  +     request([ 
-     Action for edit dataSet objects. +         'method' => 'GET', 
-     *  +         'url' => '/api/v4/milestone/get', 
-     @param ObjectId $dataSetId DataSet Id +         'params' => [ 
-     @param string json $commit Commit in edit format +             [ 
-     * @return 200 Ok json/kml/dxf/gml file+                 'name' => 'status', 
 +                 'type' => 'string', 
 +                 'required' => false 
 +             ], 
 +             [ 
 +                 'name' => 'name', 
 +                 'type' => 'string', 
 +                 'required' => false 
 +             ] 
 +         ] 
 +     * ]) 
 +     * response([ 
 +         'status' => 'OK', 
 +         'message' => MilestoneEntity[] 
 +         'code' => 0 
 +     * ]) 
 +     * @Authorization('CmsUser', 'User')
      */      */
-    /api/v3/dataSet/editor 
 </code> </code>
 +=== createAction ===
 <code php> <code php>
     /**     /**
-     * POST +     Create milestone 
-     *  +     * request([ 
-     Action for clean dataSet object +         "method" => "POST", 
-     *  +         "url" => "api/v4/milestone/create", 
-     * @param ObjectId $dataSetId DataSet Id +         "params" => [ 
-     * @return 200 OK+             [ 
 +                 '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'
 +     */ 
 +</code> 
 +=== updateAction === 
 +<code php> 
 +    /** 
 +     * 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'
 +     */ 
 +</code> 
 +=== deleteAction === 
 +<code php> 
 +    /** 
 +     * 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'
 +     */ 
 +</code> 
 +=== closeMilestoneAction === 
 +<code php> 
 +    /** 
 +     * 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'
 +     */ 
 +</code> 
 +=== addIssuesAction === 
 +<code php> 
 +    /** 
 +     * 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'
 +     */ 
 +</code> 
 +=== removeIssueAction === 
 +<code php> 
 +    /** 
 +     * 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')
      */      */
-    /api/v3/dataSet/cleaning 
 </code> </code>
ru/airlay/api/air-lay-v4.1621487919.txt.gz · Последнее изменение: 2021/05/20 12:18 — Лев