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:
 webtriggerURL /hierarchy:
    post:
      tags:
        - Hierarchy
 Hiearachy     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/scheduler 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
                additionalProperties: true
        '400':
          description: Bad request, when the task identifier is missing or invalid.
        '404':
          description: Task not found.

  /hierScheduler:
    post:
      tags:
        - Hierarchy Scheduler
      summary: Manage hierarchy scheduler
      description: Create, update, or delete hierarchy scheduler.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: string
                type:
                  type: string
                scName:
                  type: string
                CRON:
                  type: string
      responses:
        '200':
          description: Scheduler managed successfully.
        '404':
          description: Scheduler or hierarchy not found.
        '501':
          description: Internal server error.

components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

security:
  - BearerAuth: []