Skip to content

Instantly share code, notes, and snippets.

@KuroNoDev

KuroNoDev/swag.json

Created October 29, 2015 05:10
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save KuroNoDev/7dddff10d660028b3a8b to your computer and use it in GitHub Desktop.
Save KuroNoDev/7dddff10d660028b3a8b to your computer and use it in GitHub Desktop.
Download ZIP
Raw
swag.json
{
"swagger": "2.0",
"info": {
"description": "TORO Integrate API",
"version": "1.0.0",
"title": "TORO Integrate API",
"contact": {
"name": ""
},
"license": {
"name": "",
"url": ""
}
},
"host": "dev-esb.toroserver.com",
"basePath": "/",
"tags": [
{
"name": "examplesfile",
"description": ""
},
{
"name": "database",
"description": "Database API"
},
{
"name": "api-cost",
"description": "Monitoring API Rest Service Examples"
},
{
"name": "examples",
"description": "TORO Integrate Example REST Services"
},
{
"name": "endpoint",
"description": "Endpoint API"
},
{
"name": "property",
"description": "Property API"
},
{
"name": "utility",
"description": "Utility API"
},
{
"name": "examplessnoop",
"description": ""
},
{
"name": "permission",
"description": "Permission API"
},
{
"name": "package",
"description": "Package API"
}
],
"schemes": [
"http"
],
"paths": {
"/api/1.0/messages/save-api.json": {
"post": {
"operationId": "mandrillRegister",
"parameters": [
{
"name": "alias",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "apikey",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
},
"headers": {}
}
}
}
},
"/api/api-cost/calculate-bill": {
"post": {
"tags": [
"api-cost"
],
"summary": "/calculate-bill",
"description": "Here is an example method that calculates costs as follows: The first 10,000 calls a month are $100.00 (100 calls per dollar) The next 20,000 calls a month are $150.00 (133.33 calls per dollar, $250 in total) Each 1,000 calls after that are $2.00 (500 calls per dollar, $250 + X in total)",
"operationId": "calculateCost",
"parameters": [
{
"in": "body",
"name": "monitorBill",
"description": "Monitor bill object from the solr schema ",
"required": true,
"schema": {
"$ref": "#/definitions/MonitorBill"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/MonitorBill"
}
}
}
}
},
"/api/api-cost/get-bill": {
"get": {
"tags": [
"api-cost"
],
"summary": "/get-bill",
"description": "This code can be used to run on a schedule, say the first day of the month. This code will use last month as the billing period",
"operationId": "getMonitorBills",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"/api/api-cost/get-bill/{year}/{month}": {
"get": {
"tags": [
"api-cost"
],
"summary": "/get-bill/{year}/{month}",
"description": "Gets a list of monitor bill records for all users in the ESB. The monitor bill records will just show the total (summed) costs and the first 20 service invokes.",
"operationId": "getMonitorBills",
"parameters": [
{
"name": "year",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "month",
"in": "path",
"description": "zero-based month. 0 = January, 1 = February, etc. ",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"/api/examples/currency/{from}/{to}": {
"get": {
"tags": [
"examples"
],
"summary": "/currency/{from}/{to}",
"description": "A simple example that calls a web service and returns the result. We use ESB annotations here to ensure that when using the ESB UI to invoke the service, only a small list of currencies appear",
"operationId": "convertRate",
"parameters": [
{
"name": "from",
"in": "path",
"description": "The currency to convert from ",
"required": true,
"type": "string",
"enum": [
"AUD",
"GBP",
"PHP",
"USD"
]
},
{
"name": "to",
"in": "path",
"description": "The currency to convert to ",
"required": true,
"type": "string",
"enum": [
"AUD",
"GBP",
"PHP",
"USD"
]
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
}
}
},
"/api/examples/email/send": {
"post": {
"tags": [
"examples"
],
"summary": "email/send",
"description": "This snippet shows how to send email messages asynchronously with TORO Integrate. Simply provide it with a your smtp(s) details, to address, subject and the recipient's name. TORO Integrate will then send the email for you. Read more about the endpoint <a href=\"http://docs.toro.io/display/INT/Email\">here</a>. If you look at the source you'll see that the actual code is simply wrapped in a set of extra braces. TORO Integrate will then invoke the code asynchronously! This is useful for requests that take a little while. The thread that initially processed the request is put back into the pool ready to process another request. The actual code itself is invoked from another thread. When the service completes, a response is served from another thread",
"operationId": "sendEmail",
"parameters": [
{
"name": "protocol",
"in": "query",
"description": "The SMTP/S protocol to use, must be smtp or smtps. ",
"required": true,
"type": "string",
"enum": [
"smtp",
"smtps"
]
},
{
"name": "emailLogin",
"in": "query",
"description": "The login/email address to use to log in to the SMTP/S server ",
"required": true,
"type": "string"
},
{
"name": "password",
"in": "query",
"description": "Your password ",
"required": true,
"type": "string"
},
{
"name": "server",
"in": "query",
"description": "SMTP/S server name/IP ",
"required": true,
"type": "string",
"default": "smtp.gmail.com"
},
{
"name": "port",
"in": "query",
"description": "Server port number ",
"required": true,
"type": "integer",
"default": "587",
"format": "int32"
},
{
"name": "to",
"in": "query",
"description": "The recipient's email address ",
"required": true,
"type": "string"
},
{
"name": "subject",
"in": "query",
"description": "The email subject ",
"required": true,
"type": "string"
},
{
"name": "recipientName",
"in": "query",
"description": "The recipient's name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
}
}
},
"/api/examples/file/readtext": {
"post": {
"tags": [
"examplesfile"
],
"summary": "readtext",
"description": "Simple operation that reads a file and sends back the content (only works for known text-based file extensions).",
"operationId": "readTextFile",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "file",
"in": "formData",
"required": false,
"type": "file"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
}
}
},
"/api/examples/forecast/{token}/{latitude}/{longitude}": {
"get": {
"tags": [
"examples"
],
"summary": "/forecast/{token}/{latitude}/{longitude}",
"description": "This is an example service to use ESB one liner methods by calling forecast.io API. account details will be exported/imported also.",
"operationId": "displayForecast",
"parameters": [
{
"name": "token",
"in": "path",
"description": "The forecast.io access token to use the API ",
"required": true,
"type": "string",
"default": "bebbf6601cb9b32f96c99ce10cebf27b"
},
{
"name": "latitude",
"in": "path",
"description": "value from target coordinates. ",
"required": true,
"type": "string",
"default": "15.1462752"
},
{
"name": "longitude",
"in": "path",
"description": "value from target coordinates.",
"required": true,
"type": "string",
"default": "120.5594641"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
},
"security": [
{
"ESBAPIAdminGroup": []
}
]
}
},
"/api/examples/jms/publish/{jmsQueue}": {
"get": {
"tags": [
"examples"
],
"summary": "jms/publish/{jmsQueue:.+}",
"description": "This snippet shows how easy it is to send a message to a particular queue.",
"operationId": "sendJMSMessage",
"parameters": [
{
"name": "jmsQueue",
"in": "path",
"description": "The name of the queue to send the text to ",
"required": true,
"type": "string",
"pattern": ".+"
},
{
"name": "messageContent",
"in": "query",
"description": "The message content",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object"
}
}
}
}
},
"/api/examples/postcode/{location}": {
"get": {
"tags": [
"examples"
],
"summary": "/postcode/{location}",
"description": "Another example that gets the location for a given postcode in Australia",
"operationId": "getLocationPostcodes",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"default": "Sydney"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
}
}
},
"/api/examples/sql/add-employee": {
"post": {
"tags": [
"examples"
],
"summary": "sql/add-employee",
"description": "TORO Integrate allows you to easily get a <a href=\"http://docs.groovy-lang.org/docs/latest/html/api/groovy/sql/Sql.html\">Groovy SQL</a> object that's already connected to a TORO Integrate JDBC Connection pool. This script shows how easy it is to expose a RESTful api that uses a database to add a record. <br/>",
"operationId": "addEmployee",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "employee",
"description": "The employee to add. This example uses a strongly typed object that contains JAXB and validation annotations.",
"required": true,
"schema": {
"$ref": "#/definitions/Employee"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
}
}
},
"/api/examples/sql/bulk-insert": {
"post": {
"tags": [
"examples"
],
"summary": "sql/bulk-insert",
"description": "Send a comma separated list of employee records in the following format to this method to add multiple employee records in one request: <pre> &lt;name1&gt;,&lt;position1&gt;,&lt;department1&gt;<br/> &lt;name2&gt;,&lt;position2&gt;,&lt;department2&gt;<br/> ... </pre>",
"operationId": "bulkInsertEmployees",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "body",
"in": "formData",
"required": false,
"type": "file"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"/api/examples/sql/delete/{id}": {
"delete": {
"tags": [
"examples"
],
"summary": "sql/delete/{id}",
"description": "Simple method that shows how to delete a record. The ID is part of the URI when used via REST.",
"operationId": "deleteEmployee",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The employee ID. ",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
},
"404": {
"description": "Employee not found "
}
}
}
},
"/api/examples/sql/get/{id}": {
"get": {
"tags": [
"examples"
],
"summary": "sql/get/{id}",
"description": "This method returns a single employee object. Unlike the list method, this returns a populated employee object",
"operationId": "getEmployee",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "the employee id to get ",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Employee"
}
},
"404": {
"description": "Employee not found "
}
}
}
},
"/api/examples/sql/list": {
"get": {
"tags": [
"examples"
],
"summary": "sql/list",
"description": "This method shows one way of iterating through a table and returning data from inside it.",
"operationId": "getEmployees",
"produces": [
"application/xml",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object"
}
}
}
}
},
"/api/examples/sql/update/{id}": {
"patch": {
"tags": [
"examples"
],
"summary": "sql/update/{id}",
"description": "Simple method that shows how to update a record. The ID is part of the URI when used via REST.",
"operationId": "updateEmployee",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The employee ID. ",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "employee",
"description": "The employee record. The ID here is ignored. ",
"required": true,
"schema": {
"$ref": "#/definitions/Employee"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
},
"404": {
"description": "Employee not found "
}
}
}
},
"/api/examples/test-async": {
"get": {
"tags": [
"examples"
],
"operationId": "testAsync",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object"
},
"headers": {}
}
}
}
},
"/api/examples/weather-zip/{zipCode}": {
"get": {
"tags": [
"examples"
],
"summary": "/weather-zip/{zipCode}",
"description": "Another example that gets the weather for a zip code in the USA",
"operationId": "publishCityForecastByZip",
"parameters": [
{
"name": "zipCode",
"in": "path",
"required": true,
"type": "string",
"default": "90210"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
}
}
},
"/api/examples/weather/{city}/{countryCode}/{temperatureScale}": {
"get": {
"tags": [
"examples"
],
"summary": "/weather/{city}/{countryCode}/{temperatureScale}",
"description": "Simple HTTP example. This example does a HTTP post to a specific url. It then uses built-in libraries to parse the response as json, and display various parameters from the response. Enter a city and country code, it will then get the current weather for the location from <a href=\"http://openweathermap.org/\">http://openweathermap.org/</a>",
"operationId": "getWeather",
"parameters": [
{
"name": "city",
"in": "path",
"description": "The city to get weather information for ",
"required": true,
"type": "string",
"default": "Sydney"
},
{
"name": "countryCode",
"in": "path",
"description": "The 2 letter country code where the city belongs ",
"required": true,
"type": "string",
"default": "AU"
},
{
"name": "temperatureScale",
"in": "path",
"required": true,
"type": "string",
"enum": [
"Celsius",
"Fahrenheit"
]
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/APIResponse"
}
}
}
}
},
"/esbapi/v1/manage/database/add": {
"post": {
"tags": [
"database"
],
"summary": "Add Database",
"description": "Add Database",
"operationId": "addDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "jdbcConnectionInfo",
"required": false,
"schema": {
"$ref": "#/definitions/jdbc-connection-info"
}
}
],
"responses": {
"200": {
"description": "Database saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/delete": {
"delete": {
"tags": [
"database"
],
"summary": "Delete multiple Databases",
"description": "Delete multiple Databases",
"operationId": "deleteDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "objectList",
"required": false,
"schema": {
"$ref": "#/definitions/RestDatabaseListModelString"
}
}
],
"responses": {
"200": {
"description": "Databases deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/delete/{name}": {
"delete": {
"tags": [
"database"
],
"summary": "Delete Database",
"description": "Delete Database",
"operationId": "deleteDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "Database name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Database deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/get": {
"get": {
"tags": [
"database"
],
"summary": "Get database",
"description": "Get database information",
"operationId": "getDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "databaseName",
"in": "query",
"description": "Database name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Database found"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/list": {
"get": {
"tags": [
"database"
],
"summary": "List all databases",
"description": "List all databases",
"operationId": "listDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/start": {
"post": {
"tags": [
"database"
],
"summary": "Start multiple Databases",
"description": "Start multiple Databases",
"operationId": "startDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "objectList",
"required": false,
"schema": {
"$ref": "#/definitions/RestDatabaseListModelString"
}
}
],
"responses": {
"200": {
"description": "Databases started"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/start/{name}": {
"get": {
"tags": [
"database"
],
"summary": "Start Database",
"description": "Start Database",
"operationId": "startDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "Database name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Database started"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/stop": {
"get": {
"tags": [
"database"
],
"summary": "Stop multiple Database",
"description": "Stop multiple Database",
"operationId": "stopDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "objectList",
"required": false,
"schema": {
"$ref": "#/definitions/RestDatabaseListModelString"
}
}
],
"responses": {
"200": {
"description": "Databases stopped"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/stop/{name}": {
"get": {
"tags": [
"database"
],
"summary": "Stop Database",
"description": "Stop Database",
"operationId": "stopDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "Database name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Database stopped"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/database/update": {
"put": {
"tags": [
"database"
],
"summary": "Update Database",
"description": "Update Database",
"operationId": "updateDatabase",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "jdbcConnectionInfo",
"required": false,
"schema": {
"$ref": "#/definitions/jdbc-connection-info"
}
}
],
"responses": {
"200": {
"description": "Database saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/add": {
"post": {
"tags": [
"endpoint"
],
"summary": "Add endpoint",
"description": "Add endpoint",
"operationId": "addEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "endpointModel",
"required": false,
"schema": {
"$ref": "#/definitions/EndpointModel"
}
}
],
"responses": {
"200": {
"description": "Endpoint saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/delete": {
"delete": {
"tags": [
"endpoint"
],
"summary": "Delete multiple endpoints",
"description": "Delete multiple endpoints",
"operationId": "deleteMultipleEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "endpointListModel",
"required": false,
"schema": {
"$ref": "#/definitions/Endpoint List"
}
}
],
"responses": {
"200": {
"description": "Endpoints deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/delete/{packageName}/{endpointName}": {
"delete": {
"tags": [
"endpoint"
],
"summary": "Delete endpoint",
"description": "Delete endpoint",
"operationId": "deleteEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"name": "packageName",
"in": "path",
"description": "ESBPackage name",
"required": true,
"type": "string"
},
{
"name": "endpointName",
"in": "path",
"description": "Endpoint name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Endpoint deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/get": {
"get": {
"tags": [
"endpoint"
],
"summary": "Get endpoint",
"description": "Get endpoint information",
"operationId": "getEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"name": "packageName",
"in": "query",
"description": "ESBPackage name",
"required": true,
"type": "string"
},
{
"name": "endpointName",
"in": "query",
"description": "Endpoint name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Endpoint found"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/list": {
"get": {
"tags": [
"endpoint"
],
"summary": "List all endpoint",
"description": "List all endpoint",
"operationId": "listEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/list/{packageName}": {
"get": {
"tags": [
"endpoint"
],
"summary": "List all endpoint in a package",
"description": "List all endpoint in a package",
"operationId": "listPackageEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"name": "packageName",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/start": {
"post": {
"tags": [
"endpoint"
],
"summary": "Start multiple endpoint",
"description": "Start multiple endpoint",
"operationId": "startMultipleEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "endpointListModel",
"required": false,
"schema": {
"$ref": "#/definitions/Endpoint List"
}
}
],
"responses": {
"200": {
"description": "Endpoints started"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/start/{packageName}/{endpointName}": {
"get": {
"tags": [
"endpoint"
],
"summary": "Start endpoint",
"description": "Start endpoint",
"operationId": "startEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"name": "packageName",
"in": "path",
"description": "ESBPackage name",
"required": true,
"type": "string"
},
{
"name": "endpointName",
"in": "path",
"description": "Endpoint name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Endpoint Started"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/stop": {
"post": {
"tags": [
"endpoint"
],
"summary": "Stop multiple endpoint",
"description": "Stop multiple endpoint",
"operationId": "stopMultipleEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "endpointListModel",
"required": false,
"schema": {
"$ref": "#/definitions/Endpoint List"
}
}
],
"responses": {
"200": {
"description": "Endpoints stopped"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/stop/{packageName}/{endpointName}": {
"get": {
"tags": [
"endpoint"
],
"summary": "Stop endpoint",
"description": "Stop endpoint",
"operationId": "stopEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"name": "packageName",
"in": "path",
"description": "ESBPackage name",
"required": true,
"type": "string"
},
{
"name": "endpointName",
"in": "path",
"description": "Endpoint name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Endpoint stopped"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/endpoint/update": {
"put": {
"tags": [
"endpoint"
],
"summary": "Update endpoint",
"description": "Update endpoint",
"operationId": "updateEndpoint",
"produces": [
"application/xml",
"text/plain",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "endpointModel",
"required": false,
"schema": {
"$ref": "#/definitions/EndpointModel"
}
}
],
"responses": {
"200": {
"description": "Endpoint saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/add": {
"post": {
"tags": [
"package"
],
"summary": "Add ESBPackage",
"description": "Add ESBPackage",
"operationId": "addPackage",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "packageModel",
"required": false,
"schema": {
"$ref": "#/definitions/ESBPackage Model"
}
}
],
"responses": {
"200": {
"description": "ESBPackage saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/configure": {
"put": {
"tags": [
"package"
],
"summary": "Configure ESBPackage",
"description": "Configure ESBPackage",
"operationId": "configurePackage",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "packageConfigureModel",
"required": false,
"schema": {
"$ref": "#/definitions/ESBPackage Configure Model"
}
}
],
"responses": {
"200": {
"description": "ESBPackages configured"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/delete": {
"delete": {
"tags": [
"package"
],
"summary": "Delete multiple ESBPackages",
"description": "Delete multiple ESBPackages",
"operationId": "deletePackages",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "esbPackageList",
"required": false,
"schema": {
"$ref": "#/definitions/ESBPackage ListString"
}
}
],
"responses": {
"200": {
"description": "ESBPackages deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/delete/{name}": {
"delete": {
"tags": [
"package"
],
"summary": "Delete ESBPackage",
"description": "Delete ESBPackage",
"operationId": "deletePackages",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "ESBPackage name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "ESBPackage deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/get": {
"get": {
"tags": [
"package"
],
"summary": "Get ESBPackage",
"description": "Get ESBPackage information",
"operationId": "getESBPackage",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "packageName",
"in": "query",
"description": "ESBPackage name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "ESBPackage found"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/list": {
"get": {
"tags": [
"package"
],
"summary": "List all ESBPackage",
"description": "List all ESBPackage",
"operationId": "getPackages",
"produces": [
"application/xml",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/start": {
"post": {
"tags": [
"package"
],
"summary": "Start multiple ESBPackage",
"description": "Start multiple ESBPackages",
"operationId": "startPackages",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "esbPackageList",
"required": false,
"schema": {
"$ref": "#/definitions/ESBPackage ListString"
}
}
],
"responses": {
"200": {
"description": "ESBPackages started"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/start/{name}": {
"get": {
"tags": [
"package"
],
"summary": "Start ESBPackage",
"description": "Start ESBPackage",
"operationId": "startPackage",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "ESBPackage name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "ESBPackage started"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/stop": {
"post": {
"tags": [
"package"
],
"summary": "Stop multiple ESBPackage",
"description": "Stop multiple ESBPackages",
"operationId": "stopPackage",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "esbPackageList",
"required": false,
"schema": {
"$ref": "#/definitions/ESBPackage ListString"
}
}
],
"responses": {
"200": {
"description": "ESBPackages stopped"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/stop/{name}": {
"get": {
"tags": [
"package"
],
"summary": "Stop ESBPackage",
"description": "Stop ESBPackage",
"operationId": "stopPackage",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "ESBPackage name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "ESBPackage stopped"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/package/upload": {
"post": {
"tags": [
"package"
],
"summary": "Upload ESBPackage",
"description": "Upload ESBPackage in zip format",
"operationId": "importPackage",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "file",
"in": "formData",
"description": "ESBPackage Zip file",
"required": true,
"type": "file"
},
{
"name": "startOnCreate",
"in": "query",
"description": "Start package on import",
"required": false,
"type": "string"
},
{
"name": "includePackageProperties",
"in": "query",
"description": "Include package properties file",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "ESBPackages uploaded"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/group/add": {
"post": {
"tags": [
"permission"
],
"summary": "Add group",
"description": "Add group",
"operationId": "addGroup",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Group name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Group saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/group/delete": {
"delete": {
"tags": [
"permission"
],
"summary": "Delete multiple group",
"description": "Delete multiple group",
"operationId": "deleteMultipleGroup",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "permissionList",
"required": false,
"schema": {
"$ref": "#/definitions/RestPermissionGroupListModelString"
}
}
],
"responses": {
"200": {
"description": "Groups deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/group/delete/{name}": {
"delete": {
"tags": [
"permission"
],
"summary": "Delete group",
"description": "Delete group",
"operationId": "deleteGroup",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "Group name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Group deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/group/get": {
"get": {
"tags": [
"permission"
],
"summary": "Get group",
"description": "Get group information",
"operationId": "findGroup",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Group name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Group found"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/group/list": {
"get": {
"tags": [
"permission"
],
"summary": "List all group",
"description": "List all group",
"operationId": "groupList",
"produces": [
"application/xml",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/group/{groupName}/userlist": {
"get": {
"tags": [
"permission"
],
"summary": "List all user in a group",
"description": "List all user in a group",
"operationId": "groupUserList",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "groupName",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/user/add": {
"post": {
"tags": [
"permission"
],
"summary": "Add user",
"description": "Add user",
"operationId": "addUser",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "user",
"required": false,
"schema": {
"$ref": "#/definitions/User"
}
}
],
"responses": {
"200": {
"description": "User saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/user/delete": {
"delete": {
"tags": [
"permission"
],
"summary": "Delete multiple user",
"description": "Delete multiple user",
"operationId": "deleteMultipleUsers",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "permissionList",
"required": false,
"schema": {
"$ref": "#/definitions/RestPermissionUserListModelString"
}
}
],
"responses": {
"200": {
"description": "Users deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/user/delete/{name}": {
"delete": {
"tags": [
"permission"
],
"summary": "Delete user",
"description": "Delete user",
"operationId": "deleteUser",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "name",
"in": "path",
"description": "Username",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "User deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/user/get": {
"get": {
"tags": [
"permission"
],
"summary": "Get user",
"description": "Get user information",
"operationId": "findUser",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "username",
"in": "query",
"description": "Username",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "User found"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/user/list": {
"get": {
"tags": [
"permission"
],
"summary": "List all user",
"description": "List all user",
"operationId": "userList",
"produces": [
"application/xml",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/user/token/generate": {
"put": {
"tags": [
"permission"
],
"summary": "Generate token",
"description": "Generate token",
"operationId": "quickRenewToken",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "username",
"in": "query",
"description": "Username",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Token generated"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/permission/user/update": {
"put": {
"tags": [
"permission"
],
"summary": "Update user",
"description": "Update user",
"operationId": "updateUser",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "user",
"required": false,
"schema": {
"$ref": "#/definitions/User"
}
}
],
"responses": {
"200": {
"description": "User saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/property/add": {
"post": {
"tags": [
"property"
],
"summary": "Add property",
"description": "Add property",
"operationId": "addProperty",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "key",
"in": "query",
"description": "Property key",
"required": true,
"type": "string"
},
{
"name": "value",
"in": "query",
"description": "Property value",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Property saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/property/delete": {
"delete": {
"tags": [
"property"
],
"summary": "Delete property",
"description": "Delete property",
"operationId": "deleteProperty",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "key",
"in": "query",
"description": "Property key",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Property deleted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/property/get": {
"get": {
"tags": [
"property"
],
"summary": "Get property",
"description": "Get property information",
"operationId": "getProperty",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "key",
"in": "query",
"description": "Property key",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Property found"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/property/list": {
"get": {
"tags": [
"property"
],
"summary": "List all property",
"description": "List all property",
"operationId": "listProperty",
"produces": [
"application/xml",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/property/reload": {
"post": {
"tags": [
"property"
],
"operationId": "reloadProperty",
"produces": [
"application/xml",
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/RestApiResponse"
},
"headers": {}
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/property/update": {
"put": {
"tags": [
"property"
],
"summary": "Update property",
"description": "Update property",
"operationId": "updateProperty",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "key",
"in": "query",
"description": "Property key",
"required": true,
"type": "string"
},
{
"name": "value",
"in": "query",
"description": "Property value",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Property saved"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/utility/esb/restart": {
"get": {
"tags": [
"utility"
],
"summary": "Restart TORO Integrate",
"description": "Restart TORO Integrate Application",
"operationId": "restartESB",
"parameters": [],
"responses": {
"200": {
"description": "TORO Integrate restarted"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/utility/esb/shutdown": {
"get": {
"tags": [
"utility"
],
"summary": "Shutdown TORO Integrate",
"description": "Shutdown TORO Integrate Application",
"operationId": "stopESB",
"parameters": [],
"responses": {
"200": {
"description": "TORO Integrate shutdown"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/utility/log/download": {
"get": {
"tags": [
"utility"
],
"summary": "Download ESB log file",
"description": "Download TORO Integrate log file",
"operationId": "getLogZip",
"parameters": [],
"responses": {
"200": {
"description": "TORO Integrate log file downloaded"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
},
"/esbapi/v1/manage/utility/log/view": {
"get": {
"tags": [
"utility"
],
"summary": "View TORO Integrate log file",
"description": "View TORO Integrate log file",
"operationId": "viewLog",
"parameters": [],
"responses": {
"200": {
"description": "TORO Integrate log file found"
}
},
"security": [
{
"api_key": []
},
{
"ESBAPIAdminGroup": []
}
]
}
}
},
"securityDefinitions": {
"ESBAPIAdminGroup": {
"type": "apiKey",
"name": "api_key",
"in": "header"
},
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
},
"definitions": {
"User": {
"type": "object",
"required": [
"displayName",
"emailAddress",
"password",
"username"
],
"properties": {
"username": {
"type": "string",
"description": "Username",
"minLength": 4,
"maxLength": 20
},
"password": {
"type": "string",
"description": "Password",
"minLength": 5,
"maxLength": 2147483647
},
"displayName": {
"type": "string",
"description": "Display name",
"minLength": 1,
"maxLength": 20
},
"emailAddress": {
"type": "string",
"description": "Email address",
"minLength": 1,
"maxLength": 50
},
"enabled": {
"type": "boolean",
"description": "Enabled",
"default": false
},
"id": {
"type": "string"
}
},
"xml": {
"name": "user"
}
},
"jdbc-connection-info": {
"type": "object",
"required": [
"acquireIncrement",
"driverClass",
"idleConnectionTestPeriodInMinutes",
"idleMaxAgeInMinutes",
"maxConnectionsPerPartition",
"minConnectionsPerPartition",
"name",
"partitionCount",
"password",
"statementsCacheSize",
"url",
"userName"
],
"properties": {
"name": {
"type": "string",
"description": "Database name",
"minLength": 1,
"maxLength": 30
},
"enabled": {
"type": "boolean",
"description": "Enabled",
"default": false
},
"driverClass": {
"type": "string",
"description": "Driver class",
"minLength": 1,
"maxLength": 2147483647
},
"url": {
"type": "string",
"description": "Driver Url",
"minLength": 1,
"maxLength": 255
},
"userName": {
"type": "string",
"description": "username",
"minLength": 1,
"maxLength": 20
},
"password": {
"type": "string",
"description": "password"
},
"idleConnectionTestPeriodInMinutes": {
"type": "integer",
"format": "int32",
"description": "idle-connection-period",
"minimum": 1,
"maximum": 100
},
"idleMaxAgeInMinutes": {
"type": "integer",
"format": "int32",
"description": "idle-max-age",
"minimum": 1,
"maximum": 30
},
"maxConnectionsPerPartition": {
"type": "integer",
"format": "int32",
"description": "max-partition-connections",
"minimum": 1,
"maximum": 10
},
"minConnectionsPerPartition": {
"type": "integer",
"format": "int32",
"description": "min-partition-connections",
"minimum": 1,
"maximum": 100
},
"partitionCount": {
"type": "integer",
"format": "int32",
"description": "partition-count",
"minimum": 1,
"maximum": 5
},
"acquireIncrement": {
"type": "integer",
"format": "int32",
"description": "acquire-increment",
"minimum": 1,
"maximum": 5
},
"statementsCacheSize": {
"type": "integer",
"format": "int32",
"description": "statement-cache-size",
"minimum": 1,
"maximum": 1000
},
"home": {
"type": "string"
}
}
},
"MultipartFile": {
"type": "object",
"properties": {
"contentType": {
"type": "string"
},
"originalFilename": {
"type": "string"
},
"name": {
"type": "string"
},
"empty": {
"type": "boolean",
"default": false
},
"bytes": {
"type": "array",
"items": {
"type": "string",
"format": "byte"
}
},
"size": {
"type": "integer",
"format": "int64"
},
"inputStream": {
"$ref": "#/definitions/InputStream"
}
}
},
"RestEndpointEntryModel": {
"type": "object",
"required": [
"endpoints",
"packageName"
],
"properties": {
"packageName": {
"type": "string",
"minLength": 1,
"maxLength": 2147483647
},
"endpoints": {
"type": "array",
"xml": {
"name": "endpoint",
"wrapped": true
},
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"xml": {
"name": "EndpointEntry"
}
},
"ServiceInvoke": {
"type": "object",
"required": [
"apiGroup",
"endpointType",
"id",
"packageName",
"ruleId",
"serviceName",
"success",
"timeReceived",
"trackerId",
"url",
"user"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Record ID"
},
"ruleId": {
"type": "integer",
"format": "int64",
"description": "Matching Rule ID"
},
"timeReceived": {
"type": "string",
"format": "date-time",
"description": "Time Received (Service Invoke Time)"
},
"trackerId": {
"type": "string",
"description": "Tracker Document ID"
},
"packageName": {
"type": "string",
"description": "ESB Package Name"
},
"endpointType": {
"type": "string",
"description": "Endpoint type"
},
"apiGroup": {
"type": "string",
"description": "API Group"
},
"serviceName": {
"type": "string",
"description": "Service Name"
},
"url": {
"type": "string",
"description": "URL"
},
"user": {
"type": "string",
"description": "User Name"
},
"success": {
"type": "boolean",
"description": "Success",
"default": false
},
"doubleProperties": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "double"
}
}
}
},
"EndpointModel": {
"type": "object",
"required": [
"endpointName",
"endpointType",
"packageName"
],
"properties": {
"packageName": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"endpointName": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"originalEndpointName": {
"type": "string",
"minLength": 0,
"maxLength": 50
},
"endpointType": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"file": {
"$ref": "#/definitions/MultipartFile"
},
"serviceName": {
"type": "string"
},
"start": {
"type": "boolean",
"default": false
},
"updating": {
"type": "boolean",
"default": false
}
}
},
"RestApiResponse": {
"type": "object",
"required": [
"statusCode"
],
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"content": {
"type": "object",
"description": "Response object"
},
"error": {
"type": "object",
"description": "Error object"
}
}
},
"RestDatabaseListModelString": {
"type": "object",
"properties": {
"list": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"empty": {
"type": "boolean",
"default": false
}
},
"xml": {
"name": "databaseList"
}
},
"InputStream": {
"type": "object"
},
"MonitorBill": {
"type": "object",
"required": [
"cost",
"endDate",
"serviceInvokes",
"start",
"startDate",
"totalServiceInvokes"
],
"properties": {
"startDate": {
"type": "string",
"format": "date-time",
"description": "Start Date"
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "End Date"
},
"serviceInvokes": {
"type": "array",
"description": "Service Invokes",
"items": {
"$ref": "#/definitions/ServiceInvoke"
}
},
"cost": {
"type": "number",
"format": "double",
"description": "Total Cost"
},
"totalServiceInvokes": {
"type": "integer",
"format": "int64",
"description": "Total number of service invokes for given time period"
},
"start": {
"type": "integer",
"format": "int32",
"description": "The offset"
}
}
},
"Employee": {
"type": "object",
"required": [
"department",
"name",
"position"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Employee ID"
},
"name": {
"type": "string",
"example": "Daren Klamer",
"description": "Employee name",
"minLength": 1,
"maxLength": 50
},
"position": {
"type": "string",
"description": "Employee position",
"minLength": 1,
"maxLength": 50
},
"department": {
"type": "string",
"description": "Employee department",
"minLength": 1,
"maxLength": 50
}
}
},
"JMSDestination": {
"type": "object",
"required": [
"destinationName",
"messageBean",
"type"
],
"properties": {
"type": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"destinationName": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"messageBean": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"transacted": {
"type": "boolean",
"default": false
},
"empty": {
"type": "boolean",
"default": false
}
}
},
"Endpoint List": {
"type": "object",
"required": [
"endpointEntries"
],
"properties": {
"endpointEntries": {
"type": "array",
"description": "Endpoint entries",
"items": {
"$ref": "#/definitions/RestEndpointEntryModel"
}
}
},
"xml": {
"name": "Endpoints"
}
},
"RestPermissionGroupListModelString": {
"type": "object",
"properties": {
"list": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"empty": {
"type": "boolean",
"default": false
}
},
"xml": {
"name": "permission"
}
},
"RestPermissionUserListModelString": {
"type": "object",
"properties": {
"list": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"empty": {
"type": "boolean",
"default": false
}
},
"xml": {
"name": "permission"
}
},
"ESBPackage Configure Model": {
"type": "object",
"required": [
"packageName",
"version"
],
"properties": {
"packageName": {
"type": "string",
"xml": {
"name": "package-name"
},
"description": "Package Name",
"minLength": 1,
"maxLength": 50
},
"version": {
"type": "string",
"description": "Package Version",
"minLength": 1,
"maxLength": 255
},
"packageDependencies": {
"type": "array",
"xml": {
"name": "dependency",
"wrapped": true
},
"description": "Package Dependencies",
"items": {
"type": "string"
}
},
"startupServices": {
"type": "array",
"xml": {
"name": "startup-service",
"wrapped": true
},
"description": "Package Startup services",
"items": {
"type": "string"
}
},
"shutdownServices": {
"type": "array",
"xml": {
"name": "shutdown-service",
"wrapped": true
},
"description": "Package shutdown services",
"items": {
"type": "string"
}
},
"jmsDestinations": {
"type": "array",
"xml": {
"name": "jms-destination",
"wrapped": true
},
"description": "Package JMS Destination",
"items": {
"$ref": "#/definitions/JMSDestination"
}
},
"enabled": {
"type": "boolean",
"description": "Package status",
"default": false
}
},
"xml": {
"name": "ConfigureModel"
}
},
"APIResponse": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"message": {
"type": "object"
}
}
},
"ESBPackage Model": {
"type": "object",
"required": [
"marketplaceId",
"name",
"startOnCreate",
"version"
],
"properties": {
"name": {
"type": "string",
"description": "Package Name",
"minLength": 1,
"maxLength": 50
},
"marketplaceId": {
"type": "string",
"description": "Marketplace ID",
"minLength": 1,
"maxLength": 255
},
"version": {
"type": "string",
"description": "Package Version",
"minLength": 1,
"maxLength": 255
},
"startOnCreate": {
"type": "boolean",
"description": "Start package on create",
"default": false
}
},
"xml": {
"name": "ESBPackage"
}
},
"ESBPackage ListString": {
"type": "object",
"properties": {
"list": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"empty": {
"type": "boolean",
"default": false
}
},
"xml": {
"name": "esbPackageList"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment