Swagger open api macro | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
openapi: 3.0.0 info: title: YourSITC API Title version: 1.0.0 description: Description of your API Apply Hierarchy, Get Apply Hierarchy Status, Create Scheduler, Update Scheduler paths: /hierarchy: post: tags: - Hierarchy summary: Apply hierarchy by operationID 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 decoded: items: type: object properties: name: type: string value: type: string responses: '200': description: Hierarchy operation 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. /hierarchy/status:getHierStatus: post: gettags: - Hierarchy summary: Get hierarchy status Applying for Hierarchy Status by Job Id description: Retrieves the current status of a hierarchy operation.task. requestBody: required: true content: application/json: schema: type: object properties: parameters entity: - in: query type: string name: taskenum: - getHierStatus schema:task: type: string required: true description: The identifier of the hierarchy task. responses: '200': description: CurrentSuccessfully retrieved the status of the hierarchy statustask. 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: Manage hierarchy schedulerCreate or Edit Hierarchy Scheduler description: Create,Creates update,or oredits deletea 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 managed successfullybeen 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: SchedulerHierarchy or hierarchyscheduler not found. '501': description: Internal server error. /template: post: tags: - Template summary: Perform an operation with a template description: This endpoint performs operations using a specific template. components requestBody: required: true content: securitySchemes application/json: BearerAuth: schema: type: object properties: http schemeentity: bearer bearerFormattype: JWT security: 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. '500': description: Internal server error. components: securitySchemes: BearerAuth: [] type: http |
Page Comparison
General
Content
Integrations