Documentation of POST /api/v2/global-tasks

Author: c8y3

docs/api_reference/reference/iris.v2.1.0.yaml

@@ -84,6 +84,7 @@ info:
     * Added GET /api/v2/alerts-filters/{identifier}
     * Added PUT /api/v2/alerts-filters/{identifier}
     * Added DELETE /api/v2/alerts-filters/{identifier}
+    * Added POST /api/v2/global-tasks
     * Deprecated POST /manage/cases/add in favor of POST /api/v2/cases
     * Deprecated POST /manage/cases/update in favor of PUT /api/v2/cases/{case_identifier}
     * Deprecated POST /manage/cases/delete/{case_id} in favor of DELETE /api/v2/cases/{case_identifier}
@@ -230,6 +231,8 @@ paths:
     $ref: v2.1.0/resources/api_v2_assets_{identifier}.yaml
   /api/v2/me:
     $ref: v2.1.0/resources/api_v2_me.yaml
+  /api/v2/global-tasks:
+    $ref: v2.1.0/resources/api_v2_global-tasks.yaml
   /manage/cases/update/{case_id}:
     $ref: v2.1.0/resources/manage_cases_update_{case_id}.yaml
   /case/summary/update:
@@ -547,6 +550,8 @@ tags:
     description: Endpoints to interact with tasks
   - name: Evidences
     description: Endpoints to interact with evidences
+  - name: Global tasks
+    description: Endpoints to interact with global tasks
   - name: Alerts
     description: Endpoints to interact with alerts
   - name: Customers

docs/api_reference/reference/v2.1.0/resources/api_v2_global-tasks.yaml

@@ -0,0 +1,24 @@
+post:
+  operationId: api_v2_global-tasks_post
+  summary: Add a global task
+  description: Add a global task and assign it to a user.
+  tags:
+    - Global tasks
+    - Beta
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../schemas/requestBodies/GlobalTask.yaml
+  responses:
+    '201':
+      description: Global task successfully created
+      content:
+        application/json:
+          schema:
+            $ref: ../schemas/GlobalTask.yaml
+    '400':
+      $ref: ../responses/GenericError.yaml
+    '403':
+      $ref: ../responses/Forbidden.yaml
+

docs/api_reference/reference/v2.1.0/schemas/GlobalTask.yaml

@@ -0,0 +1,51 @@
+type: object
+properties:
+  task_id:
+    type: number
+  task_title:
+    type: string
+    minLength: 1
+  task_description:
+    type:
+      - string
+      - 'null'
+  task_status_id:
+    type: number
+  task_assignee_id:
+    type: number
+  task_tags:
+    type:
+      - string
+      - 'null'
+  task_userid_open:
+    type: integer
+  task_open_date:
+    type: string
+    minLength: 1
+  task_userid_update:
+    type: number
+  task_last_update:
+    type: string
+    minLength: 1
+  task_userid_close:
+    type:
+      - integer
+      - 'null'
+  task_close_date:
+    type:
+      - integer
+      - 'null'
+example:
+  task_id: 9
+  task_title: Task title
+  task_description: My task description
+  task_status_id: 15
+  task_assignee_id: 1
+  task_tags: ''
+  task_userid_open: null
+  task_open_date: '2022-01-21T17:07:10.005183'
+  task_userid_update: 1
+  task_last_update: '2022-01-21T17:07:10.005200'
+  task_userid_close: null
+  task_close_date: null
+

docs/api_reference/reference/v2.1.0/schemas/requestBodies/GlobalTask.yaml

@@ -0,0 +1,26 @@
+type: object
+properties:
+  task_title:
+    type: string
+    minLength: 2
+  task_description:
+    type: string
+  task_status_id:
+    description: The initial status of the task
+    type: integer
+  task_assignee_id:
+    type: integer
+    description: A user ID for whom the task will be assigned
+  task_tags:
+    type: string
+required:
+  - task_title
+  - task_status_id
+  - task_assignee_id
+example:
+  task_title: Task title
+  task_description: My task description
+  task_status_id: 14
+  task_assignee_id: 1
+  task_tags: ''
+