{
    "openapi":"3.0.0",
    "info":{
        "title":"REST API Reference for TES Microservice",
        "description":"<p>\n<b>Oracle Communications Solution Test Automation Platform</b> provides APIs for the TDS (Test Data Service) and TES (Test Execution Service) microservices. These APIs allow users to automate, manage, and monitor various aspects of the testing platform in a cloud-native environment.\n</p>\n\n<p>\n<b>The API can perform tasks in the following categories:</b>\n</p>\n\n<ul>\n<li><b>Action:</b> Manage and execute test actions or steps.</li>\n<li><b>Automation:</b> Initiate and control automated test processes.</li>\n<li><b>Environment:</b> Configure and manage test environments.</li>\n<li><b>Execution:</b> Start, monitor, and stop test executions.</li>\n<li><b>Job:</b> Create, schedule, and review test jobs.</li>\n<li><b>Scenario:</b> Define, update, and run test scenarios.</li>\n<li><b>User:</b> Manage user accounts and access permissions.</li>\n</ul>",
        "version":"2026.04.28",
        "x-summary":"Oracle Communications Solution Test Automation Platform provides APIs for the TDS (Test Data Service) and TES (Test Execution Service) microservices."
    },
    "paths":{
        "/taas/runAutomationJob":{
            "post":{
                "description":"Runs the automation job.",
                "summary":"Run Automation",
                "tags":[
                    "Automation"
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "$ref":"#/components/schemas/AutomationJobReq"
                            }
                        }
                    }
                },
                "responses":{
                    "default":{
                        "description":"Sets the default response."
                    }
                },
                "x-internal-id":"taas-runAutomationJob-post",
                "x-filename-id":"taas-runautomationjob-post"
            }
        },
        "/taas/runJob/{jobID}":{
            "post":{
                "summary":"Run a Job by ID",
                "description":"Runs the given job.",
                "tags":[
                    "Job"
                ],
                "parameters":[
                    {
                        "$ref":"#/components/parameters/JobId"
                    }
                ],
                "responses":{
                    "default":{
                        "description":"Sets the default response."
                    }
                },
                "x-internal-id":"taas-runJob-{jobID}-post",
                "x-filename-id":"taas-runjob-jobid-post"
            }
        },
        "/taas/job/stop/{executionID}":{
            "post":{
                "description":"Stops executing the job with the given ID in TES Engine.",
                "summary":"Stop Job Execution",
                "tags":[
                    "Job"
                ],
                "parameters":[
                    {
                        "$ref":"#/components/parameters/executionId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"The job execution was stopped successfully.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "status":{
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "404":{
                        "description":"The execution ID was not found.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "status":{
                                            "type":"integer",
                                            "example":404
                                        },
                                        "error":{
                                            "type":"string",
                                            "example":"Data not found"
                                        },
                                        "message":{
                                            "type":"string",
                                            "example":"No value present"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"taas-job-stop-{executionID}-post",
                "x-filename-id":"taas-job-stop-executionid-post"
            }
        },
        "/taas/job/{executionID}":{
            "get":{
                "summary":"Get Job Status by ID",
                "description":"Retrieves the given job's status.",
                "tags":[
                    "Job"
                ],
                "parameters":[
                    {
                        "$ref":"#/components/parameters/executionId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"The job status was successfully found.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "status":{
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "404":{
                        "description":"The job was not found.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "status":{
                                            "type":"string",
                                            "example":404
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"taas-job-{executionID}-get",
                "x-filename-id":"taas-job-executionid-get"
            }
        },
        "/taas/getAutomationJobStatus/{jobID}":{
            "get":{
                "summary":"Get Automation Job Status",
                "description":"Checks whether result.json exists for the specified job ID.",
                "tags":[
                    "Automation"
                ],
                "parameters":[
                    {
                        "$ref":"#/components/parameters/JobId"
                    }
                ],
                "responses":{
                    "default":{
                        "description":"Retrieves the default response."
                    }
                },
                "x-internal-id":"taas-getAutomationJobStatus-{jobID}-get",
                "x-filename-id":"taas-getautomationjobstatus-jobid-get"
            }
        }
    },
    "components":{
        "schemas":{
            "AutomationJobReq":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "executionConfig":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string"
                            },
                            "execution":{
                                "type":"string"
                            },
                            "group":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "name":{
                                            "type":"string"
                                        },
                                        "execution":{
                                            "type":"string"
                                        },
                                        "scenarios":{
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "environment":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string"
                                },
                                "type":{
                                    "type":"string"
                                },
                                "hostname":{
                                    "type":"string"
                                },
                                "url":{
                                    "type":"string"
                                },
                                "authorization":{
                                    "type":"string"
                                },
                                "authorization.type":{
                                    "type":"string"
                                },
                                "basic.username":{
                                    "type":"string"
                                },
                                "basic.password":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "callBack":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string"
                            },
                            "url":{
                                "type":"string"
                            },
                            "authorize":{
                                "type":"boolean"
                            },
                            "authorization":{
                                "type":"object",
                                "properties":{
                                    "type":{
                                        "type":"string"
                                    },
                                    "basic":{
                                        "type":"object",
                                        "properties":{
                                            "username":{
                                                "type":"string"
                                            },
                                            "password":{
                                                "type":"string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "parameters":{
            "JobId":{
                "name":"jobID",
                "required":true,
                "schema":{
                    "type":"integer"
                },
                "in":"path"
            },
            "executionId":{
                "name":"executionID",
                "required":true,
                "schema":{
                    "type":"integer"
                },
                "in":"path"
            }
        }
    },
    "swagger":"2.0",
    "tags":[
        {
            "name":"Automation",
            "description":"The operations from the Automation category."
        },
        {
            "name":"Job",
            "description":"The operations from the Job category."
        }
    ]
}