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 Scheduler
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.
/hierScheduler/hierarchy/scheduler:
post:
posttags:
tags:- Hierarchy
summary: Create or -Edit Hierarchy Scheduler
description: Creates or summary:edits Managea hierarchy scheduler.
description: Create, update, or delete hierarchy scheduler.requestBody:
required: true
content:
application/json:
schema:
requestBody:type: object
requiredproperties:
true content:entity:
application/json:type: string
schemaenum:
- hierScheduler
type:
object propertiestype: string
entity:
enum:
- create
- edit
hierId:
type: string
scName:
type: string
CRON:
type: string
pattern: '^(\d+|\*) (\d+|\*) (\d+|\*) (\d+|\*) (\d+|\*)$'
scName:
description: "CRON expression, e.g., '17 9 * * 6' for 9:17 AM every Saturday"
repeat:
type: boolean
isActive:
type: boolean
utcOffset:
type: stringinteger
CRON:description: UTC offset in minutes.
utcZone:
type: string
responsesdescription: Time zone, e.g., 'Europe/Kiev'.
responses:
'200':
description: Scheduler managedhas been successfully created or edited.
'404':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.
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
security:
- BearerAuth: []
|