Navikey Wiki Pages

Look beyond the horizon...

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

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

Вы посетили:
ru:airlay:api:air-lay-v4

Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия 		Предыдущая версия
Последняя версия Следующая версия справа и слева
ru:airlay:api:air-lay-v4 [2021/05/28 12:57]
Лев [Структура запроса] 		ru:airlay:api:air-lay-v4 [2021/06/20 13:44]
Лев [Issue]
Строка 41: Строка 41:
 =====Контроллеры===== =====Контроллеры=====
  
-==== Status ====+ 
 + 
 + 
 +==== Label====
 === getAction === === getAction ===
 <code php> <code php>
     /**     /**
-     * Get statuses by ids +     * Get labels 
-     * request(+     * request([
      *     'method' => 'GET',      *     'method' => 'GET',
-     *     'url' => '/api/v4/status/getByIds' +     *     'url' => '/api/v4/label/get'
-     * ) +
-     * response( +
-     *     '200' => [ +
-     *          'status' => 200, +
-     *          'message' => StatusEntity[] +
-     *          'code' => 0 +
-     *     ] +
-     * ) +
-     * +
-     * @Authorization(['CmsUser', 'User']) +
-     */ +
-</code> +
- +
-==== Comment ==== +
-=== getByIdsAction === +
-<code php> +
-    /** +
-     * Get comments by ids +
-     * request( +
-     *     'method' => 'GET', +
-     *     'url' => '/api/v4/comment/getByIds',+
      *     'params' => [      *     'params' => [
-     *          [ 
-     *              'name' => 'ids', 
-     *              'type' => 'ObjectId', 
-     *              'required' => true, 
-     *              'description' => 'comment ids from issue' 
-     *          ] 
-     *     ] 
-     * ) 
-     * response( 
-     *     '200' => [ 
-     *          'status' => 200, 
-     *          'message' => CommentEntity[] 
-     *          'code' => 0 
-     *     ] 
-     * ) 
-     * 
-     * @Authorization(['CmsUser', 'User']) 
-     */ 
-</code> 
-=== updateAction === 
-<code php> 
-    /** 
-     * Update comment 
-     * request([ 
-     *     'method' => 'POST', 
-     *     'url' => '/api/v4/comment/update' 
-     *     'params' => [ 
-     *          [ 
-     *             'name' => 'id', 
-     *             'type' => 'objectId', 
-     *             'description' => 'comment id', 
-     *             'required' => true 
-     *         ], 
      *         [      *         [
-     *             'name' => 'text',+     *             'name' => 'type',
      *             'type' => 'string',      *             'type' => 'string',
-     *             'description' => 'comment text',+     *             'description' => 'label type',
      *             'required' => true      *             'required' => true
      *         ]      *         ]
Строка 114: Строка 63:
      * response([      * response([
      *     'status' => 200,      *     'status' => 200,
-     *     'message' => "ok",+     *     'message' => LabelsEntity[],
      *     'code' => 0      *     'code' => 0
      * ])      * ])
      *      *
-     * @throws AirlayException +     * @Authorization(['CmsUser', 'User'])
-     * +
-     * @Authorization('CmsUser') +
-     */ +
-</code> +
-=== deleteAction === +
-<code php> +
-    /** +
-     * Delete comment +
-     * request([ +
-     *     'method' => 'POST', +
-     *     'url' => '/api/v4/comment/delete' +
-     *     'params' => [ +
-     *          [ +
-     *             'name' => 'id', +
-     *             'type' => 'objectId', +
-     *             'description' => 'comment id', +
-     *             'required' => true +
-     *         ] +
-     *     ] +
-     * ]) +
-     * response([ +
-     *     'status' => 200, +
-     *     'message' => "ok", +
-     *     'code' => 0 +
-     * ])+
      *      *
      * @throws AirlayException      * @throws AirlayException
-     * 
-     * @Authorization('CmsUser') 
-     */ 
-</code> 
- 
-==== Label==== 
-=== getAction === 
-<code php> 
-    /** 
-     * Get labels 
-     * request([ 
-     *     'method' => 'GET', 
-     *     'url' => '/api/v4/label/get' 
-     * ]) 
-     * response([ 
-     *     'status' => 200, 
-     *     'message' => LabelsEntity[], 
-     *     'code' => 0 
-     * ]) 
-     * 
-     * @Authorization(['CmsUser', 'User']) 
      */      */
 </code> </code>
Строка 186: Строка 89:
      *         ],      *         ],
      *         [      *         [
-     *             'name' => 'userIds',+     *             'name' => 'assignIds',
      *             'type' => 'ObjectId[]',      *             'type' => 'ObjectId[]',
      *             'description' => 'assigns filter',      *             'description' => 'assigns filter',
Строка 238: Строка 141:
      *             'type' => 'string',      *             'type' => 'string',
      *             'description' => 'issue description',      *             'description' => 'issue description',
 +     *             'required' => false
 +     *         ],
 +     *         [
 +     *             'name' => 'assignId',
 +     *             'type' => 'objectId|null',
 +     *             'description' => 'issue assign user id',
      *             'required' => false      *             'required' => false
      *         ],      *         ],
Строка 244: Строка 153:
      *             'type' => 'objectId'|null,      *             'type' => 'objectId'|null,
      *             'description' => 'priority id',      *             'description' => 'priority id',
 +     *             'required' => false
 +     *         ],,
 +     *         [
 +     *             'name' => 'statusId',
 +     *             'type' => 'objectId'|null,
 +     *             'description' => 'status id',
      *             'required' => false      *             'required' => false
      *         ],      *         ],
Строка 253: Строка 168:
      *         ],      *         ],
      *         [      *         [
-     *             'name' => 'closeDate',+     *             'name' => 'endDate',
      *             'type' => 'int'|null,      *             'type' => 'int'|null,
      *             'description' => 'close date',      *             'description' => 'close date',
Строка 271: Строка 186:
      *         ],      *         ],
      *         [      *         [
-     *             'name' => 'ready',+     *             'name' => 'progress',
      *             'type' => 'int'|null,      *             'type' => 'int'|null,
      *             'description' => 'percentage of issue completed',      *             'description' => 'percentage of issue completed',
Строка 315: Строка 230:
      *             'description' => 'issue name',      *             'description' => 'issue name',
      *             'required' => true      *             'required' => true
 +     *         ],
 +     *         [
 +     *             'name' => 'statusId',
 +     *             'type' => 'objectId'|null,
 +     *             'description' => 'status id',
 +     *             'required' => false
      *         ],      *         ],
      *         [      *         [
Строка 320: Строка 241:
      *             'type' => 'string',      *             'type' => 'string',
      *             'description' => 'issue description',      *             'description' => 'issue description',
 +     *             'required' => false
 +     *         ],
 +     *         [
 +     *             'name' => 'assignId',
 +     *             'type' => 'objectId|null',
 +     *             'description' => 'issue assign user id',
      *             'required' => false      *             'required' => false
      *         ],      *         ],
Строка 335: Строка 262:
      *         ],      *         ],
      *         [      *         [
-     *             'name' => 'closeDate',+     *             'name' => 'endDate',
      *             'type' => 'int'|null,      *             'type' => 'int'|null,
      *             'description' => 'close date',      *             'description' => 'close date',
Строка 353: Строка 280:
      *         ],      *         ],
      *         [      *         [
-     *             'name' => 'ready',+     *             'name' => 'progress',
      *             'type' => 'int'|null,      *             'type' => 'int'|null,
      *             'description' => 'percentage of issue completed',      *             'description' => 'percentage of issue completed',
Строка 408: Строка 335:
 === addObserverAction === === addObserverAction ===
 <code php> <code php>
-    /**+   /**
      * Add observer      * Add observer
      * request([      * request([
Строка 458: Строка 385:
      *             'type' => 'objectId',      *             'type' => 'objectId',
      *             'description' => 'issue id',      *             'description' => 'issue id',
-     *             'required' => true 
-     *         ], 
-     *         [ 
-     *             'name' => 'type', 
-     *             'type' => 'string' ('user' | 'organization' | 'group' | 'department'), 
-     *             'description' => 'type of observer', 
      *             'required' => true      *             'required' => true
      *         ],      *         ],
Строка 483: Строка 404:
      *      *
      * @Authorization('CmsUser')      * @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> </code>
Строка 497: Строка 460:
      *             'name' => 'id',      *             'name' => 'id',
      *             'type' => 'objectId',      *             'type' => 'objectId',
-     *             'description' => 'issue id',+     *             'description' => 'Issue id',
      *             'required' => true      *             'required' => true
      *         ],      *         ],
Строка 510: Строка 473:
      * response([      * response([
      *     'status' => 200,      *     'status' => 200,
-     *     'message' => 'IssueEntity',+     *     'message' => 'CommentEntity',
      *     'code' => 0      *     'code' => 0
      * ])      * ])
Строка 516: Строка 479:
      * @throws AirlayException      * @throws AirlayException
      *      *
-     * @Authorization('CmsUser')+     * @Authorization
      */      */
 </code> </code>
  
-=== setPriorityAction ===+=== updateCommentAction ===
 <code php> <code php>
     /**     /**
-     * Set priority+     * Update comment.
      * request([      * request([
      *     'method' => 'POST',      *     'method' => 'POST',
-     *     'url' => '/api/v4/issue/setPriority'+     *     'url' => '/api/v4/issue/updateComment'
      *     'params' => [      *     'params' => [
      *          [      *          [
      *             'name' => 'id',      *             'name' => 'id',
      *             'type' => 'objectId',      *             'type' => 'objectId',
-     *             'description' => 'issue id',+     *             'description' => 'Comment id',
      *             'required' => true      *             'required' => true
      *         ],      *         ],
      *         [      *         [
-     *             'name' => 'priorityId', +     *             'name' => 'text', 
-     *             'type' => 'objectId', +     *             'type' => 'string', 
-     *             'description' => 'priority id for field',+     *             'description' => 'Comment text',
      *             'required' => true      *             'required' => true
      *         ]      *         ]
Строка 544: Строка 507:
      * response([      * response([
      *     'status' => 200,      *     'status' => 200,
-     *     'message' => IssueEntity,+     *     'message' => 'CommentEntity',
      *     'code' => 0      *     'code' => 0
      * ])      * ])
 +     *
      * @throws AirlayException      * @throws AirlayException
 +     *
      * @Authorization      * @Authorization
      */      */
 </code> </code>
  
-=== changeStatusAction ===+=== removeCommentAction ===
 <code php> <code php>
     /**     /**
-     * Change status+     * Remove comment from issue.
      * request([      * request([
      *     'method' => 'POST',      *     'method' => 'POST',
-     *     'url' => '/api/v4/issue/changeStatus'+     *     'url' => '/api/v4/issue/removeComment'
      *     'params' => [      *     'params' => [
-     *          [+     *         [
      *             'name' => 'id',      *             'name' => 'id',
      *             'type' => 'objectId',      *             'type' => 'objectId',
-     *             'description' => 'issue id', +     *             'description' => 'Comment id',
-     *             'required' => true +
-     *         ], +
-     *         [ +
-     *             'name' => 'statusId', +
-     *             'type' => 'objectId', +
-     *             'description' => 'status id for field',+
      *             'required' => true      *             'required' => true
      *         ]      *         ]
Строка 576: Строка 535:
      * response([      * response([
      *     'status' => 200,      *     'status' => 200,
-     *     'message' => IssueEntity,+     *     'message' => 'Ok',
      *     'code' => 0      *     'code' => 0
      * ])      * ])
 +     *
      * @throws AirlayException      * @throws AirlayException
 +     *
      * @Authorization      * @Authorization
      */      */
ru/airlay/api/air-lay-v4.txt · Последнее изменение: 2021/06/20 13:49 — Лев

Инструменты страницы

Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki