openapi: 3.0.0
info:
  title: Octane Academy
  version: 1.0.0
servers:
  - url: http://{{url}}
tags:
  - name: authentication
  - name: backlog Items
  - name: backlog Items > epics
  - name: backlog Items > features
  - name: backlog Items > stories
  - name: backlog Items > quality_stories
  - name: backlog Items > defects
  - name: backlog Items > tasks
  - name: tests
  - name: tests > manual_tests
  - name: tests > manual_tests > script
  - name: tests > gherkin_tests
  - name: tests > gherkin_tests > script
  - name: tests > automated_tests
  - name: tests > test_suites
  - name: tests > test_suites > test_suite_link_to_tests
  - name: tests > test_versions
  - name: application_modules
  - name: management
  - name: management > releases
  - name: management > sprints
  - name: management > milestones
  - name: management > objectives
  - name: management > programs
  - name: management > processes
  - name: runs
  - name: runs > suite_runs
  - name: runs > manual_runs
  - name: runs > automated_runs
  - name: runs > gherkin_automated_runs
  - name: runs > run_steps
  - name: pipelines
  - name: pipelines > ci_servers
  - name: pipelines > pipelines
  - name: pipelines > builds
  - name: pipelines > scm
  - name: pipelines > testresults
  - name: pipelines > vulnerabilities
  - name: requirements
  - name: requirements > requirement_folders
  - name: requirements > requirement_documents
  - name: comments
  - name: attachments
  - name: environments
  - name: roles
  - name: users
  - name: list_nodes
  - name: history
  - name: workspaces
  - name: business_rules
  - name: external-actions
  - name: export | import
paths:
  /authentication/sign_in:
    post:
      tags:
        - authentication
      summary: Sign in with client_id and secret
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                client_id: '{{client_id}}'
                client_secret: '{{client_secret}}'
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /authentication/sign_out:
    post:
      tags:
        - authentication
      summary: Sign-out
      requestBody:
        content: {}
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/epics:
    delete:
      tags:
        - backlog Items > epics
      summary: Delete epics given a condition (greater than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items > epics
      summary: Get all business epics
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"epic_type EQ {id EQ ^list_node.epic_type.Business^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - backlog Items > epics
      summary: Create multiple epics (with epic type)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: Digitalization PoC
                    description: This is the description for Digitalization PoC
                    epic_type:
                      type: list_node
                      id: list_node.epic_type.Architecture
                  - name: Digitalization PoC - Next Generation
                    description: >-
                      This is the description for Digitalization PoC - Next
                      Generation
                    epic_type:
                      type: list_node
                      id: list_node.epic_type.Business
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > epics
      summary: Update multiple epics
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '128012'
                    name: Update - Digitalization PoC
                    description: change - This is the description for Digitalization PoC
                    epic_type:
                      type: list_node
                      id: list_node.epic_type.Business
                  - id: '128013'
                    name: Update - Digitalization PoC - Next Generation
                    description: >-
                      change- This is the description for Digitalization PoC -
                      Next Generation
                    epic_type:
                      type: list_node
                      id: list_node.epic_type.Architecture
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/epics/{epic_id}:
    delete:
      tags:
        - backlog Items > epics
      summary: Delete epic given a condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: epic_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/features:
    delete:
      tags:
        - backlog Items > features
      summary: Delete features given a condition (less than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time LT ^2018-10-31T07:47:17Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items > features
      summary: Get all features assigned to a specific release
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"release EQ {name EQ ^Kanban Release^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - backlog Items > features
      summary: Create multiple features (with priority and epic)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: "{\r\n    \"data\": [\r\n        {\r\n            \"name\": \"Virtual Box\",\r\n            \"description\": \"This is the virtual box feature\",\r\n            \"priority\": {\r\n                \"type\": \"list_node\",\r\n                \"id\": \"list_node.priority.high\"\r\n            },\r\n            \"parent\": {\r\n                \"type\": \"epic\",\r\n                \"id\": {{epic_id}}\r\n            }\r\n       },\r\n        {\r\n            \"name\": \"Virtual Chat\",\r\n            \"description\": \"This is the virtual Chat feature\",\r\n            \"priority\": {\r\n                \"type\": \"list_node\",\r\n                \"id\": \"list_node.priority.medium\"\r\n            },\r\n            \"parent\": {\r\n                \"type\": \"epic\",\r\n                \"id\": {{epic_id}}\r\n            }\r\n       }       \r\n    ]\r\n}"
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > features
      summary: Update multiple features (with priority and epic)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: "{\r\n    \"data\": [\r\n        {\r\n            \"id\": \"128010\",\r\n            \"name\": \"Virtual Box\",\r\n            \"description\": \"changed description from 'This is the virtual box feature'\",\r\n            \"priority\": {\r\n                \"type\": \"list_node\",\r\n                \"id\": \"list_node.priority.medium\"\r\n            },\r\n            \"parent\": {\r\n                \"type\": \"epic\",\r\n                \"id\": {{epic_id}}\r\n            }\r\n       },\r\n        {\r\n            \"id\": \"128011\",\r\n            \"name\": \"Virtual Chat renamed\",\r\n            \"description\": \"This is the virtual Chat feature\",\r\n            \"priority\": {\r\n                \"type\": \"list_node\",\r\n                \"id\": \"list_node.priority.high\"\r\n            },\r\n            \"parent\": {\r\n                \"type\": \"epic\",\r\n                \"id\": {{epic_id}}\r\n            }\r\n       }       \r\n    ]\r\n}"
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/features/{feature_id}:
    delete:
      tags:
        - backlog Items > features
      summary: Delete feature given a condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: feature_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/stories:
    delete:
      tags:
        - backlog Items > stories
      summary: Delete multiple user stories given a condition (greater than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items > stories
      summary: Get all user stories assigned to a specific release
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"release EQ {name EQ ^Kanban Release^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - backlog Items > stories
      summary: Create multiple user stories for a feature
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: "{ \"data\" : \r\n    [\r\n        {\r\n            \"name\":\"As an user i want to change my password\", \r\n            \"description\" : \"Change password for current user is possible through user profile.\",\r\n            \"parent\" : {\r\n                \"type\": \"feature\",\r\n                \"id\": {{feature_id}}\r\n            }, \r\n            \"priority\": {\r\n                \"type\": \"list_node\",\r\n                \"id\": \"list_node.priority.urgent\"\r\n            }\r\n        },\r\n        {\r\n            \"name\":\"As an user i want to change my profile picture\", \r\n            \"description\" : \"Change profile picture for current user is possible through user profile.\",\r\n    \t    \"parent\" : {\r\n                \"type\": \"feature\",\r\n                \"id\": {{feature_id}}\r\n            }\r\n\r\n        }\r\n    ]\r\n}"
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > stories
      summary: Update multiple story phases by collection
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - phase:
                      type: phase
                      id: phase.story.inprogress
                    id: '129005'
                  - phase:
                      type: phase
                      id: phase.story.intesting
                    id: '129004'
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/stories/{story_id}:
    delete:
      tags:
        - backlog Items > stories
      summary: Delete user story given a condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: story_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > stories
      summary: Update story phase by Id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                phase:
                  type: phase
                  id: phase.story.inprogress
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: story_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/attachments:
    post:
      tags:
        - attachments
      summary: Create an attachment for a manual test
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                entity:
                  type: string
                  example: >-
                    {"name":"bp.png","owner_test":{"type":"test","id":"{{manual_test_id}}"}}
                content:
                  type: string
                  format: binary
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - attachments
      summary: Get all attachments
      parameters:
        - name: fields
          in: query
          schema:
            type: string
          example: name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/quality_stories:
    delete:
      tags:
        - backlog Items > quality_stories
      summary: Delete multiple quality stories given a condition (date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items > quality_stories
      summary: Get all user stories by specific feature id
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"parent EQ {id EQ 7005}"'
        - name: fields
          in: query
          schema:
            type: string
          example: name,owner
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - backlog Items > quality_stories
      summary: Create multiple quality stories for a feature
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: "{ \"data\" : \r\n    [\r\n        {\r\n            \"name\":\"As an user i want to change my password\", \r\n            \"description\" : \"Change password for current user is possible through user profile.\",\r\n            \"parent\" : {\r\n                \"type\": \"feature\",\r\n                \"id\": {{feature_id}}\r\n            }, \r\n            \"quality_story_type\": {\r\n                    \"type\": \"list_node\",\r\n                    \"id\": \"list_node.quality_story_type.test_authoring\"\r\n                }\r\n            },\r\n        {\r\n            \"name\":\"As an user i want to change my profile picture\", \r\n            \"description\" : \"Change profile picture for current user is possible through user profile.\",\r\n    \t    \"parent\" : {\r\n                \"type\": \"feature\",\r\n                \"id\": {{feature_id}}\r\n            }\r\n\r\n        }\r\n    ]\r\n}"
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > quality_stories
      summary: Update multiple quality story phases by collection
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - phase:
                      type: phase
                      id: phase.quality_story.inprogress
                    id: '61001'
                  - phase:
                      type: phase
                      id: phase.quality_story.done
                    id: '127013'
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/quality_stories/{quality_story_id}:
    delete:
      tags:
        - backlog Items > quality_stories
      summary: Delete user story given a condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: quality_story_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > quality_stories
      summary: Update quality story phase by Id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                phase:
                  type: phase
                  id: phase.quality_story.inprogress
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: quality_story_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/defects/{defect_id}:
    delete:
      tags:
        - backlog Items > defects
      summary: Delete defect given a condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: defect_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items > defects
      summary: Get defect by Id
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: analysis_udf
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: defect_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > defects
      summary: Update defect phase by Id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                phase:
                  type: phase
                  id: phase.defect.opened
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: defect_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/defects:
    delete:
      tags:
        - backlog Items > defects
      summary: Delete defects given a condition (date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items > defects
      summary: Get blocked defects
      parameters:
        - name: query
          in: query
          schema:
            type: string
          example: '"blocked EQ true"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - backlog Items > defects
      summary: Add new defects
      description: add one or multiple defects to ALM Octane using POST
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: This is a defect
                    phase:
                      type: phase
                      id: phase.defect.opened
                    owner:
                      type: workspace_user
                      id: '6001'
                  - name: This is another defect
                    phase:
                      type: phase
                      id: phase.defect.new
                    owner:
                      type: workspace_user
                      id: '6001'
      parameters:
        - name: fields
          in: query
          schema:
            type: string
          example: name,phase
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > defects
      summary: Update multiple defect phases by collection
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - phase:
                      type: phase
                      id: phase.defect.fixed
                    id: '129005'
                  - phase:
                      type: phase
                      id: phase.defect.opened
                    id: '129004'
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/tasks/{task_id}:
    delete:
      tags:
        - backlog Items > tasks
      summary: Delete task by given condition (id)
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: task_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/tasks:
    delete:
      tags:
        - backlog Items > tasks
      summary: Delete tasks by given condition (date)
      parameters:
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items > tasks
      summary: Get all new tasks
      parameters:
        - name: query
          in: query
          schema:
            type: string
          example: '"phase EQ {name EQ ^New^}"'
        - name: fields
          in: query
          schema:
            type: string
          example: name,phase
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - backlog Items > tasks
      summary: Create multiple tasks (user story, defect and quality story)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: Design
                    story:
                      type: story
                      id: '6082'
                    description: This is a new tasks for design
                  - name: Develop
                    story:
                      type: defect
                      id: '7081'
                    description: This is a new tasks for develop
                  - name: Quality
                    story:
                      type: quality_story
                      id: '61001'
                    description: This is a new tasks for quality
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items > tasks
      summary: Update multiple tasks (user story, defect and quality story)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '55004'
                    name: _Design
                    story:
                      type: story
                      id: '6082'
                    description: 'Update: This is a new tasks for design'
                  - id: '55005'
                    name: _Develop
                    story:
                      type: defect
                      id: '7081'
                    description: 'Update: This is a new tasks for develop'
                  - id: '55006'
                    name: _Quality
                    story:
                      type: quality_story
                      id: '61001'
                    description: 'Update: This is a new tasks for quality'
      parameters:
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/work_items:
    delete:
      tags:
        - backlog Items
      summary: Delete work_items by given condition (date)
      parameters:
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - backlog Items
      summary: Get all work items by subtype
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: subtype, name, phase
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - backlog Items
      summary: Create multiple work items for different subtype
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - subtype: defect
                    name: worktime type defect
                    description: This will create a workitem of type defect
                  - subtype: story
                    name: worktime type user story
                    description: This will create a workitem of type user story
                  - subtype: quality_story
                    name: worktime type quality story
                    description: This will create a workitem of type quality story
                  - subtype: feature
                    name: worktime type feature
                    description: This will create a workitem of type feature
      parameters:
        - name: fields
          in: query
          schema:
            type: string
          example: subtype, name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - backlog Items
      summary: Update multiple work items for different subtype
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '128014'
                    subtype: defect
                    name: 'Update: worktime type defect'
                    description: 'Update: This will create a workitem of type defect'
                  - id: '128015'
                    subtype: story
                    name: 'Update: worktime type user story'
                    description: 'Update: This will create a workitem of type user story'
                  - id: '128016'
                    subtype: quality_story
                    name: 'Update: worktime type quality story'
                    description: 'Update: This will create a workitem of type quality story'
                  - id: '128017'
                    subtype: feature
                    name: 'Update: worktime type feature'
                    description: 'Update: This will create a workitem of type feature'
      parameters:
        - name: fields
          in: query
          schema:
            type: string
          example: subtype, name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/tests/{manual_test_id}/script:
    get:
      tags:
        - tests > manual_tests > script
      summary: Get test script
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: manual_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - tests > manual_tests > script
      summary: Create test script
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                script: |-
                  - Step 1: Login to app. 
                  - ?Step 2: Check Login is successful
                revision_type: Minor
                comment: REST API Test Steps added
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: manual_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/manual_tests:
    delete:
      tags:
        - tests > manual_tests
      summary: Delete manual test by given condition (date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - tests > manual_tests
      summary: Get all manual tests with no backlog coverage
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"covered_content EQ {null}"'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - tests > manual_tests
      summary: Create multiple manual tests
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: Login to web application
                    description: This is a web application test regression
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
                    product_areas:
                      data:
                        - type: product_area
                          id: 7011
                  - name: Login to web application regression
                    description: This is a web application test
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
                    product_areas:
                      data:
                        - type: product_area
                          id: 7011
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - tests > manual_tests
      summary: Update multiple manual tests
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '5016'
                    phase:
                      type: phase
                      id: phase.test_manual.indesign
                  - id: '295005'
                    name: 'Update: Login to web application regression'
                    description: 'Update: This is a web application test'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/manual_tests/{manual_test_id}:
    delete:
      tags:
        - tests > manual_tests
      summary: Delete manual test by given condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: manual_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/manual_tests/{manual_test_id}/:
    put:
      tags:
        - tests > manual_tests
      summary: Assign test to multiple application modules
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: 'Update: Login to web application'
                description: 'Update: This is a web application test regression'
                test_type:
                  data:
                    - type: list_node
                      id: list_node.test_type.end_to_end
                product_areas:
                  data:
                    - type: product_area
                      id: 7011
                    - type: product_area
                      id: 7001
                    - type: product_area
                      id: 6002
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: manual_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/tests/{gherkin_test_id}/script:
    get:
      tags:
        - tests > gherkin_tests > script
      summary: Get gherkin test script
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: gherkin_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - tests > gherkin_tests > script
      summary: Create gherkin test script
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                script: "Feature: Buying items in shopping cart, single user\n \n\tBackground: \n\t\tGiven payment security system is up\n \n\tScenario: Julio buys items in his cart\n\t\tGiven a customer named \"Julio Brown\" \n\t\tGiven I am logged in as Julio \n\t\tGiven I have at least one item in cart\n\t\tWhen I try to buy items in my cart\n\t\tThen I should be asked for my payment method"
                comment: Testing shopping cart functionality.
                revision_type: Minor
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: gherkin_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/gherkin_tests:
    delete:
      tags:
        - tests > gherkin_tests
      summary: Delete gherkin tests by given condition (greater than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - tests > gherkin_tests
      summary: Get all gherkin tests assigned to a specific application module
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"product_areas EQ {name EQ ^Procure to Pay *^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - tests > gherkin_tests
      summary: Create multiple gherkin tests
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: 'GT: Login to web application end-to-end'
                    description: This is a web application test regression
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
                  - name: 'GT: Login to web application regression'
                    description: This is a web application test
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - tests > gherkin_tests
      summary: Update multiple gherkin tests
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '295006'
                    name: 'Update-GT: Login to web application end-to-end'
                    description: 'Update: This is a web application test regression'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
                  - id: '295007'
                    name: 'Update-GT: Login to web application regression'
                    description: 'Update: This is a web application test'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/gherkin_tests/{gherkin_test_id}/:
    delete:
      tags:
        - tests > gherkin_tests
      summary: Delete gherkin test by given condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: gherkin_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/automated_tests:
    delete:
      tags:
        - tests > automated_tests
      summary: Delete automated test by given condition (date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - tests > automated_tests
      summary: Get all automated tests with no backlog coverage
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"covered_content EQ {null}"'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - tests > automated_tests
      summary: Create multiple automated tests
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: 'AUTO: Login to web application'
                    description: 'AUTO: This is a web application test regression'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
                  - name: 'AUTO: Login to web application regression'
                    description: 'AUTO: This is a web application test'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - tests > automated_tests
      summary: Update multiple automated tests
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '297008'
                    name: 'Update: Login to web application'
                    description: 'Update: This is a web application test regression'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
                  - id: '297009'
                    name: 'Update: Login to web application regression'
                    description: 'Update: This is a web application test'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/automated_tests/{automated_test_id}:
    delete:
      tags:
        - tests > automated_tests
      summary: Delete automated test by given condition (id)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: automated_test_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/test_suite_link_to_tests:
    get:
      tags:
        - tests > test_suites > test_suite_link_to_tests
      summary: Get all tests within a test suite
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: test_suite,test
        - name: query
          in: query
          schema:
            type: string
          example: '"test_suite EQ {id EQ {{test_suite_id}}}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - tests > test_suites > test_suite_link_to_tests
      summary: Assign tests of different subtype to a suite
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - test_suite:
                      type: test
                      id: '{{test_suite_id}}'
                    test:
                      type: test
                      id: '{{manual_test_id}}'
                  - test_suite:
                      type: test
                      id: '{{test_suite_id}}'
                    test:
                      type: test
                      id: '{{automated_test_id}}'
                  - test_suite:
                      type: test
                      id: '{{test_suite_id}}'
                    test:
                      type: test
                      id: '{{gherkin_test_id}}'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/test_suites:
    delete:
      tags:
        - tests > test_suites
      summary: Delete all test suite by given condition (id)
      parameters:
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-11-30T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - tests > test_suites
      summary: Get all test suites with tests
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"!link_to_test_suite EQ {null}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - tests > test_suites
      summary: Create multiple test suites
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: TS - Login to web application
                    description: This is a web application test regression
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
                  - name: TS - Login to web application regression
                    description: This is a web application test
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - tests > test_suites
      summary: Update multiple test suite
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '297010'
                    name: 'Update: Login to web application'
                    description: 'Update: This is a web application test regression'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
                  - id: '297011'
                    name: 'Update: Login to web application regression'
                    description: 'Update: This is a web application test'
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.regression
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/test_versions:
    get:
      tags:
        - tests > test_versions
      summary: Get all test version with all system fields
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            client_lock_stamp,comment,creation_time,creator,id,is_external,last_modified,name,releases,script,test,version_stamp
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/tests:
    get:
      tags:
        - tests
      summary: Get all tests assigned to a specific application module
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"product_areas EQ {name EQ ^Procure to Pay *^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - tests
      summary: Create multiple tests of different subtype
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - subtype: gherkin_test
                    name: This is a gherkin test
                    description: Use this subtype for bdd specific testing
                  - subtype: test_manual
                    name: This is a manual test
                    description: Use this subtype for standard testing
                  - subtype: test_suite
                    name: This is a test suite
                    description: Use this subtype for bundled testing
                  - subtype: test_automated
                    name: This is a automated test
                    description: Use this subtype for automated testing
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: subtype, name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - tests
      summary: Update multiple tests of different subtype
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '297001'
                    subtype: gherkin_test
                    name: 'Update: This is a gherkin test'
                    description: 'Update: Use this subtype for bdd specific testing'
                  - id: '297002'
                    subtype: test_manual
                    name: 'Update: This is a manual test'
                    description: 'Update: Use this subtype for standard testing'
                  - id: '297003'
                    subtype: test_suite
                    name: 'Update: This is a test suite'
                    description: 'Update: Use this subtype for bundled testing'
                  - id: '297004'
                    subtype: test_automated
                    name: 'Update: This is a automated test'
                    description: 'Update: Use this subtype for automated testing'
      parameters:
        - name: fields
          in: query
          schema:
            type: string
          example: subtype, name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/application_modules:
    delete:
      tags:
        - application_modules
      summary: Get all application modules by given condition (greater than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-12-01T00:00:00Z^"'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - application_modules
      summary: Get all application modules with system fields
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            client_lock_stamp,creation_time,description,has_children,id,last_modified,name,parent,program,version_stamp
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - application_modules
      summary: Create multiple application modules
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: Order Management
                    parent:
                      type: application_module
                      id: '7012'
                    business_impact:
                      id: list_node.business_impact.no_impact
                      type: list_node
                  - name: Delivery Management
                    parent:
                      type: application_module
                      id: '7012'
                    business_impact:
                      id: list_node.business_impact.no_impact
                      type: list_node
      parameters:
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - application_modules
      summary: Update multiple application modules
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '2010'
                    name: Update - Order Management
                    parent:
                      type: application_module
                      id: '2001'
                  - id: '2010'
                    name: Update - Delivery Management
                    parent:
                      type: application_module
                      id: '2001'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,description
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/releases:
    delete:
      tags:
        - management > releases
      summary: Delete release by given condition (greater than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-12-01T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - management > releases
      summary: Get all releases by creation_time (lower than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time LT ^2020-02-25T09:19:34Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - management > releases
      summary: Create multiple releases
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: Release Jan
                    end_date: '2021-01-31T12:00:00Z'
                    start_date: '2021-01-01T12:00:00Z'
                    sprint_duration: 7
                    description: This is the January release
                  - name: Release Feb
                    end_date: '2021-02-28T12:00:00Z'
                    start_date: '2021-02-01T12:00:00Z'
                    sprint_duration: 7
                    description: This is the February release
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - management > releases
      summary: Update multiple releases
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '40001'
                    name: UPDATE - Release Jan
                    end_date: '2021-01-31T12:00:00Z'
                    start_date: '2021-01-01T12:00:00Z'
                    sprint_duration: 7
                    description: UPDATE - This is the January release
                  - id: '40002'
                    name: UPDATE - Release Feb
                    end_date: '2021-02-28T12:00:00Z'
                    start_date: '2021-02-01T12:00:00Z'
                    sprint_duration: 7
                    description: UPDATE - This is the February release
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/sprints:
    delete:
      tags:
        - management > sprints
      summary: Delete all sprints by given condition (name)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"name EQ ^UPDATE x*^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - management > sprints
      summary: Get all sprints assigned to a release
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"release EQ {name EQ ^PI 2020.04^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - management > sprints
      summary: Create multiple sprints within a release
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: xSprint 1
                    end_date: '2021-01-14T12:00:00Z'
                    start_date: '2021-01-01T12:00:00Z'
                    release:
                      type: release
                      id: '41001'
                  - name: xSprint 2
                    end_date: '2021-01-31T12:00:00Z'
                    start_date: '2021-01-15T12:00:00Z'
                    release:
                      type: release
                      id: '41001'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - management > sprints
      summary: Update multiple sprints within a release
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '43010'
                    name: UPDATE xSprint 1
                  - id: '43011'
                    name: UPDATE xSprint 2
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/milestones:
    delete:
      tags:
        - management > milestones
      summary: Delete all milestones by given condition (name)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"name EQ ^UPDATE x*^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - management > milestones
      summary: Get all milestones assigned to a release
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"release EQ {name EQ ^Release Jan^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - management > milestones
      summary: Create milestones assigned to a release
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: Milestones MS01
                    date: '2021-01-14T12:00:00Z'
                    release:
                      type: release
                      id: '41001'
                  - name: Milestones MS02
                    date: '2021-01-31T12:00:00Z'
                    release:
                      type: release
                      id: '41001'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - management > milestones
      summary: Update multiple milestones
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '22002'
                    name: UPDATE Milestones MS01
                    date: '2021-01-14T12:00:00Z'
                  - id: '22003'
                    name: UPDATE Milestones MS02
                    date: '2021-01-31T12:00:00Z'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/planning_info:
    get:
      tags:
        - management > objectives
      summary: Get all objectives
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/programs:
    delete:
      tags:
        - management > programs
      summary: Delete all programs by given condition (greater than date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-12-01T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - management > programs
      summary: Get all programs
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: client_lock_stamp,creation_time,id,last_modified,name,version_stamp
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - management > programs
      summary: Create multiple programs
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: E-Commerce
                  - name: Mobile
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - management > programs
      summary: Update multiple programs Copy
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '10001'
                    name: UPDATE E-Commerce
                  - id: '10002'
                    name: UPDATE Mobile
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/processes:
    get:
      tags:
        - management > processes
      summary: Get all processes
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/suite_run:
    get:
      tags:
        - runs > suite_runs
      summary: Get all suite runs
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/runs:
    post:
      tags:
        - runs > suite_runs
      summary: Create a run for a test suite
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - subtype: run_suite
                    release:
                      type: release
                      id: '41001'
                    program:
                      type: program
                      id: '2002'
                    name: Automation Suite
                    test:
                      type: test
                      id: '{{test_suite_id}}'
                    native_status:
                      type: list_node
                      id: list_node.run_native_status.planned
                    test_type:
                      data:
                        - type: list_node
                          id: list_node.test_type.end_to_end
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - runs
      summary: Get all failed runs
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"native_status EQ {id EQ ^list_node.run_native_status.failed^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/suite_runs/{suite_run_id}/run_auto:
    post:
      tags:
        - runs > suite_runs
      summary: Run automated test suite
      requestBody:
        content: {}
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: suite_run_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/manual_runs:
    delete:
      tags:
        - runs > manual_runs
      summary: >-
        Delete all manual runs for manual tests by given condition (greater than
        date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT ^2020-12-01T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - runs > manual_runs
      summary: Get all passed manual runs
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"native_status EQ {name EQ ^Passed^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - runs > manual_runs
      summary: Create manual run for a manual test, status In Progress
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: new Run for Test
                    test:
                      type: test_manual
                      id: '{{manual_test_id}}'
                    native_status:
                      type: list_node
                      id: list_node.run_native_status.not_completed
                    release:
                      type: release
                      id: '3002'
                    run_by:
                      type: workspace_user
                      id: '1001'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - runs > manual_runs
      summary: Update manual run for a manual test, status Passed
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '7002'
                    name: new Run for Test
                    test:
                      type: test_manual
                      id: '{{manual_test_id}}'
                    native_status:
                      type: list_node
                      id: list_node.run_native_status.passed
                    release:
                      type: release
                      id: '3002'
                    run_by:
                      type: workspace_user
                      id: '1001'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/automated_runs:
    get:
      tags:
        - runs > automated_runs
      summary: Get all automated runs for an automated test
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"test EQ {id EQ {{automated_test_id}}}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/gherkin_automated_runs:
    get:
      tags:
        - runs > gherkin_automated_runs
      summary: Get all automated runs for a gherkin automated test
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"test EQ {id EQ {{gherkin_test_id}}}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/run_steps:
    get:
      tags:
        - runs > run_steps
      summary: Get all run steps of a manual run
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"run EQ {id EQ ^7005^}"'
        - name: fields
          in: query
          schema:
            type: string
          example: description,result
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - runs > run_steps
      summary: Update multiple run steps of a manual run
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - actual: actual results
                    description: This is a result description
                    step_type:
                      type: list_node
                      id: list_node.manual_test_run_step_type.normal
                    run:
                      type: run_manual
                      id: '7005'
                    id: '7006'
                  - actual: actual results
                    description: Another step description
                    step_type:
                      type: list_node
                      id: list_node.manual_test_run_step_type.normal
                    run:
                      type: run_manual
                      id: '7005'
                    id: '7008'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/ci_servers:
    delete:
      tags:
        - pipelines > ci_servers
      summary: Delete ci server
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"name EQ ^Update D12^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - pipelines > pipelines
      summary: Get Instance ids for ci_servers
      parameters:
        - name: fields
          in: query
          schema:
            type: string
          example: id,is_connected,author,url,instance_id,name,server_type
        - name: limit
          in: query
          schema:
            type: integer
          example: '100'
        - name: order_by
          in: query
          schema:
            type: string
          example: id
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - pipelines > ci_servers
      summary: Create ci server
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: Custom-CI
                    url: http://D12.company.ch/sap_jobs
                    server_type: ERP
                    instance_id: '{{ci_instance_id}}'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - pipelines > ci_servers
      summary: Rename ci server
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '35001'
                    name: Update D12
                    url: http://D12.company.ch/sap_jobs
                    server_type: sm37
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/ci_servers/configured:
    get:
      tags:
        - pipelines > ci_servers
      summary: Get all ci server connected
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/pipelines:
    delete:
      tags:
        - pipelines > pipelines
      summary: Delete pipeline by name
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"name EQ ^ZZ_SEND_SYSTEM_TEST_LOGS^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - pipelines > pipelines
      summary: Get all pipelines
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,author,creation_time,ci_server
        - name: limit
          in: query
          schema:
            type: integer
          example: '100'
        - name: order_by
          in: query
          schema:
            type: string
          example: id
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - pipelines > pipelines
      summary: Create new pipeline
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - jobs:
                      - jobCiId: '{{job_ci_id}}'
                        name: MyNew
                    name: MyNew
                    root_job_ci_id: '{{job_ci_id}}'
                    server_ci_id: '{{ci_instance_id}}'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,creation_time,author
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - pipelines > pipelines
      summary: Rename pipeline
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '51001'
                    name: ZZ_SEND_SYSTEM_TEST_LOGS
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/ci_jobs:
    get:
      tags:
        - pipelines > pipelines
      summary: Get ci_jobs id
      parameters:
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: fields
          in: query
          schema:
            type: string
          example: name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /internal-api/shared_spaces/{shared_space}/workspaces/{workspace}/analytics/ci/pipelines/{pipeline_id}/run:
    post:
      tags:
        - pipelines > pipelines
      summary: Run existing pipeline
      requestBody:
        content: {}
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: pipeline_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/analytics/ci/pipelines/{pipeline_id}/run:
    post:
      tags:
        - pipelines > pipelines
      summary: Run existing pipeline (api)
      requestBody:
        content: {}
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
        - name: pipeline_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/ci_builds/2001:
    get:
      tags:
        - pipelines > builds
      summary: Get a single ci_build
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name,pipeline_node,status
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/analytics/ci/builds:
    put:
      tags:
        - pipelines > builds
      summary: Trigger an new pipeline run (state finished)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: "{\r\n\t\"serverCiId\": \"{{ci_instance_id}}\", \r\n\t\"jobCiId\": \"{{job_ci_id}}\",  \r\n\t\"buildCiId\": \"{{build_ci_id}}\", \r\n\t\"startTime\": {{build_time_epoc}},   \r\n\t\"duration\": 120490, \r\n\t\"status\": \"finished\", \r\n\t\"result\": \"success\"\r\n}"
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/scm_commits:
    get:
      tags:
        - pipelines > scm
      summary: Get all scm commits
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"stories EQ {id EQ 6062}"'
        - name: fields
          in: query
          schema:
            type: string
          example: ci_build
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/scm_repositories/7001:
    get:
      tags:
        - pipelines > scm
      summary: Get all scm repositories
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/scm_commits/5003:
    get:
      tags:
        - pipelines > scm
      summary: Get single scm commit
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/scm-commits:
    put:
      tags:
        - pipelines > scm
      summary: Send scm data
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                - fileBlameList: []
                  builtRevId: ''
                  repository:
                    type: git
                    url: ' https://github.com/akhan/khanamir-repository.git'
                    branch: refs/remotes/origin/master
                  commits:
                    - id: '5001'
                      user: khanamir
                      userEmail: khanamir@microfocus.com
                      time: '{{build_time_epoc}}'
                      parentRevId: 321dthdjeree332e59d92
                      comment: 'defect #3045, new'
                      revId: ce3eerc6ee7517d37d0c9a775ae9fc87ad81
                      repositories: null
                      stories:
                        data:
                          - type: work_item
                            id: '3045'
                      workspace_user:
                        type: workspace_user
                        id: '1001'
                      changes:
                        - id: null
                          type: edit
                          file: >-
                            src/main/java/spring/postmancollectiondemorestapi.java
                          renameToFile: null
                          commitId: null
                    - id: '5002'
                      user: khanamir
                      userEmail: khanamir@microfocus.com
                      time: '{{build_time_epoc}}'
                      parentRevId: 8dd2lwrerwe4eaa4e3a0f
                      comment: 'user story #3029, new'
                      revId: de59dwerwer3232756e6916a0e37afdf936698b35bd7dc4e
                      repositories: null
                      stories:
                        data:
                          - type: work_item
                            id: '3029'
                      workspace_user:
                        type: workspace_user
                        id: '1001'
                      changes:
                        - id: null
                          type: edit
                          file: src/main/java/spring/postmancollectiondemo.java
                          renameToFile: null
                          commitId: null
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: instance-id
          in: query
          schema:
            type: string
          example: '''{{ci_instance_id}}'''
        - name: job-ci-id
          in: query
          schema:
            type: string
          example: '''{{job_ci_id}}'''
        - name: build-ci-id
          in: query
          schema:
            type: string
          example: '''{{build_ci_id}}'''
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/test-results/10113:
    get:
      tags:
        - pipelines > testresults
      summary: Get pushed test status
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/test-results:
    post:
      tags:
        - pipelines > testresults
      summary: Push test results w/o pipeline
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: >-
                "<?xml version=\"1.0\"
                encoding=\"utf-8\"?>\r\n<test_result>\r\n<test_fields>\r\n 
                <test_field type=\"Test_Level\" value=\"Unit Test\"/>\r\n 
                <test_field type=\"Test_Type\" value=\"Sanity\"/>\r\n 
                <test_field type=\"Framework\"
                value=\"JUnit\"/>\r\n</test_fields>\r\n<test_runs>\r\n 
                <test_run name=\"aBank-0Ax01-LZERWIN1I01\" package=\"Bank-PLM\"
                class=\"PLM\" module=\"LZERWIN1I01\" status=\"Passed\"
                duration=\"15711\" started=\"{{build_time_epoc}}\"
                run_name=\"A_1611572212359\"/>\r\n  <test_run
                name=\"aBank-0Ax02-LZSRS_WSSAU37\" package=\"Bank-PLMSAP-PLM\"
                class=\"PLM\" module=\"LZSRS_WSSAU37\" status=\"Passed\"
                duration=\"15711\" started=\"{{build_time_epoc}}\"
                run_name=\"A_16115722123598\"/>\r\n  <test_run
                name=\"aBank-0Ax03-LZSRS_WSSAF69\" package=\"Bank-PLM\"
                class=\"PLM\" module=\"LZSRS_WSSAF69\" status=\"Passed\"
                duration=\"15711\" started=\"{{build_time_epoc}}\"
                run_name=\"161157221235967\"/>\r\n  <test_run
                name=\"aBank-0Ax04-ZCL_SYSTEMUEBERWACHUNG\" package=\"Bank-PLM\"
                class=\"PLM\" module=\"ZCL_SYSTEMUEBERWACHUNG\"
                status=\"Passed\" duration=\"15711\"
                started=\"{{build_time_epoc}}\"
                run_name=\"161157221235938\"/>\r\n  <test_run
                name=\"aBank-0Ax05-ZMDI_INV_USER_SET\" package=\"Bank-PLM\"
                class=\"PLM\" module=\"ZMDI_INV_USER_SET\" status=\"Failed\"
                duration=\"15711\" started=\"{{build_time_epoc}}\"
                run_name=\"A_1611572212359a\"/>\r\n  <test_run
                name=\"aBank-0Ax06-ZCL_TEST_BSP_SYNTAX\" package=\"Bank-PLM\"
                class=\"PLM\" module=\"ZCL_TEST_BSP_SYNTAX\" status=\"Passed\"
                duration=\"15711\" started=\"{{build_time_epoc}}\"
                run_name=\"1611572212359073\"/>\r\n  <test_run
                name=\"aBank-0Ax07-ZCL_TEST_FILIALEN_D12_P12\"
                package=\"Bank-PLM\" class=\"PLM\"
                module=\"ZCL_TEST_FILIALEN_D12_P12\" status=\"Passed\"
                duration=\"15711\" started=\"{{build_time_epoc}}\"
                run_name=\"11611572212359\"/>\r\n  <test_run
                name=\"aBank-0Ax08-ZCL_TEST_HTTP\" package=\"Bank-PLM\"
                class=\"PLM\" module=\"ZCL_TEST_HTTP\" status=\"Passed\"
                duration=\"15711\" started=\"{{build_time_epoc}}\"
                run_name=\"16115722123592\"/>\r\n</test_runs>\r\n</test_result>"
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: skip-errors
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/issues:
    get:
      tags:
        - pipelines > vulnerabilities
      summary: Get all vulnerabilities
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: hpeclienttype
          in: header
          schema:
            type: string
          example: HPE_MQM_UI
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            line,state,id,severity,tool_name,package,remote_id,primary_location_full,analysis,commits,category
        - name: limit
          in: query
          schema:
            type: integer
          example: '30'
        - name: offset
          in: query
          schema:
            type: integer
          example: '0'
        - name: order_by
          in: query
          schema:
            type: string
          example: id
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/requirement_folders:
    delete:
      tags:
        - requirements > requirement_folders
      summary: >-
        Delete multiple requirement folders by given condition (greater than
        date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT^2020-12-01T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - requirements > requirement_folders
      summary: Get all requirement folders
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - requirements > requirement_folders
      summary: Create multiple requirement folders
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - description: Order Management Description
                    name: Order Management
                    parent:
                      type: requirement_root
                      id: '5001'
                  - description: Logistics Description
                    name: Logistics
                    parent:
                      type: requirement_folder
                      id: '266002'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - requirements > requirement_folders
      summary: Update multiple requirement folders
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '266004'
                    description: UPDATE Order Management Description
                    name: UPDATE Order Management
                    parent:
                      type: requirement_root
                      id: '5001'
                  - id: '266005'
                    description: UPDATE Logistics Description
                    name: UPDATE Logistics
                    parent:
                      type: requirement_folder
                      id: '266002'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/requirement_documents:
    delete:
      tags:
        - requirements > requirement_documents
      summary: >-
        Delete multiple requirement documents by given condition (greater than
        date)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"creation_time GT^2020-12-01T00:00:00Z^"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - requirements > requirement_documents
      summary: Get all requirement documents without test coverage
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"test EQ {null}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - requirements > requirement_documents
      summary: Create multiple requirement documents
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - description: Order Management Description
                    name: Order Management
                    parent:
                      type: requirement_folder
                      id: '264005'
                  - description: Logistics Description
                    name: Logistics
                    parent:
                      type: requirement_folder
                      id: '264005'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - requirements > requirement_documents
      summary: Update multiple requirements documents
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - id: '265005'
                    description: Order Management Description
                    name: Order
                    parent:
                      type: requirement_folder
                      id: '266002'
                  - id: '265006'
                    description: Logistics Description
                    name: Logistic
                    parent:
                      type: requirement_folder
                      id: '266002'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/requirements:
    get:
      tags:
        - requirements
      summary: Get all requirements (including requirement_root)
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/comments:
    get:
      tags:
        - comments
      summary: Get all comments on all entities
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: owner_work_item,text,author
        - name: order_by
          in: query
          schema:
            type: string
          example: author
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - comments
      summary: Create test comment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - author:
                      type: workspace_user
                      id: '1004'
                    owner_test:
                      type: test
                      id: '{{manual_test_id}}'
                    text: This is a test comment
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/taxonomy_nodes:
    get:
      tags:
        - environments
      summary: Read all Taxonomy Nodes by Category Node name
      parameters:
        - name: query
          in: query
          schema:
            type: string
          example: '"category EQ {name EQ ^AUT Env^}"'
        - name: fields
          in: query
          schema:
            type: string
          example: name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/roles:
    get:
      tags:
        - roles
      summary: Get permission for role
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fetch_single_entity
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            creation_time,based_on,parent_context_role,is_system,client_lock_stamp,logical_name,version_stamp,data_visibility,customizable,based_on_system,data_visibility_enabled,workspace_id,name,visible_in_ui,last_modified,actions,is_modified
        - name: offset
          in: query
          schema:
            type: integer
          example: '0'
        - name: query
          in: query
          schema:
            type: string
          example: '"(visible_in_ui=true;id=''1007'')"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspace_roles:
    get:
      tags:
        - roles
      summary: Get all workspace roles filter by name
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"role EQ {name EQ ^CI/CD Integration^};workspace EQ {id EQ ^4001^}"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/workspace_users:
    get:
      tags:
        - users
      summary: Get all workspace users
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/users:
    get:
      tags:
        - users
      summary: Get shared space user by full name
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"full_name EQ ^Amir Khan^"'
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            activity_level,user_activation_status,client_lock_stamp,creation_time,email,first_name,full_name,id,language,last_login,last_modified,last_name,ldap_dn,ldap_server_id,name,password,phone1,ssp_user_activation_status,uid,version_stamp
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - users
      summary: Create a user
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - workspace_roles:
                      data:
                        - type: workspace_role
                          id: '1008'
                        - type: workspace_role
                          id: '1009'
                    language: lang.en
                    first_name: Amir
                    last_name: Khan
                    name: AmirKhan
                    email: amir.khan@microfocus.com
                    phone1: '+41'
                    password: A6C4D3D1q!
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fetch_single_entity
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            activity_level,user_activation_status,client_lock_stamp,creation_time,email,first_name,full_name,id,language,last_login,last_modified,last_name,ldap_dn,ldap_server_id,name,password,phone1,ssp_user_activation_status,uid,version_stamp
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/list_nodes:
    get:
      tags:
        - list_nodes
      summary: Get all items from list_nodes issue state
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"logical_name EQ ^list_node.issue_state*^"'
        - name: fields
          in: query
          schema:
            type: string
          example: id,name,logical_name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
        - list_nodes
      summary: Add items to the list
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - type: list_node
                    name: red
                    list_root:
                      type: list_node
                      id: ek2z0y1xdjqpwajjxyl420gy9
                  - type: list_node
                    name: green
                    list_root:
                      type: list_node
                      id: ek2z0y1xdjqpwajjxyl420gy9
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/history_logs:
    get:
      tags:
        - history
      summary: Get all items from history_logs for requirement_document entity
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: query
          in: query
          schema:
            type: string
          example: '"entity_type EQ ^requirement_document^"'
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            id,user_name,timestamp,user_id,action,entity_type,entity_id,entity_physical_id,session_id,request_id,change_set
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces:
    get:
      tags:
        - workspaces
      summary: Get all workspaces
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: fields
          in: query
          schema:
            type: string
          example: name
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/business_rules:
    get:
      tags:
        - business_rules
      summary: Get all business rules
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/external-entity-actions:
    get:
      tags:
        - external-actions
      summary: Get all external-entity-actions
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    put:
      tags:
        - external-actions
      summary: Add external-entity-actions
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                data:
                  - name: alieninvasion
                    title: Easter Alien Invasion
                    entity_type:
                      - defect
                    views:
                      - list
                      - details
                    icon: system
                    url: http://cykod.github.io/AlienInvasion/
                    single_entity: false
                  - name: duckhunt
                    title: Easter Duck Hunt
                    entity_type:
                      - defect
                    views:
                      - list
                      - details
                    icon: expert-star
                    url: https://duckhuntjs.com/
                    single_entity: false
                  - name: ski
                    title: Easter Ski
                    entity_type:
                      - defect
                    views:
                      - list
                      - details
                    icon: merge
                    url: http://basicallydan.github.io/skifree.js/
                    single_entity: false
                  - name: snake
                    title: Easter Coffee Snake
                    entity_type:
                      - defect
                    views:
                      - list
                      - details
                    icon: refresh
                    url: http://dommmel.github.io/coffee-snake/
                    single_entity: false
                  - name: sorades
                    title: Easter Sorades 13K
                    entity_type:
                      - defect
                    views:
                      - list
                      - details
                    icon: check
                    url: http://maettig.com/code/canvas/starship-sorades-13k/
                    single_entity: false
                  - name: survivor
                    title: Easter Survivor
                    entity_type:
                      - defect
                    views:
                      - list
                      - details
                    icon: children
                    url: http://www.schillmania.com/survivor/
                    single_entity: false
                  - name: url
                    title: open URL
                    entity_type:
                      - defect
                    views:
                      - list
                      - details
                    icon: system
                    url: http://{entity.jira_key_udf}
                    single_entity: true
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: HPECLIENTTYPE
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /internal-api/shared_spaces/{shared_space}/workspaces/{workspace}/import-tests:
    post:
      tags:
        - export | import
      summary: Import tests from excel
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                type:
                  type: string
                  example: skip-warnings
                content:
                  type: string
                  format: binary
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: hpeclienttype
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /internal-api/shared_spaces/{shared_space}/workspaces/{workspace}/import-requirement:
    post:
      tags:
        - export | import
      summary: Import requirements from excel
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                type:
                  type: string
                  example: skip-warnings
                content:
                  type: string
                  format: binary
                root_node:
                  type: string
                  example: '{"id":"278008"}'
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: hpeclienttype
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/reports/large:
    post:
      tags:
        - export | import
      summary: Export requirement as document
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: "{\r\n   \"document_type\":\"PDF\",\r\n   \"document_orientation\":\"PORTRAIT\",\r\n   \"timezone\":\"UTC+02:00\",\r\n   \"file_name\":\"Requirement_AK_DEMO\",\r\n   \"report_entries\":[\r\n      {\r\n         \"entity_name\":\"requirement\",\r\n         \"fields\":[\r\n            \"id\",\r\n            \"name\",\r\n            \"description\"\r\n         ],\r\n         \"filter\":null,\r\n         \"include_attachments\":\"NO_ATTACHMENTS\",\r\n         \"layout\":\"DOCUMENT\",\r\n         \"subtypes\":[\r\n            \"requirement_document\"\r\n         ],\r\n         \"title\":null,\r\n         \"document_ids\":[\r\n            {{requirement_document_id}}\r\n         ]\r\n      }\r\n   ],\r\n   \"title\":\"\",\r\n   \"description\":null,\r\n   \"show_author\":false,\r\n   \"show_date\":false,\r\n   \"logo\":null,\r\n   \"header\":null,\r\n   \"footer\":null,\r\n   \"ignore_default_header\":true,\r\n   \"ignore_default_footer\":true,\r\n   \"ignore_default_logo\":true,\r\n   \"print_toc\":false,\r\n   \"print_title_page\":false\r\n}"
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: hpeclienttype
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/reports:
    post:
      tags:
        - export | import
      summary: export defects into excel
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                document_type: EXCEL
                timezone: UTC+02:00
                file_name: Octane_backlog.OctaneAcademy.defects
                report_entries:
                  - entity_name: work_item
                    subtypes:
                      - defect
                    fields:
                      - id
                      - has_attachments
                      - name
                      - description
                      - priority
                      - severity
                      - phase
                      - detected_by
                      - detected_in_release
                      - release
                      - owner
                      - last_modified
                      - milestone
                      - taxonomies
                      - subtype
                    include_attachments: NO_ATTACHMENTS
                    order_by: null
                    filter: '"(id IN {{defectIds_export}})"'
                purpose: EXPORT_FOR_IMPORT
                is_export_for_create_import: false
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: hpeclienttype
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/background_tasks:
    get:
      tags:
        - export | import
      summary: get background tasks status
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: hpeclienttype
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: fetch_single_entity
          in: query
          schema:
            type: boolean
          example: 'true'
        - name: fields
          in: query
          schema:
            type: string
          example: >-
            creation_time,client_lock_stamp,has_attachments,attachments,version_stamp,author,end_time,workspace_id,result,start_time,followed_by_me,app_key,task_type,last_modified,max_wait_time,status
        - name: offset
          in: query
          schema:
            type: integer
          example: '0'
        - name: query
          in: query
          schema:
            type: string
          example: '"(id=''85011'')"'
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/attachments/123009:
    get:
      tags:
        - export | import
      summary: get excel file for export
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/octet-stream
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /api/shared_spaces/{shared_space}/workspaces/{workspace}/attachments/3002/Requirement_AK_DEMO.pdf:
    get:
      tags:
        - export | import
      summary: Export requirement as document Copy
      parameters:
        - name: ALM-OCTANE-TECH-PREVIEW
          in: header
          schema:
            type: string
          example: '{{tech_preview_flag}}'
        - name: hpeclienttype
          in: header
          schema:
            type: string
          example: IT_PRIVATE
        - name: shared_space
          in: path
          schema:
            type: string
          required: true
        - name: workspace
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
