Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Swagger integration
{
    "openapi": "3.0.1",
    "info": {
        "title": "Tsplice API",
        "version": "v1"
    },
    "paths": {
        "/api/DataDict": {
            "get": {
                "tags": [
                    "DataDict"
                ],
                "summary": "Get a list of data dictionary definitions",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/DataDict/{name}": {
            "get": {
                "tags": [
                    "DataDict"
                ],
                "summary": "Get a specific data dictionary",
                "parameters": [
                    {
                        "name": "name",
                        "in": "path",
                        "description": "Data dictionary name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/DataDict/{name}/{file}": {
            "get": {
                "tags": [
                    "DataDict"
                ],
                "summary": "Get a specific data dictionary file",
                "parameters": [
                    {
                        "name": "name",
                        "in": "path",
                        "description": "Data dictionary name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "file",
                        "in": "path",
                        "description": "File name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/DataSet": {
            "get": {
                "tags": [
                    "DataSet"
                ],
                "summary": "Gets a list of all available DataSets",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/DataSet/{path}": {
            "get": {
                "tags": [
                    "DataSet"
                ],
                "summary": "Gets a DataSet",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "put": {
                "tags": [
                    "DataSet"
                ],
                "summary": "Uploads a DataSet",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested host path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "ContentType": {
                                        "type": "string"
                                    },
                                    "ContentDisposition": {
                                        "type": "string"
                                    },
                                    "Headers": {
                                        "type": "object",
                                        "additionalProperties": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        }
                                    },
                                    "Length": {
                                        "type": "integer",
                                        "format": "int64"
                                    },
                                    "Name": {
                                        "type": "string"
                                    },
                                    "FileName": {
                                        "type": "string"
                                    },
                                    "lastModified": {
                                        "type": "string",
                                        "format": "date-time"
                                    }
                                }
                            },
                            "encoding": {
                                "ContentType": {
                                    "style": "form"
                                },
                                "ContentDisposition": {
                                    "style": "form"
                                },
                                "Headers": {
                                    "style": "form"
                                },
                                "Length": {
                                    "style": "form"
                                },
                                "Name": {
                                    "style": "form"
                                },
                                "FileName": {
                                    "style": "form"
                                },
                                "lastModified": {
                                    "style": "form"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "delete": {
                "tags": [
                    "DataSet"
                ],
                "summary": "Deletes a DataSet",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested host path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/HmiConfig": {
            "get": {
                "tags": [
                    "HmiConfig"
                ],
                "summary": "Gets a list of HMI applications",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/HmiConfig/{appName}": {
            "get": {
                "tags": [
                    "HmiConfig"
                ],
                "summary": "Gets an HMI application's configuration file",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "HMI configuration name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/HmiConfig/{appName}/Files": {
            "get": {
                "tags": [
                    "HmiConfig"
                ],
                "summary": "Gets the list of files associated with an HMI application",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "HMI configuration name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/HmiConfig/{appName}/Files/{path}": {
            "get": {
                "tags": [
                    "HmiConfig"
                ],
                "summary": "Retrieves a specific file associated with an HMI application",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "HMI configuration name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Path to requested file",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/LogMsg": {
            "get": {
                "tags": [
                    "LogMsg"
                ],
                "summary": "Gets a list of LogMsg queues",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "post": {
                "tags": [
                    "LogMsg"
                ],
                "summary": "Posts a new LogMsg to one or more queues",
                "requestBody": {
                    "description": "LogMsg structure",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/LogMsg"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/LogMsg"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/LogMsg"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/LogMsg/{queue}/Files": {
            "get": {
                "tags": [
                    "LogMsg"
                ],
                "summary": "Gets the list of files available for a LogMsg queue",
                "parameters": [
                    {
                        "name": "queue",
                        "in": "path",
                        "description": "LogMsg queue name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/LogMsg/{queue}/Files/{filename}": {
            "get": {
                "tags": [
                    "LogMsg"
                ],
                "summary": "Gets a file from a LogMsg queue",
                "parameters": [
                    {
                        "name": "queue",
                        "in": "path",
                        "description": "LogMsg queue name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "filename",
                        "in": "path",
                        "description": "File name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Probe/{name}": {
            "get": {
                "tags": [
                    "Probe"
                ],
                "summary": "Gets a probe variable value",
                "parameters": [
                    {
                        "name": "name",
                        "in": "path",
                        "description": "Variable name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "put": {
                "tags": [
                    "Probe"
                ],
                "summary": "Writes a new value to a variable",
                "parameters": [
                    {
                        "name": "name",
                        "in": "path",
                        "description": "Variable name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Variable value",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ProbeVariable"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ProbeVariable"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/ProbeVariable"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Probe": {
            "post": {
                "tags": [
                    "Probe"
                ],
                "summary": "Handles a block of probe variable requests (read or write)",
                "requestBody": {
                    "description": "List of requests",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "array",
                                "items": {
                                    "$ref": "#/components/schemas/ProbeVariable"
                                }
                            }
                        },
                        "text/json": {
                            "schema": {
                                "type": "array",
                                "items": {
                                    "$ref": "#/components/schemas/ProbeVariable"
                                }
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "type": "array",
                                "items": {
                                    "$ref": "#/components/schemas/ProbeVariable"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Process/{appName}/Activate": {
            "post": {
                "tags": [
                    "Process"
                ],
                "summary": "Processes a request to activate a task",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "Application name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Process/{appName}/Deactivate": {
            "post": {
                "tags": [
                    "Process"
                ],
                "summary": "Processes a request to deactivate a task",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "Application name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Process/{appName}/Suspend": {
            "post": {
                "tags": [
                    "Process"
                ],
                "summary": "Processes a request to suspend a task",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "Application name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Process/{appName}/Resume": {
            "post": {
                "tags": [
                    "Process"
                ],
                "summary": "Processes a request to resume a task",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "Application name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Process/{appName}/ClearError": {
            "post": {
                "tags": [
                    "Process"
                ],
                "summary": "Processes a request to clear a task's error",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "Application name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Process/{appName}/Options": {
            "post": {
                "tags": [
                    "Process"
                ],
                "summary": "Processes a request to edit a process's options",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "Application name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "save",
                        "in": "query",
                        "description": "True to save process options",
                        "style": "form",
                        "schema": {
                            "type": "boolean",
                            "default": false
                        }
                    }
                ],
                "requestBody": {
                    "description": "Options string",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ProcessOptions"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ProcessOptions"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/ProcessOptions"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/ProcessGroup/{groupName}/Activate": {
            "post": {
                "tags": [
                    "ProcessGroup"
                ],
                "summary": "Process a request to activate an application group",
                "parameters": [
                    {
                        "name": "groupName",
                        "in": "path",
                        "description": "Application group name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/ProcessGroup/{groupName}/Deactivate": {
            "post": {
                "tags": [
                    "ProcessGroup"
                ],
                "summary": "Process a request to deactivate an application group",
                "parameters": [
                    {
                        "name": "groupName",
                        "in": "path",
                        "description": "Application group name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Share/{path}": {
            "get": {
                "tags": [
                    "Share"
                ],
                "summary": "Gets a file from a shared folder or get a listing of files\r\nwithin a shared folder",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "put": {
                "tags": [
                    "Share"
                ],
                "summary": "Uploads a file to the Tsplice host",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "ContentType": {
                                        "type": "string"
                                    },
                                    "ContentDisposition": {
                                        "type": "string"
                                    },
                                    "Headers": {
                                        "type": "object",
                                        "additionalProperties": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        }
                                    },
                                    "Length": {
                                        "type": "integer",
                                        "format": "int64"
                                    },
                                    "Name": {
                                        "type": "string"
                                    },
                                    "FileName": {
                                        "type": "string"
                                    },
                                    "lastModified": {
                                        "type": "string",
                                        "format": "date-time"
                                    }
                                }
                            },
                            "encoding": {
                                "ContentType": {
                                    "style": "form"
                                },
                                "ContentDisposition": {
                                    "style": "form"
                                },
                                "Headers": {
                                    "style": "form"
                                },
                                "Length": {
                                    "style": "form"
                                },
                                "Name": {
                                    "style": "form"
                                },
                                "FileName": {
                                    "style": "form"
                                },
                                "lastModified": {
                                    "style": "form"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "delete": {
                "tags": [
                    "Share"
                ],
                "summary": "Deletes a file from the Tsplice host",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Share/Copy": {
            "post": {
                "tags": [
                    "Share"
                ],
                "summary": "Copies a file on the Tsplice host",
                "requestBody": {
                    "description": "Request data",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/FileCopyRequest"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/FileCopyRequest"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/FileCopyRequest"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Share/Move": {
            "post": {
                "tags": [
                    "Share"
                ],
                "summary": "Moves/renames a file on the Tsplice host",
                "requestBody": {
                    "description": "Request data",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/FileCopyRequest"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/FileCopyRequest"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/FileCopyRequest"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/System/Status": {
            "get": {
                "tags": [
                    "System"
                ],
                "summary": "Get the system status",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/System/Start": {
            "post": {
                "tags": [
                    "System"
                ],
                "summary": "Start the Tsentry system",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/System/Shutdown": {
            "post": {
                "tags": [
                    "System"
                ],
                "summary": "Shutdown the Tsentry system",
                "requestBody": {
                    "description": "Requested shutdown options",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ShutdownRequest"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ShutdownRequest"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/ShutdownRequest"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/System/Shutdown/Options": {
            "get": {
                "tags": [
                    "System"
                ],
                "summary": "Get the Tsentry shutdown options",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/TrendSource": {
            "get": {
                "tags": [
                    "TrendSource"
                ],
                "summary": "Get a list of available trend sources",
                "parameters": [
                    {
                        "name": "type",
                        "in": "query",
                        "description": "Type to filter",
                        "style": "form",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/TrendSource/{name}": {
            "get": {
                "tags": [
                    "TrendSource"
                ],
                "summary": "Get detailed information about a trend source",
                "parameters": [
                    {
                        "name": "name",
                        "in": "path",
                        "description": "Requested file name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Trigger/Status": {
            "get": {
                "tags": [
                    "Trigger"
                ],
                "summary": "Gets the historical trend system status",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Trigger/Def": {
            "get": {
                "tags": [
                    "TriggerDef"
                ],
                "summary": "Gets a list of all available trigger definitions",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Trigger/Def/{path}": {
            "get": {
                "tags": [
                    "TriggerDef"
                ],
                "summary": "Gets a trigger definition",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "put": {
                "tags": [
                    "TriggerDef"
                ],
                "summary": "Uploads a trigger definition",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested host path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "ContentType": {
                                        "type": "string"
                                    },
                                    "ContentDisposition": {
                                        "type": "string"
                                    },
                                    "Headers": {
                                        "type": "object",
                                        "additionalProperties": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        }
                                    },
                                    "Length": {
                                        "type": "integer",
                                        "format": "int64"
                                    },
                                    "Name": {
                                        "type": "string"
                                    },
                                    "FileName": {
                                        "type": "string"
                                    },
                                    "lastModified": {
                                        "type": "string",
                                        "format": "date-time"
                                    }
                                }
                            },
                            "encoding": {
                                "ContentType": {
                                    "style": "form"
                                },
                                "ContentDisposition": {
                                    "style": "form"
                                },
                                "Headers": {
                                    "style": "form"
                                },
                                "Length": {
                                    "style": "form"
                                },
                                "Name": {
                                    "style": "form"
                                },
                                "FileName": {
                                    "style": "form"
                                },
                                "lastModified": {
                                    "style": "form"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "delete": {
                "tags": [
                    "TriggerDef"
                ],
                "summary": "Deletes a trigger definition",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested host path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Trigger/Def/{triggerName}/Activate": {
            "post": {
                "tags": [
                    "TriggerDef"
                ],
                "summary": "Processes a request to activate a trigger",
                "parameters": [
                    {
                        "name": "triggerName",
                        "in": "path",
                        "description": "Trigger name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Trigger/Def/{triggerName}/Deactivate": {
            "post": {
                "tags": [
                    "TriggerDef"
                ],
                "summary": "Processes a request to deactivate a trigger",
                "parameters": [
                    {
                        "name": "triggerName",
                        "in": "path",
                        "description": "Trigger name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Trigger/Trend": {
            "get": {
                "tags": [
                    "TriggerTrend"
                ],
                "summary": "Gets a list of all available historical trend files",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Trigger/Trend/{path}": {
            "get": {
                "tags": [
                    "TriggerTrend"
                ],
                "summary": "Gets a historical trend file",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            },
            "delete": {
                "tags": [
                    "TriggerTrend"
                ],
                "summary": "Deletes a historical trend file",
                "parameters": [
                    {
                        "name": "path",
                        "in": "path",
                        "description": "Requested host path",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Tsecurity/Authenticate": {
            "post": {
                "tags": [
                    "Tsecurity"
                ],
                "summary": "Authenticates a user.",
                "description": "If credentials are not supplied then the caller is challenged\r\nfor negotiated authentication",
                "requestBody": {
                    "description": "Optional user credentials",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Credentials"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Credentials"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/Credentials"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Tsecurity/{appName}/Authorize": {
            "post": {
                "tags": [
                    "Tsecurity"
                ],
                "summary": "Authenticates and authorizes a user",
                "description": "If credentials are not supplied then the caller is challenged\r\nfor negotiated authentication",
                "parameters": [
                    {
                        "name": "appName",
                        "in": "path",
                        "description": "Tsecurity application name",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Optional user credentials",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Credentials"
                            }
                        },
                        "text/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Credentials"
                            }
                        },
                        "application/*+json": {
                            "schema": {
                                "$ref": "#/components/schemas/Credentials"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        },
        "/api/Tsecurity/Domains": {
            "get": {
                "tags": [
                    "Tsecurity"
                ],
                "summary": "Gets a list of domains for the host.",
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "Credentials": {
                "type": "object",
                "properties": {
                    "Username": {
                        "type": "string",
                        "nullable": true
                    },
                    "Password": {
                        "type": "string",
                        "nullable": true
                    },
                    "Domain": {
                        "type": "string",
                        "nullable": true
                    }
                },
                "additionalProperties": false
            },
            "DebugLevel": {
                "enum": [
                    "DBOFF",
                    "DBSS",
                    "DBDEBUG",
                    "DBFERR",
                    "DBERR",
                    "DBLOG",
                    "DBSEQ",
                    "DBDATA",
                    "DBDETAIL"
                ],
                "type": "string"
            },
            "FileCopyRequest": {
                "type": "object",
                "properties": {
                    "SourcePath": {
                        "type": "string",
                        "nullable": true
                    },
                    "DestinationPath": {
                        "type": "string",
                        "nullable": true
                    }
                },
                "additionalProperties": false
            },
            "LogMsg": {
                "type": "object",
                "properties": {
                    "Function": {
                        "type": "string",
                        "nullable": true
                    },
                    "Queue": {
                        "type": "string",
                        "nullable": true
                    },
                    "DebugLevel": {
                        "$ref": "#/components/schemas/DebugLevel"
                    },
                    "Message": {
                        "type": "string",
                        "nullable": true
                    }
                },
                "additionalProperties": false
            },
            "ProbeVariable": {
                "type": "object",
                "properties": {
                    "Name": {
                        "type": "string",
                        "nullable": true
                    },
                    "Type": {
                        "type": "string",
                        "nullable": true
                    },
                    "Value": {
                        "nullable": true
                    },
                    "Source": {
                        "type": "string",
                        "nullable": true
                    },
                    "WriteDescription": {
                        "type": "string",
                        "nullable": true
                    },
                    "ErrorMessage": {
                        "type": "string",
                        "nullable": true
                    }
                },
                "additionalProperties": false
            },
            "ProcessOptions": {
                "type": "object",
                "properties": {
                    "Name": {
                        "type": "string",
                        "nullable": true
                    },
                    "BinPath": {
                        "type": "string",
                        "nullable": true
                    },
                    "UsesNtRt": {
                        "type": "boolean"
                    },
                    "Priority": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "TimerDelay": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "RepRate": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "RunMode": {
                        "$ref": "#/components/schemas/ProcessRunMode"
                    },
                    "AutoRestart": {
                        "type": "boolean"
                    },
                    "MemLock": {
                        "type": "boolean"
                    },
                    "TrapCrash": {
                        "$ref": "#/components/schemas/ProcessTrapCrash"
                    },
                    "DebugLevel": {
                        "$ref": "#/components/schemas/DebugLevel"
                    },
                    "StartupDelay": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "InitWait": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "KillWait": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "PulseTimeout": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "CommandTail": {
                        "type": "string",
                        "nullable": true
                    }
                },
                "additionalProperties": false
            },
            "ProcessRunMode": {
                "enum": [
                    "Standard",
                    "Realtime"
                ],
                "type": "string"
            },
            "ProcessTrapCrash": {
                "enum": [
                    "None",
                    "Terminate",
                    "LogDescription",
                    "SymbolSource",
                    "WalkStack",
                    "Registers",
                    "All"
                ],
                "type": "string"
            },
            "ShutdownRequest": {
                "type": "object",
                "properties": {
                    "Restart": {
                        "type": "boolean"
                    },
                    "SaveVariables": {
                        "type": "boolean"
                    },
                    "ShutdownPC": {
                        "type": "boolean"
                    },
                    "RestartPC": {
                        "type": "boolean"
                    },
                    "AppOptions": {
                        "type": "object",
                        "additionalProperties": {
                            "type": "string",
                            "nullable": true
                        },
                        "nullable": true
                    }
                },
                "additionalProperties": false
            }
        }
    }
}

Macro Pack:

Swc macro
attachmentswagger.json

View file
nameswagger.json