Navikey Wiki Pages

Look beyond the horizon...

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

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

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

Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия 		Предыдущая версия
Следующая версия Следующая версия справа и слева
ru:airlay:api:air-lay-v4 [2021/05/20 12:28]
Лев [getAction] 		ru:airlay:api:air-lay-v4 [2021/06/20 13:35]
Лев [Comment]
Строка 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>
 +
 +==== 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' => 'userIds',
 +     *             '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' => 'priorityId',
 +     *             'type' => 'objectId'|null,
 +     *             'description' => 'priority id',
 +     *             'required' => false
 +     *         ],
 +     *         [
 +     *             'name' => 'milestoneId',
 +     *             'type' => 'objectId'|null,
 +     *             'description' => 'milestone id',
 +     *             'required' => false
 +     *         ],
 +     *         [
 +     *             'name' => 'closeDate',
 +     *             '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' => 'description',
 +     *             'type' => 'string',
 +     *             'description' => 'issue description',
 +     *             'required' => false
 +     *         ],
 +     *         [
 +     *             'name' => 'priorityId',
 +     *             'type' => 'objectId'|null,
 +     *             'description' => 'priority id',
 +     *             'required' => false
 +     *         ],
 +     *         [
 +     *             'name' => 'milestoneId',
 +     *             'type' => 'objectId'|null,
 +     *             'description' => 'milestone id',
 +     *             'required' => false
 +     *         ],
 +     *         [
 +     *             'name' => 'closeDate',
 +     *             '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' => '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>
 +
 +=== 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' => 'IssueEntity',
 +     *     'code' => 0
 +     * ])
 +     *
 +     * @throws AirlayException
 +     *
 +     * @Authorization('CmsUser')
 +     */
 +</code>
 +
 +=== setPriorityAction ===
 +<code php>
 +    /**
 +     * Set priority
 +     * request([
 +     *     'method' => 'POST',
 +     *     'url' => '/api/v4/issue/setPriority'
 +     *     'params' => [
 +     *          [
 +     *             'name' => 'id',
 +     *             'type' => 'objectId',
 +     *             'description' => 'issue id',
 +     *             'required' => true
 +     *         ],
 +     *         [
 +     *             'name' => 'priorityId',
 +     *             'type' => 'objectId',
 +     *             'description' => 'priority id for field',
 +     *             'required' => true
 +     *         ]
 +     *     ]
 +     * ])
 +     * response([
 +     *     'status' => 200,
 +     *     'message' => IssueEntity,
 +     *     'code' => 0
 +     * ])
 +     * @throws AirlayException
 +     * @Authorization
 +     */
 +</code>
 +
 +=== changeStatusAction ===
 +<code php>
 +    /**
 +     * Change status
 +     * request([
 +     *     'method' => 'POST',
 +     *     'url' => '/api/v4/issue/changeStatus'
 +     *     'params' => [
 +     *          [
 +     *             'name' => 'id',
 +     *             'type' => 'objectId',
 +     *             'description' => 'issue id',
 +     *             'required' => true
 +     *         ],
 +     *         [
 +     *             'name' => 'statusId',
 +     *             'type' => 'objectId',
 +     *             'description' => 'status id for field',
 +     *             'required' => true
 +     *         ]
 +     *     ]
 +     * ])
 +     * response([
 +     *     'status' => 200,
 +     *     'message' => IssueEntity,
 +     *     '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 === === getAction ===
Строка 73: Строка 587:
 <code php> <code php>
     /**     /**
-     * POST 
      * Create milestone      * Create milestone
      * request([      * request([
Строка 118: Строка 631:
 <code php> <code php>
     /**     /**
-     * POST 
      * Update milestone      * Update milestone
      * request([      * request([
Строка 169: Строка 681:
 <code php> <code php>
     /**     /**
-     * POST 
      * Delete milestone      * Delete milestone
      * request([      * request([
Строка 196: Строка 707:
 <code php> <code php>
     /**     /**
-     * POST 
      * Close milestone      * Close milestone
      * request([      * request([
Строка 223: Строка 733:
 <code php> <code php>
     /**     /**
-     * POST 
      * Add issues to milestone      * Add issues to milestone
      * request([      * request([
Строка 256: Строка 765:
 <code php> <code php>
     /**     /**
-     * POST 
      * Remove issue from milestone      * Remove issue from milestone
      * request([      * request([
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