Page Comparison

openapi: 3.0.0
info:
  title: SITC API
  version: 1.0.0
  description: Apply Hierarchy, Get Apply Hierarchy Status, Create Scheduler, Update Scheduler

paths:
  /hierarchy:
    post:
      tags:
        - Hierarchy
      summary: Apply hierarchy by ID
      description: Initiates a hierarchy apply process.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: string
                  enum:
                    - hierarchy
                hierId:
                  type: string
                hierarchyVars:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      value:
                        type: string
      responses:
        '200':
          description: Hierarchy Apply process has been initiated successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
                  taskId:
                    type: string
                  details:
                    type: string
        '401':
          description: Unauthorized access.
        '503':
          description: Service unavailable.

  /getHierStatus:
    post:
      tags:
        - Hierarchy
      summary: Get Applying for Hierarchy Status by Job Id
      description: Retrieves the status of a hierarchy task.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: string
                  enum:
                    - getHierStatus
                task:
                  type: string
                  description: The identifier of the hierarchy task.
      responses:
        '200':
          description: Successfully retrieved the status of the hierarchy task.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
        '400':
          description: Bad request, when the task identifier is missing or invalid.
        '404':
          description: Task not found.

  /hierarchy/scheduler:
    post:
      tags:
        - Hierarchy
      summary: Create or Edit Hierarchy Scheduler
      description: Creates or edits a hierarchy scheduler.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: string
                  enum:
                    - hierScheduler
                type:
                  type: string
                  enum:
                    - create
                    - edit
                hierId:
                  type: string
                scName:
                  type: string
                CRON:
                  type: string
                  pattern: '^(\d+|\*) (\d+|\*) (\d+|\*) (\d+|\*) (\d+|\*)$'
                  description: "CRON expression, e.g., '17 9 * * 6' for 9:17 AM every Saturday"
                repeat:
                  type: boolean
                isActive:
                  type: boolean
                utcOffset:
                  type: integer
                  description: UTC offset in minutes.
                utcZone:
                  type: string
                  description: Time zone, e.g., 'Europe/Kiev'.
      responses:
        '200':
          description: Scheduler has been successfully created or edited.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
        '400':
          description: Bad request, when provided data is invalid.
        '404':
          description: Hierarchy or scheduler not found.
        '501':
          description: Internal server error.

components:
  securitySchemes:
    BearerAuth:  /template:
    post:
      tags:
        - Template
      summary: Perform an operation with a template
      description: This endpoint performs operations using a specific template.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: string
                  enum:
                    - template
                templateId:
                  type: string
                projectId:
                  type: string
                issueTypeId:
                  type: string
      responses:
        '200':
          description: The operation with the template was successful.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
        '400':
          description: Bad request, when the provided data is invalid.
        '401':
          description: Unauthorized access.
        '404':
          description: Template not found.
        type'500':
http          schemedescription: bearerInternal server error.

components:
  bearerFormatsecuritySchemes:
  JWT  securityBearerAuth:
     - BearerAuthtype: []http