{ "openapi": "3.0.1", "info": { "title": "NextGen Connect Client API", "description": "Swagger documentation for the NextGen Connect Client API.", "version": "4.5.0" }, "servers": [ { "url": "/api" } ], "paths": { "/connectors/doc/_testWrite": { "post": { "tags": [ "Connector Services" ], "summary": "Tests whether a file can be written to the specified directory.", "operationId": "testWrite", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The directory to test writing to.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "/some_folder" } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_file": { "description": "connection_test_response_file", "$ref": "../apiexamples/connection_test_response_file_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_file": { "description": "connection_test_response_file", "$ref": "../apiexamples/connection_test_response_file_json" } } } }, "description": "Default response for the operation 'testWrite'." } } } }, "/connectors/fhir/_getCapabilityStatement": { "post": { "tags": [ "Connector Services" ], "summary": "Retrieves the Capability Statement from the target URL.", "operationId": "getCapabilityStatement", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The FHIR Sender properties to use.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/FhirDispatcherProperties" }, "examples": { "fhirDispatcherPropertiesXmlCapabilities": { "description": "fhirDispatcherPropertiesXmlCapabilities", "$ref": "../apiexamples/ext_fhir_dispatcher_properties_xml_capabilities_xml" }, "fhirDispatcherPropertiesJsonCapabilities": { "description": "fhirDispatcherPropertiesJsonCapabilities", "$ref": "../apiexamples/ext_fhir_dispatcher_properties_json_capabilities_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/FhirDispatcherProperties" }, "examples": { "fhirDispatcherPropertiesXmlCapabilities": { "description": "fhirDispatcherPropertiesXmlCapabilities", "$ref": "../apiexamples/ext_fhir_dispatcher_properties_xml_capabilities_json" }, "fhirDispatcherPropertiesJsonCapabilities": { "description": "fhirDispatcherPropertiesJsonCapabilities", "$ref": "../apiexamples/ext_fhir_dispatcher_properties_json_capabilities_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/RequestCapabilityResponse" }, "examples": { "requestCapabilityResponseXmlCapabilities": { "description": "requestCapabilityResponseXmlCapabilities", "$ref": "../apiexamples/ext_request_capability_response_xml_capabilities_xml" }, "requestCapabilityResponseJsonCapabilities": { "description": "requestCapabilityResponseJsonCapabilities", "$ref": "../apiexamples/ext_request_capability_response_json_capabilities_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RequestCapabilityResponse" }, "examples": { "requestCapabilityResponseXmlCapabilities": { "description": "requestCapabilityResponseXmlCapabilities", "$ref": "../apiexamples/ext_request_capability_response_xml_capabilities_json" }, "requestCapabilityResponseJsonCapabilities": { "description": "requestCapabilityResponseJsonCapabilities", "$ref": "../apiexamples/ext_request_capability_response_json_capabilities_json" } } } }, "description": "Default response for the operation 'getCapabilityStatement'." } } } }, "/connectors/file/_testRead": { "post": { "tags": [ "Connector Services" ], "summary": "Tests whether a file can be read from the specified directory.", "operationId": "testRead", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The File Reader properties to use.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/FileReceiverProperties" }, "examples": { "file_receiver_properties": { "description": "file_receiver_properties", "$ref": "../apiexamples/file_receiver_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileReceiverProperties" }, "examples": { "file_receiver_properties": { "description": "file_receiver_properties", "$ref": "../apiexamples/file_receiver_properties_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_file": { "description": "connection_test_response_file", "$ref": "../apiexamples/connection_test_response_file_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_file": { "description": "connection_test_response_file", "$ref": "../apiexamples/connection_test_response_file_json" } } } }, "description": "Default response for the operation 'testRead'." } } } }, "/connectors/file/_testWrite": { "post": { "tags": [ "Connector Services" ], "summary": "Tests whether a file can be written to the specified directory.", "operationId": "testWrite_1", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The File Writer properties to use.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/FileDispatcherProperties" }, "examples": { "file_dispatcher_properties": { "description": "file_dispatcher_properties", "$ref": "../apiexamples/file_dispatcher_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileDispatcherProperties" }, "examples": { "file_dispatcher_properties": { "description": "file_dispatcher_properties", "$ref": "../apiexamples/file_dispatcher_properties_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_file": { "description": "connection_test_response_file", "$ref": "../apiexamples/connection_test_response_file_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_file": { "description": "connection_test_response_file", "$ref": "../apiexamples/connection_test_response_file_json" } } } }, "description": "Default response for the operation 'testWrite_1'." } } } }, "/connectors/http/_testConnection": { "post": { "tags": [ "Connector Services" ], "summary": "Tests whether a connection can be successfully established to the destination endpoint.", "operationId": "testConnection", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The HTTP Sender properties to use.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/HttpDispatcherProperties" }, "examples": { "http_dispatcher_properties": { "description": "http_dispatcher_properties", "$ref": "../apiexamples/http_dispatcher_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/HttpDispatcherProperties" }, "examples": { "http_dispatcher_properties": { "description": "http_dispatcher_properties", "$ref": "../apiexamples/http_dispatcher_properties_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_http": { "description": "connection_test_response_http", "$ref": "../apiexamples/connection_test_response_http_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_http": { "description": "connection_test_response_http", "$ref": "../apiexamples/connection_test_response_http_json" } } } }, "description": "Default response for the operation 'testConnection'." } } } }, "/connectors/jdbc/_getTables": { "post": { "tags": [ "Connector Services" ], "summary": "Executes a query to retrieve database table metadata.", "operationId": "getTables", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "driver", "in": "query", "description": "The JDBC driver class to use. (ex: org.postgresql.Driver)", "required": true, "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "The JDBC connection URL to use. (ex: jdbc:postgresql://localhost:5432/mirthdb)", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The username to authenticate with.", "schema": { "type": "string", "default": "" } }, { "name": "password", "in": "query", "description": "The password to authenticate with.", "schema": { "type": "string", "format": "password", "default": "" } }, { "name": "tableNamePattern", "in": "query", "description": "If specified, filters by table name. Wildcards (* or %) are allowed.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "selectLimit", "in": "query", "description": "A simple query to use to retrieve database metadata information.", "schema": { "type": "string", "default": "SELECT * FROM ? LIMIT 1" } }, { "name": "resourceId", "in": "query", "description": "Library resource IDs to use, if a custom driver is necessary.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Table" } }, "examples": { "table_set": { "description": "table_set", "$ref": "../apiexamples/table_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Table" } }, "examples": { "table_set": { "description": "table_set", "$ref": "../apiexamples/table_set_json" } } } }, "description": "Default response for the operation 'getTables'." } } } }, "/connectors/jms/templates/{templateName}": { "get": { "tags": [ "Connector Services" ], "summary": "Retrieves a single JMS connector settings template.", "operationId": "getTemplate", "parameters": [ { "name": "templateName", "in": "path", "description": "The name of the template.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/JmsConnectorProperties" }, "examples": { "jms_connector_properties": { "description": "jms_connector_properties", "$ref": "../apiexamples/jms_connector_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JmsConnectorProperties" }, "examples": { "jms_connector_properties": { "description": "jms_connector_properties", "$ref": "../apiexamples/jms_connector_properties_json" } } } }, "description": "Default response for the operation 'getTemplate'." } } }, "put": { "tags": [ "Connector Services" ], "summary": "Creates or updates a JMS connector settings template.", "operationId": "saveTemplate", "parameters": [ { "name": "templateName", "in": "path", "description": "The name of the template.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The JMS connector properties to save.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/JmsConnectorProperties" }, "examples": { "jms_connector_properties": { "description": "jms_connector_properties", "$ref": "../apiexamples/jms_connector_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/JmsConnectorProperties" }, "examples": { "jms_connector_properties": { "description": "jms_connector_properties", "$ref": "../apiexamples/jms_connector_properties_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "jms_template_name_set": { "description": "jms_template_name_set", "$ref": "../apiexamples/jms_template_name_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "jms_template_name_set": { "description": "jms_template_name_set", "$ref": "../apiexamples/jms_template_name_set_json" } } } }, "description": "Default response for the operation 'saveTemplate'." } } }, "delete": { "tags": [ "Connector Services" ], "summary": "Creates or updates a JMS connector settings template.", "operationId": "deleteTemplate", "parameters": [ { "name": "templateName", "in": "path", "description": "The name of the template.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "jms_template_name_set": { "description": "jms_template_name_set", "$ref": "../apiexamples/jms_template_name_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "jms_template_name_set": { "description": "jms_template_name_set", "$ref": "../apiexamples/jms_template_name_set_json" } } } }, "description": "Default response for the operation 'deleteTemplate'." } } } }, "/connectors/jms/templates": { "get": { "tags": [ "Connector Services" ], "summary": "Retrieves JMS connector settings templates.", "operationId": "getTemplates", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JmsConnectorProperties" } }, "examples": { "jms_connector_properties_map": { "description": "jms_connector_properties_map", "$ref": "../apiexamples/jms_connector_properties_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JmsConnectorProperties" } }, "examples": { "jms_connector_properties_map": { "description": "jms_connector_properties_map", "$ref": "../apiexamples/jms_connector_properties_map_json" } } } }, "description": "Default response for the operation 'getTemplates'." } } } }, "/connectors/smtp/_sendTestEmail": { "post": { "tags": [ "Connector Services" ], "summary": "Sends a test e-mail, replacing any connector properties first.", "operationId": "sendTestEmail", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The SMTP Sender properties to use.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SmtpDispatcherProperties" }, "examples": { "smtp_dispatcher_properties": { "description": "smtp_dispatcher_properties", "$ref": "../apiexamples/smtp_dispatcher_properties_xml" }, "smtp_dispatcher_properties_ssl": { "description": "smtp_dispatcher_properties_ssl", "$ref": "../apiexamples/smtp_dispatcher_properties_ssl_xml" }, "smtp_dispatcher_properties_tls": { "description": "smtp_dispatcher_properties_tls", "$ref": "../apiexamples/smtp_dispatcher_properties_tls_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmtpDispatcherProperties" }, "examples": { "smtp_dispatcher_properties": { "description": "smtp_dispatcher_properties", "$ref": "../apiexamples/smtp_dispatcher_properties_json" }, "smtp_dispatcher_properties_ssl": { "description": "smtp_dispatcher_properties_ssl", "$ref": "../apiexamples/smtp_dispatcher_properties_ssl_json" }, "smtp_dispatcher_properties_tls": { "description": "smtp_dispatcher_properties_tls", "$ref": "../apiexamples/smtp_dispatcher_properties_tls_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_smtp": { "description": "connection_test_response_smtp", "$ref": "../apiexamples/connection_test_response_smtp_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_smtp": { "description": "connection_test_response_smtp", "$ref": "../apiexamples/connection_test_response_smtp_json" } } } }, "description": "Default response for the operation 'sendTestEmail'." } } } }, "/connectors/tcp/_testConnection": { "post": { "tags": [ "Connector Services" ], "summary": "Tests whether a connection can be successfully established to the destination endpoint.", "operationId": "testConnection_1", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The TCP Sender properties to use.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/TcpDispatcherProperties" }, "examples": { "tcp_dispatcher_properties": { "description": "tcp_dispatcher_properties", "$ref": "../apiexamples/tcp_dispatcher_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/TcpDispatcherProperties" }, "examples": { "tcp_dispatcher_properties": { "description": "tcp_dispatcher_properties", "$ref": "../apiexamples/tcp_dispatcher_properties_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_tcp": { "description": "connection_test_response_tcp", "$ref": "../apiexamples/connection_test_response_tcp_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_tcp": { "description": "connection_test_response_tcp", "$ref": "../apiexamples/connection_test_response_tcp_json" } } } }, "description": "Default response for the operation 'testConnection_1'." } } } }, "/connectors/ws/_testConnection": { "post": { "tags": [ "Connector Services" ], "summary": "Tests whether a connection can be successfully established to the destination endpoint.", "operationId": "testConnection_2", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "schema": { "type": "string" } } ], "requestBody": { "description": "The Web Service Sender properties to use. These properties can be found in the exported channel's XML file. Copy the data from the opening tag <destinationConnectorProperties> to the closing tag </wsdlDefinitionMap> (including the tags). Paste over the information below between the opening and closing tags for <com.mirth.connect.connectors.ws.WebServiceDispatcherProperties>.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/WebServiceDispatcherProperties" }, "examples": { "ws_dispatcher_properties": { "description": "ws_dispatcher_properties", "$ref": "../apiexamples/ws_dispatcher_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebServiceDispatcherProperties" }, "examples": { "ws_dispatcher_properties": { "description": "ws_dispatcher_properties", "$ref": "../apiexamples/ws_dispatcher_properties_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_ws": { "description": "connection_test_response_ws", "$ref": "../apiexamples/connection_test_response_ws_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" }, "examples": { "connection_test_response_ws": { "description": "connection_test_response_ws", "$ref": "../apiexamples/connection_test_response_ws_json" } } } }, "description": "Default response for the operation 'testConnection_2'." } } } }, "/connectors/ws/_generateEnvelope": { "post": { "tags": [ "Connector Services" ], "summary": "Generate SOAP envelope for a given WSDL operation.", "operationId": "generateEnvelope", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId", "operation", "port", "service", "wsdlUrl" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "The ID of the channel." }, "channelName": { "type": "string", "description": "The name of the channel." }, "wsdlUrl": { "type": "string", "description": "The full URL to the WSDL describing the web service method to be called." }, "username": { "type": "string", "description": "Username used to authenticate to the web server." }, "password": { "type": "string", "description": "Password used to authenticate to the web server." }, "service": { "type": "string", "description": "The service name for the WSDL defined above." }, "port": { "type": "string", "description": "The port / endpoint name for the service defined above." }, "operation": { "type": "string", "description": "The name of the operation. This is a method provided by the web service" }, "buildOptional": { "type": "boolean", "description": "Whether to include optional fields in the envelope." } } } } } }, "responses": { "default": { "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "generate_envelope": { "description": "generate_envelope", "$ref": "../apiexamples/generate_envelope_txt" } } } }, "description": "Default response for the operation 'generateEnvelope'." } } } }, "/connectors/ws/_getSoapAction": { "post": { "tags": [ "Connector Services" ], "summary": "Retrieves the default SOAP Action (URI string) for a given WSDL operation.", "operationId": "getSoapAction", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId", "operation", "port", "service", "wsdlUrl" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "The ID of the channel." }, "channelName": { "type": "string", "description": "The name of the channel." }, "wsdlUrl": { "type": "string", "description": "The full URL to the WSDL describing the web service method to be called." }, "username": { "type": "string", "description": "Username used to authenticate to the web server." }, "password": { "type": "string", "description": "Password used to authenticate to the web server." }, "service": { "type": "string", "description": "The service name for the WSDL defined above." }, "port": { "type": "string", "description": "The port / endpoint name for the service defined above." }, "operation": { "type": "string", "description": "The name of the operation. This is a method provided by the web service." } } } } } }, "responses": { "default": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "SomeAction" } }, "description": "Default response for the operation 'getSoapAction'." } } } }, "/connectors/ws/_isWsdlCached": { "post": { "tags": [ "Connector Services" ], "summary": "Returns true if the definition tree for the WSDL is cached by the server.", "operationId": "isWsdlCached", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId", "wsdlUrl" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "The ID of the channel." }, "channelName": { "type": "string", "description": "The name of the channel." }, "wsdlUrl": { "type": "string", "description": "The full URL to the WSDL describing the web service method to be called." }, "username": { "type": "string", "description": "Username used to authenticate to the web server." }, "password": { "type": "string", "description": "Password used to authenticate to the web server." } } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "boolean" }, "examples": { "is_wsdl_cached": { "description": "is_wsdl_cached", "$ref": "../apiexamples/boolean_xml" } } }, "application/json": { "schema": { "type": "boolean" }, "examples": { "is_wsdl_cached": { "description": "is_wsdl_cached", "$ref": "../apiexamples/boolean_json" } } } }, "description": "Default response for the operation 'isWsdlCached'." } } } }, "/connectors/ws/_cacheWsdlFromUrl": { "post": { "tags": [ "Connector Services" ], "summary": "Downloads the WSDL at the specified URL and caches the web service definition tree.", "operationId": "cacheWsdlFromUrl", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "The name of the channel.", "schema": { "type": "string" } } ], "requestBody": { "description": "The Web Service Sender properties to use. These properties can be found in the exported channel's XML file. Copy the data from the opening tag <destinationConnectorProperties> to the closing tag </wsdlDefinitionMap> (including the tags). Paste over the information below between the opening and closing tags for <com.mirth.connect.connectors.ws.WebServiceDispatcherProperties>.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/WebServiceDispatcherProperties" }, "examples": { "ws_dispatcher_properties": { "description": "ws_dispatcher_properties", "$ref": "../apiexamples/ws_dispatcher_properties_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebServiceDispatcherProperties" }, "examples": { "ws_dispatcher_properties": { "description": "ws_dispatcher_properties", "$ref": "../apiexamples/ws_dispatcher_properties_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object" }, "examples": { "cache_wsdl_from_url": { "description": "cache_wsdl_from_url", "$ref": "../apiexamples/null_xml" } } }, "application/json": { "schema": { "type": "object" }, "examples": { "cache_wsdl_from_url": { "description": "cache_wsdl_from_url", "$ref": "../apiexamples/null_json" } } } }, "description": "Default response for the operation 'cacheWsdlFromUrl'." } } } }, "/connectors/ws/_getDefinition": { "post": { "tags": [ "Connector Services" ], "summary": "Retrieves the definition service map corresponding to the specified WSDL.", "operationId": "getDefinition", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId", "wsdlUrl" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "The ID of the channel." }, "channelName": { "type": "string", "description": "The name of the channel." }, "wsdlUrl": { "type": "string", "description": "The full URL to the WSDL describing the web service method to be called." }, "username": { "type": "string", "description": "Username used to authenticate to the web server." }, "password": { "type": "string", "description": "Password used to authenticate to the web server." } } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/DefinitionServiceMap" }, "examples": { "definition_service_map": { "description": "definition_service_map", "$ref": "../apiexamples/definition_service_map_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DefinitionServiceMap" }, "examples": { "definition_service_map": { "description": "definition_service_map", "$ref": "../apiexamples/definition_service_map_json" } } } }, "description": "Default response for the operation 'getDefinition'." } } } }, "/extensions/alert/_clearLogs": { "post": { "tags": [ "Extension Services" ], "summary": "Clears logs for selected alerts.", "operationId": "clearAlertLog", "requestBody": { "description": "The IDs of the alerts to clear logs for.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alertIds": { "description": "alertIds", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alertIds": { "description": "alertIds", "$ref": "../apiexamples/guid_set_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/alert/_clearTriggerCount": { "post": { "tags": [ "Extension Services" ], "summary": "Clears trigger count for selected alerts.", "operationId": "clearTriggerCount", "requestBody": { "description": "The IDs of the alerts to clear trigger counts for.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alertIds": { "description": "alertIds", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alertIds": { "description": "alertIds", "$ref": "../apiexamples/guid_set_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/alert/_getLogs": { "post": { "tags": [ "Extension Services" ], "summary": "Retrieves logs for all alerts.", "operationId": "getAlertLog", "requestBody": { "description": "The AlertLogRequest object containing alert IDs and last log IDs for the client.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AlertLogRequest" }, "examples": { "alertLogRequest": { "description": "alertLogRequest", "$ref": "../apiexamples/ext_alert_log_request_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertLogRequest" }, "examples": { "alertLogRequest": { "description": "alertLogRequest", "$ref": "../apiexamples/ext_alert_log_request_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AlertLogResponse" }, "examples": { "alertLogResponse": { "description": "alertLogResponse", "$ref": "../apiexamples/ext_alert_log_response_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertLogResponse" }, "examples": { "alertLogResponse": { "description": "alertLogResponse", "$ref": "../apiexamples/ext_alert_log_response_json" } } } }, "description": "Default response for the operation 'getAlertLog'." } } } }, "/extensions/alert/_returnToNormal": { "post": { "tags": [ "Extension Services" ], "summary": "Returns selected alerts to the normal escalation level.", "operationId": "returnToNormal", "requestBody": { "description": "The IDs of the alerts to return to normal level.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alertIds": { "description": "alertIds", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alertIds": { "description": "alertIds", "$ref": "../apiexamples/guid_set_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/appliance/_triggerClusterMembership": { "post": { "tags": [ "Extension Services" ], "summary": "Triggers the cluster membership script on the primary node.", "operationId": "clusterOnMembershipEvent", "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/permissions": { "get": { "tags": [ "Users" ], "summary": "Retrieves permissions for all audited client actions.", "operationId": "getPermissions", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Permission" } }, "examples": { "ext_auth_permission_map": { "description": "ext_auth_permission_map", "$ref": "../apiexamples/ext_auth_permission_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Permission" } }, "examples": { "ext_auth_permission_map": { "description": "ext_auth_permission_map", "$ref": "../apiexamples/ext_auth_permission_map_json" } } } }, "description": "Default response for the operation 'getPermissions'." } } } }, "/extensions/dashboardstatus/connectionLogs/{channelId}": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves connection logs for a specific channel.", "operationId": "getChannelLog", "parameters": [ { "name": "serverId", "in": "query", "description": "The server ID to retrieve logs for. Logs for all servers are retrieved is this parameter is not specified.", "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "description": "The channel ID to retrieve logs for.", "required": true, "schema": { "type": "string" } }, { "name": "fetchSize", "in": "query", "description": "Specifies the maximum number of log items to return.", "required": true, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "lastLogId", "in": "query", "description": "The last log ID the client retrieved. Only log items with a greater ID will be returned.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionLogItem" } }, "examples": { "connectionLogItemLinkedList": { "description": "connectionLogItemLinkedList", "$ref": "../apiexamples/connection_log_item_linked_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionLogItem" } }, "examples": { "connectionLogItemLinkedList": { "description": "connectionLogItemLinkedList", "$ref": "../apiexamples/connection_log_item_linked_list_json" } } } }, "description": "Default response for the operation 'getChannelLog'." } } } }, "/extensions/dashboardstatus/connectorStates": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all dashboard connector states.", "operationId": "getConnectorStateMap", "parameters": [ { "name": "serverId", "in": "query", "description": "The server ID to retrieve connector statuses for. Connector Statuses across all servers are retrieved is this parameter is not specified.", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "examples": { "dashboardConnectorStateMap": { "description": "dashboardConnectorStateMap", "$ref": "../apiexamples/dashboard_connector_state_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "examples": { "dashboardConnectorStateMap": { "description": "dashboardConnectorStateMap", "$ref": "../apiexamples/dashboard_connector_state_map_json" } } } }, "description": "Default response for the operation 'getConnectorStateMap'." } } } }, "/extensions/dashboardstatus/channelStates": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all dashboard channel states.", "operationId": "getChannelStates", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "dashboardChannelStateMap": { "description": "dashboardChannelStateMap", "$ref": "../apiexamples/dashboard_channel_state_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "dashboardChannelStateMap": { "description": "dashboardChannelStateMap", "$ref": "../apiexamples/dashboard_channel_state_map_json" } } } }, "description": "Default response for the operation 'getChannelStates'." } } } }, "/extensions/dashboardstatus/channelStates/{channelId}": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves a single dashboard channel state.", "operationId": "getChannelState", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to return a dashboard status for.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/extensions/dashboardstatus/connectionLogs": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves connection logs for all channels.", "operationId": "getAllChannelLogs", "parameters": [ { "name": "serverId", "in": "query", "description": "The server ID to retrieve logs for. Logs for all servers are retrieved is this parameter is not specified.", "schema": { "type": "string" } }, { "name": "fetchSize", "in": "query", "description": "Specifies the maximum number of log items to return.", "required": true, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "lastLogId", "in": "query", "description": "The last log ID the client retrieved. Only log items with a greater ID will be returned.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionLogItem" } }, "examples": { "connectionLogItemLinkedList": { "description": "connectionLogItemLinkedList", "$ref": "../apiexamples/connection_log_item_linked_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionLogItem" } }, "examples": { "connectionLogItemLinkedList": { "description": "connectionLogItemLinkedList", "$ref": "../apiexamples/connection_log_item_linked_list_json" } } } }, "description": "Default response for the operation 'getAllChannelLogs'." } } } }, "/extensions/datapruner/status": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves the current data pruner status.", "operationId": "getStatusMap", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "dataPrunerStatusMap": { "description": "dataPrunerStatusMap", "$ref": "../apiexamples/data_pruner_status_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "dataPrunerStatusMap": { "description": "dataPrunerStatusMap", "$ref": "../apiexamples/data_pruner_status_map_json" } } } }, "description": "Default response for the operation 'getStatusMap'." } } } }, "/extensions/datapruner/_start": { "post": { "tags": [ "Extension Services" ], "summary": "Starts the data pruner on-demand.", "operationId": "start", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "string", "format": "date-time" }, "examples": { "calendar": { "description": "calendar", "$ref": "../apiexamples/calendar_xml" } } }, "application/json": { "schema": { "type": "string", "format": "date-time" }, "examples": { "calendar": { "description": "calendar", "$ref": "../apiexamples/calendar_json" } } } }, "description": "Default response for the operation 'start'." } } } }, "/extensions/datapruner/_stop": { "post": { "tags": [ "Extension Services" ], "summary": "Stops the data pruner if currently running.", "operationId": "stop", "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/directoryresource/resources/{resourceId}/libraries": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all library URLs for the given directory resource.", "operationId": "getLibraries", "parameters": [ { "name": "resourceId", "in": "path", "description": "The ID of the directory resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "libraryList": { "description": "libraryList", "$ref": "../apiexamples/library_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "libraryList": { "description": "libraryList", "$ref": "../apiexamples/library_list_json" } } } }, "description": "Default response for the operation 'getLibraries'." } } } }, "/extensions/globalmapviewer/maps/all": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves global and/or global channel map information.", "operationId": "getAllMaps", "parameters": [ { "name": "channelId", "in": "query", "description": "The ID of the channel to retrieve global channel map information for.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "includeGlobalMap", "in": "query", "description": "If true, the global map will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "examples": { "globalMaps": { "description": "globalMaps", "$ref": "../apiexamples/global_maps_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "examples": { "globalMaps": { "description": "globalMaps", "$ref": "../apiexamples/global_maps_json" } } } }, "description": "Default response for the operation 'getAllMaps'." } } } }, "/extensions/globalmapviewer/maps/_getAllMaps": { "post": { "tags": [ "Extension Services" ], "summary": "Retrieves global and/or global channel map information. This is a POST request alternative to GET /maps/all that may be used when there are too many channel IDs to include in the query parameters.", "operationId": "getAllMapsPost", "parameters": [ { "name": "includeGlobalMap", "in": "query", "description": "If true, the global map will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The ID of the channel to retrieve global channel map information for.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "examples": { "globalMaps": { "description": "globalMaps", "$ref": "../apiexamples/global_maps_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "examples": { "globalMaps": { "description": "globalMaps", "$ref": "../apiexamples/global_maps_json" } } } }, "description": "Default response for the operation 'getAllMapsPost'." } } } }, "/extensions/globalmapviewer/maps/{channelId}": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves global channel map information for a single channel.", "operationId": "getGlobalChannelMap", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to retrieve global channel map information for.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "genericMapString": { "description": "genericMapString", "$ref": "../apiexamples/generic_map_xml" } } }, "text/plain": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "genericMapString": { "description": "genericMapString", "$ref": "../apiexamples/generic_map_xml" } } } }, "description": "Default response for the operation 'getGlobalChannelMap'." } } } }, "/extensions/globalmapviewer/maps/global": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves global map information.", "operationId": "getGlobalMap", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "globalMap": { "description": "globalMap", "$ref": "../apiexamples/generic_map_xml" } } }, "text/plain": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "genericMap": { "description": "genericMap", "$ref": "../apiexamples/generic_map_xml" } } } }, "description": "Default response for the operation 'getGlobalMap'." } } } }, "/extensions/history/channels/{channelId}/snapshots/{snapshotId}": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves a single channel snapshot by ID.", "operationId": "getChannelSnapshot", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "snapshotId", "in": "path", "description": "The ID of the snapshot.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "snapshot": { "description": "snapshot", "$ref": "../apiexamples/ext_channel_snapshot_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "snapshot": { "description": "snapshot", "$ref": "../apiexamples/ext_channel_snapshot_json" } } } }, "description": "Default response for the operation 'getChannelSnapshot'." } } } }, "/extensions/history/channels/{channelId}/snapshots": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all snapshots for a channel. The snapshots will only include metadata, not the actual channel XML.", "operationId": "getChannelSnapshots", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to retrieve snapshots for.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } }, "examples": { "snapshots": { "description": "snapshots", "$ref": "../apiexamples/ext_snapshot_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } }, "examples": { "snapshots": { "description": "snapshots", "$ref": "../apiexamples/ext_snapshot_list_json" } } } }, "description": "Default response for the operation 'getChannelSnapshots'." } } }, "delete": { "tags": [ "Extension Services" ], "summary": "Prunes channel snapshots older than the specified revision.", "operationId": "removeChannelSnapshots", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "revision", "in": "query", "description": "Revisions older than this parameter will be pruned.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/history/codeTemplateLibraries/{libraryId}/snapshots/{snapshotId}": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves a single code template library snapshot by ID.", "operationId": "getCodeTemplateLibrarySnapshot", "parameters": [ { "name": "libraryId", "in": "path", "description": "The ID of the code template library.", "required": true, "schema": { "type": "string" } }, { "name": "snapshotId", "in": "path", "description": "The ID of the snapshot.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "snapshot": { "description": "snapshot", "$ref": "../apiexamples/ext_code_template_library_snapshot_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "snapshot": { "description": "snapshot", "$ref": "../apiexamples/ext_code_template_library_snapshot_json" } } } }, "description": "Default response for the operation 'getCodeTemplateLibrarySnapshot'." } } } }, "/extensions/history/codeTemplateLibraries/{libraryId}/snapshots": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all snapshots for a code template library. The snapshots will only include metadata, not the actual library XML.", "operationId": "getCodeTemplateLibrarySnapshots", "parameters": [ { "name": "libraryId", "in": "path", "description": "The ID of the code template library to retrieve snapshots for.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } }, "examples": { "snapshots": { "description": "snapshots", "$ref": "../apiexamples/ext_snapshot_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } }, "examples": { "snapshots": { "description": "snapshots", "$ref": "../apiexamples/ext_snapshot_list_json" } } } }, "description": "Default response for the operation 'getCodeTemplateLibrarySnapshots'." } } }, "delete": { "tags": [ "Extension Services" ], "summary": "Prunes code template library snapshots older than the specified revision.", "operationId": "removeCodeTemplateLibrarySnapshots", "parameters": [ { "name": "libraryId", "in": "path", "description": "The ID of the code template library.", "required": true, "schema": { "type": "string" } }, { "name": "revision", "in": "query", "description": "Revisions older than this parameter will be pruned.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/history/codeTemplates/{codeTemplateId}/snapshots/{snapshotId}": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves a single code template snapshot by ID.", "operationId": "getCodeTemplateSnapshot", "parameters": [ { "name": "codeTemplateId", "in": "path", "description": "The ID of the code template.", "required": true, "schema": { "type": "string" } }, { "name": "snapshotId", "in": "path", "description": "The ID of the snapshot.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "snapshot": { "description": "snapshot", "$ref": "../apiexamples/ext_code_template_snapshot_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "snapshot": { "description": "snapshot", "$ref": "../apiexamples/ext_code_template_snapshot_json" } } } }, "description": "Default response for the operation 'getCodeTemplateSnapshot'." } } } }, "/extensions/history/codeTemplates/{codeTemplateId}/snapshots": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all snapshots for a code template. The snapshots will only include metadata, not the actual code template XML.", "operationId": "getCodeTemplateSnapshots", "parameters": [ { "name": "codeTemplateId", "in": "path", "description": "The ID of the code template to retrieve snapshots for.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } }, "examples": { "snapshots": { "description": "snapshots", "$ref": "../apiexamples/ext_snapshot_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } }, "examples": { "snapshots": { "description": "snapshots", "$ref": "../apiexamples/ext_snapshot_list_json" } } } }, "description": "Default response for the operation 'getCodeTemplateSnapshots'." } } }, "delete": { "tags": [ "Extension Services" ], "summary": "Prunes code template snapshots older than the specified revision.", "operationId": "removeCodeTemplateSnapshots", "parameters": [ { "name": "codeTemplateId", "in": "path", "description": "The ID of the code template.", "required": true, "schema": { "type": "string" } }, { "name": "revision", "in": "query", "description": "Revisions older than this parameter will be pruned.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/serverlog": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves server log entries.", "operationId": "getServerLogs", "parameters": [ { "name": "fetchSize", "in": "query", "description": "Specifies the maximum number of log items to return.", "required": true, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "lastLogId", "in": "query", "description": "The last log ID the client retrieved. Only log items with a greater ID will be returned.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerLogItem" } }, "examples": { "serverLogList": { "description": "serverLogList", "$ref": "../apiexamples/server_log_item_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerLogItem" } }, "examples": { "serverLogList": { "description": "serverLogList", "$ref": "../apiexamples/server_log_item_list_json" } } } }, "description": "Default response for the operation 'getServerLogs'." } } } }, "/extensions/ssl/trustStore": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all entries from the SSL Manager truststore.", "operationId": "getTrustStore", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } }, "examples": { "ext_ssl_truststore_entry_map": { "description": "ext_ssl_truststore_entry_map", "$ref": "../apiexamples/ext_ssl_truststore_entry_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } }, "examples": { "ext_ssl_truststore_entry_map": { "description": "ext_ssl_truststore_entry_map", "$ref": "../apiexamples/ext_ssl_truststore_entry_map_json" } } } }, "description": "Default response for the operation 'getTrustStore'." } } } }, "/extensions/ssl/_downloadServerCerts": { "post": { "tags": [ "Extension Services" ], "summary": "Download certificates from a remote TLS-enabled server.", "operationId": "downloadServerCertificates", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "host", "port" ], "type": "object", "properties": { "host": { "type": "string", "description": "The IP or domain name to connect to." }, "port": { "type": "integer", "description": "The port to connect on.", "format": "int32" }, "timeout": { "type": "integer", "description": "The timeout (in ms) to wait for a response from the server.", "format": "int32", "default": 60000 }, "localCertificateAlias": { "type": "string", "description": "The alias of the local certificate keypair to use for client authentication." }, "protocols": { "type": "array", "description": "The client TLS protocols to use. If absent uses the server defaults.", "items": { "type": "string", "description": "The client TLS protocols to use. If absent uses the server defaults." } }, "cipherSuites": { "type": "array", "description": "The TLS cipher suites to use. If absent uses the server defaults.", "items": { "type": "string", "description": "The TLS cipher suites to use. If absent uses the server defaults." } } } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "issuerX500Principal": { "type": "object", "properties": { "name": { "type": "string" }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "subjectDN": { "type": "object", "properties": { "name": { "type": "string" } } }, "notBefore": { "type": "string", "format": "date-time" }, "notAfter": { "type": "string", "format": "date-time" }, "sigAlgName": { "type": "string" }, "sigAlgOID": { "type": "string" }, "sigAlgParams": { "type": "array", "items": { "type": "string", "format": "byte" } }, "issuerUniqueID": { "type": "array", "items": { "type": "boolean" } }, "subjectUniqueID": { "type": "array", "items": { "type": "boolean" } }, "keyUsage": { "type": "array", "items": { "type": "boolean" } }, "subjectAlternativeNames": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "issuerAlternativeNames": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "version": { "type": "integer", "format": "int32" }, "serialNumber": { "type": "integer" }, "tbscertificate": { "type": "array", "items": { "type": "string", "format": "byte" } }, "extendedKeyUsage": { "type": "array", "items": { "type": "string" } }, "signature": { "type": "array", "items": { "type": "string", "format": "byte" } }, "basicConstraints": { "type": "integer", "format": "int32" }, "nonCriticalExtensionOIDs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "criticalExtensionOIDs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } }, "publicKey": { "type": "object", "properties": { "algorithm": { "type": "string" }, "format": { "type": "string" }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } } }, "examples": { "ext_ssl_cert_array": { "description": "ext_ssl_cert_array", "$ref": "../apiexamples/ext_ssl_cert_array_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "issuerX500Principal": { "type": "object", "properties": { "name": { "type": "string" }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "subjectDN": { "type": "object", "properties": { "name": { "type": "string" } } }, "notBefore": { "type": "string", "format": "date-time" }, "notAfter": { "type": "string", "format": "date-time" }, "sigAlgName": { "type": "string" }, "sigAlgOID": { "type": "string" }, "sigAlgParams": { "type": "array", "items": { "type": "string", "format": "byte" } }, "issuerUniqueID": { "type": "array", "items": { "type": "boolean" } }, "subjectUniqueID": { "type": "array", "items": { "type": "boolean" } }, "keyUsage": { "type": "array", "items": { "type": "boolean" } }, "subjectAlternativeNames": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "issuerAlternativeNames": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "version": { "type": "integer", "format": "int32" }, "serialNumber": { "type": "integer" }, "tbscertificate": { "type": "array", "items": { "type": "string", "format": "byte" } }, "extendedKeyUsage": { "type": "array", "items": { "type": "string" } }, "signature": { "type": "array", "items": { "type": "string", "format": "byte" } }, "basicConstraints": { "type": "integer", "format": "int32" }, "nonCriticalExtensionOIDs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "criticalExtensionOIDs": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } }, "publicKey": { "type": "object", "properties": { "algorithm": { "type": "string" }, "format": { "type": "string" }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } } }, "examples": { "ext_ssl_cert_array": { "description": "ext_ssl_cert_array", "$ref": "../apiexamples/ext_ssl_cert_array_json" } } } }, "description": "Default response for the operation 'downloadServerCertificates'." } } } }, "/extensions/ssl/allStoreBytes": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves the raw bytes for the SSL Manager keystore and truststore.", "operationId": "getAllStoreBytes", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "examples": { "ext_ssl_bytes_map": { "description": "ext_ssl_bytes_map", "$ref": "../apiexamples/ext_ssl_bytes_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "examples": { "ext_ssl_bytes_map": { "description": "ext_ssl_bytes_map", "$ref": "../apiexamples/ext_ssl_bytes_map_json" } } } }, "description": "Default response for the operation 'getAllStoreBytes'." } } } }, "/extensions/ssl/cacerts": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all entries from the Java cacerts truststore.", "operationId": "getCACertificates", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } }, "examples": { "ext_ssl_ca_certificates_map": { "description": "ext_ssl_ca_certificates_map", "$ref": "../apiexamples/ext_ssl_ca_certificates_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } }, "examples": { "ext_ssl_ca_certificates_map": { "description": "ext_ssl_ca_certificates_map", "$ref": "../apiexamples/ext_ssl_ca_certificates_map_json" } } } }, "description": "Default response for the operation 'getCACertificates'." } } } }, "/extensions/ssl/settings": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves global server settings for the SSL Manager.", "operationId": "getSSLManagerSettings", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SSLManagerSettings" }, "examples": { "ext_ssl_settings": { "description": "ext_ssl_settings", "$ref": "../apiexamples/ext_ssl_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/SSLManagerSettings" }, "examples": { "ext_ssl_settings": { "description": "ext_ssl_settings", "$ref": "../apiexamples/ext_ssl_settings_json" } } } }, "description": "Default response for the operation 'getSSLManagerSettings'." } } }, "put": { "tags": [ "Extension Services" ], "summary": "Updates global server settings for the SSL Manager.", "operationId": "setSSLManagerSettings", "requestBody": { "description": "The global server settings for the SSL Manager.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SSLManagerSettings" }, "examples": { "ext_ssl_settings": { "description": "ext_ssl_settings", "$ref": "../apiexamples/ext_ssl_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/SSLManagerSettings" }, "examples": { "ext_ssl_settings": { "description": "ext_ssl_settings", "$ref": "../apiexamples/ext_ssl_settings_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/ssl/all": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all entries from the SSL Manager keystore and truststore.", "operationId": "getAll", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/KeyStoreCertificates" }, "examples": { "ext_ssl_keystore_certificates": { "description": "ext_ssl_keystore_certificates", "$ref": "../apiexamples/ext_ssl_keystore_certificates_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyStoreCertificates" }, "examples": { "ext_ssl_keystore_certificates": { "description": "ext_ssl_keystore_certificates", "$ref": "../apiexamples/ext_ssl_keystore_certificates_json" } } } }, "description": "Default response for the operation 'getAll'." } } }, "put": { "tags": [ "Extension Services" ], "summary": "Restores the SSL Manager keystore and truststore from a backup. (\"Try it out\" doesn't work for this endpoint, but the descriptions are valid. Please use another tool for testing.)", "operationId": "restoreStores", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "keyStore", "trustStore" ], "type": "object", "properties": { "keyStore": { "type": "string", "description": "The raw bytes of the keystore to restore.", "format": "binary" }, "trustStore": { "type": "string", "description": "The raw bytes of the truststore to restore.", "format": "binary" }, "storePass": { "type": "string", "description": "The password for the stores. If not supplied, the password in the database will be used." } } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "ext_ssl_error_map": { "description": "ext_ssl_error_map", "$ref": "../apiexamples/ext_ssl_error_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "ext_ssl_error_map": { "description": "ext_ssl_error_map", "$ref": "../apiexamples/ext_ssl_error_map_json" } } } }, "description": "Default response for the operation 'restoreStores'." } } }, "post": { "tags": [ "Extension Services" ], "summary": "Updates entries in the SSL Manager keystore and truststore.", "operationId": "saveAll", "requestBody": { "description": "The KeyStoreCertificates object containing the keystore / truststore entries to update.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/KeyStoreCertificates" }, "examples": { "ext_ssl_keystore_certificates": { "description": "ext_ssl_keystore_certificates", "$ref": "../apiexamples/ext_ssl_keystore_certificates_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyStoreCertificates" }, "examples": { "ext_ssl_keystore_certificates": { "description": "ext_ssl_keystore_certificates", "$ref": "../apiexamples/ext_ssl_keystore_certificates_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/ssl/keyStore": { "get": { "tags": [ "Extension Services" ], "summary": "Retrieves all entries from the SSL Manager keystore.", "operationId": "getKeyStore", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } }, "examples": { "ext_ssl_keystore_entry_map": { "description": "ext_ssl_keystore_entry_map", "$ref": "../apiexamples/ext_ssl_keystore_entry_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } }, "examples": { "ext_ssl_keystore_entry_map": { "description": "ext_ssl_keystore_entry_map", "$ref": "../apiexamples/ext_ssl_keystore_entry_map_json" } } } }, "description": "Default response for the operation 'getKeyStore'." } } } }, "/alerts/options": { "get": { "tags": [ "Alerts" ], "summary": "Returns all alert protocol options.", "operationId": "getAlertProtocolOptions", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "examples": { "alert_protocol_options": { "description": "alert_protocol_options", "$ref": "../apiexamples/alert_protocol_options_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "examples": { "alert_protocol_options": { "description": "alert_protocol_options", "$ref": "../apiexamples/alert_protocol_options_json" } } } }, "description": "Default response for the operation 'getAlertProtocolOptions'." } } } }, "/alerts/_getAlerts": { "post": { "tags": [ "Alerts" ], "summary": "Retrieves multiple alerts by ID, or all alerts if not specified. This is a POST request alternative to GET /alerts that may be used when there are too many alert IDs to include in the query parameters.", "operationId": "getAlertsPost", "requestBody": { "description": "The ID of the alert(s). If absent, all alerts will be returned.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alert_set": { "description": "alert_set", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "alert_set": { "description": "alert_set", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertModel" } }, "examples": { "alert_list": { "description": "alert_list", "$ref": "../apiexamples/alert_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertModel" } }, "examples": { "alert_list": { "description": "alert_list", "$ref": "../apiexamples/alert_list_json" } } } }, "description": "Default response for the operation 'getAlertsPost'." } } } }, "/alerts/{alertId}/_getInfo": { "post": { "tags": [ "Alerts" ], "summary": "Returns an AlertInfo object containing the alert model, alert protocol options, and any updated channel summaries.", "operationId": "getAlertInfo", "parameters": [ { "name": "alertId", "in": "path", "description": "The ID of the alert.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A map of ChannelHeader objects telling the server the state of the client-side channel cache.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelHeader" } }, "examples": { "channel_header_map": { "description": "channel_header_map", "$ref": "../apiexamples/channel_header_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelHeader" } }, "examples": { "channel_header_map": { "description": "channel_header_map", "$ref": "../apiexamples/channel_header_map_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AlertInfo" }, "examples": { "alert_info": { "description": "alert_info", "$ref": "../apiexamples/alert_info_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertInfo" }, "examples": { "alert_info": { "description": "alert_info", "$ref": "../apiexamples/alert_info_json" } } } }, "description": "Default response for the operation 'getAlertInfo'." } } } }, "/alerts/_getInfo": { "post": { "tags": [ "Alerts" ], "summary": "Returns an AlertInfo object containing alert protocol options and any updated channel summaries.", "operationId": "getAlertInfo_1", "requestBody": { "description": "A map of ChannelHeader objects telling the server the state of the client-side channel cache.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelHeader" } }, "examples": { "channel_header_map": { "description": "channel_header_map", "$ref": "../apiexamples/channel_header_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelHeader" } }, "examples": { "channel_header_map": { "description": "channel_header_map", "$ref": "../apiexamples/channel_header_map_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AlertInfo" }, "examples": { "alert_info": { "description": "alert_info", "$ref": "../apiexamples/alert_info_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertInfo" }, "examples": { "alert_info": { "description": "alert_info", "$ref": "../apiexamples/alert_info_json" } } } }, "description": "Default response for the operation 'getAlertInfo_1'." } } } }, "/alerts": { "get": { "tags": [ "Alerts" ], "summary": "Retrieves multiple alerts by ID, or all alerts if not specified.", "operationId": "getAlerts", "parameters": [ { "name": "alertId", "in": "query", "description": "The ID of the alert(s). If absent, all alerts will be returned.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertModel" } }, "examples": { "alert_list": { "description": "alert_list", "$ref": "../apiexamples/alert_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertModel" } }, "examples": { "alert_list": { "description": "alert_list", "$ref": "../apiexamples/alert_list_json" } } } }, "description": "Default response for the operation 'getAlerts'." } } }, "post": { "tags": [ "Alerts" ], "summary": "Creates a new alert.", "operationId": "createAlert", "requestBody": { "description": "The alert to create.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AlertModel" }, "examples": { "alert": { "description": "alert", "$ref": "../apiexamples/alert_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertModel" }, "examples": { "alert": { "description": "alert", "$ref": "../apiexamples/alert_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/alerts/statuses": { "get": { "tags": [ "Alerts" ], "summary": "Returns all alert dashboard statuses.", "operationId": "getAlertStatusList", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertStatus" } }, "examples": { "alert_status_list": { "description": "alert_status_list", "$ref": "../apiexamples/alert_status_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertStatus" } }, "examples": { "alert_status_list": { "description": "alert_status_list", "$ref": "../apiexamples/alert_status_list_json" } } } }, "description": "Default response for the operation 'getAlertStatusList'." } } } }, "/alerts/{alertId}": { "get": { "tags": [ "Alerts" ], "summary": "Retrieves an alert by ID.", "operationId": "getAlert", "parameters": [ { "name": "alertId", "in": "path", "description": "The ID of the alert.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AlertModel" }, "examples": { "alert": { "description": "alert", "$ref": "../apiexamples/alert_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertModel" }, "examples": { "alert": { "description": "alert", "$ref": "../apiexamples/alert_json" } } } }, "description": "Default response for the operation 'getAlert'." } } }, "put": { "tags": [ "Alerts" ], "summary": "Updates the specified alert.", "operationId": "updateAlert", "parameters": [ { "name": "alertId", "in": "path", "description": "The ID of the alert.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The alert to create.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AlertModel" }, "examples": { "alert": { "description": "alert", "$ref": "../apiexamples/alert_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertModel" }, "examples": { "alert": { "description": "alert", "$ref": "../apiexamples/alert_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } }, "delete": { "tags": [ "Alerts" ], "summary": "Removes the specified alert.", "operationId": "removeAlert", "parameters": [ { "name": "alertId", "in": "path", "description": "The ID of the alert.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/alerts/{alertId}/_enable": { "post": { "tags": [ "Alerts" ], "summary": "Enables the specified alert.", "operationId": "enableAlert", "parameters": [ { "name": "alertId", "in": "path", "description": "The ID of the alert.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/alerts/{alertId}/_disable": { "post": { "tags": [ "Alerts" ], "summary": "Disables the specified alert.", "operationId": "disableAlert", "parameters": [ { "name": "alertId", "in": "path", "description": "The ID of the alert.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channelgroups/_getChannelGroups": { "post": { "tags": [ "Channel Groups" ], "summary": "Retrieve a list of all channel groups, or multiple channel groups by ID. This is a POST request alternative to GET /channelgroups that may be used when there are too many channel group IDs to include in the query parameters.", "operationId": "getChannelGroupsPost", "requestBody": { "description": "The IDs of the channel groups to retrieve. If absent, all groups will be retrieved.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "group_set": { "description": "group_set", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "group_set": { "description": "group_set", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelGroup" } }, "examples": { "channel_group_list": { "description": "channel_group_list", "$ref": "../apiexamples/channel_group_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelGroup" } }, "examples": { "channel_group_list": { "description": "channel_group_list", "$ref": "../apiexamples/channel_group_list_json" } } } }, "description": "Default response for the operation 'getChannelGroupsPost'." } } } }, "/channelgroups": { "get": { "tags": [ "Channel Groups" ], "summary": "Retrieve a list of all channel groups, or multiple channel groups by ID.", "operationId": "getChannelGroups", "parameters": [ { "name": "channelGroupId", "in": "query", "description": "The IDs of the channel groups to retrieve. If absent, all groups will be retrieved.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelGroup" } }, "examples": { "channel_group_list": { "description": "channel_group_list", "$ref": "../apiexamples/channel_group_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelGroup" } }, "examples": { "channel_group_list": { "description": "channel_group_list", "$ref": "../apiexamples/channel_group_list_json" } } } }, "description": "Default response for the operation 'getChannelGroups'." } } } }, "/channelgroups/_bulkUpdate": { "post": { "tags": [ "Channel Groups" ], "summary": "Updates all channel groups in one request. (\"Try it out\" doesn't work for this endpoint, but the descriptions are valid. Please use another tool for testing.)", "operationId": "updateChannelGroups", "parameters": [ { "name": "override", "in": "query", "description": "If true, the channel groups will be updated even if different revisions exist on the server.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "channelGroups": { "uniqueItems": true, "type": "array", "description": "The channel group object to update or create.", "items": { "$ref": "#/components/schemas/ChannelGroup" } }, "removedChannelGroupIds": { "uniqueItems": true, "type": "array", "description": "All channel group IDs known to be removed.", "items": { "type": "string", "description": "All channel group IDs known to be removed." } } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/plain": { "schema": { "type": "boolean" } } } } } } }, "/channels/idsAndNames": { "get": { "tags": [ "Channels" ], "summary": "Returns a map of all channel IDs and names.", "operationId": "getChannelIdsAndNames", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "channelNameMap": { "description": "channelNameMap", "$ref": "../apiexamples/guid_to_name_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "channelNameMap": { "description": "channelNameMap", "$ref": "../apiexamples/guid_to_name_map_json" } } } }, "description": "Default response for the operation 'getChannelIdsAndNames'." } } } }, "/channels/portsInUse": { "get": { "tags": [ "Channels" ], "summary": "Returns a list of all listener ports in use throughout the channels.", "operationId": "getChannelPortsInUse", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ports" } }, "examples": { "ports_used": { "description": "ports_used", "$ref": "../apiexamples/ports_used_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ports" } }, "examples": { "ports_used": { "description": "ports_used", "$ref": "../apiexamples/ports_used_json" } } } }, "description": "Default response for the operation 'getChannelPortsInUse'." } } } }, "/channels/_getChannels": { "post": { "tags": [ "Channels" ], "summary": "Retrieve a list of all channels, or multiple channels by ID. This is a POST request alternative to GET /channels that may be used when there are too many channel IDs to include in the query parameters.", "operationId": "getChannelsPost", "parameters": [ { "name": "pollingOnly", "in": "query", "description": "If true, only channels with polling source connectors will be returned.", "schema": { "type": "boolean" } }, { "name": "includeCodeTemplateLibraries", "in": "query", "description": "If true, code template libraries will be included in the channel.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The IDs of the channels to retrieve. If absent, all channels will be retrieved.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_list_json" } } } }, "description": "Default response for the operation 'getChannelsPost'." } } } }, "/channels/_removeChannels": { "post": { "tags": [ "Channels" ], "summary": "Removes the channels with the specified IDs. This is a POST request alternative to DELETE /channels that may be used when there are too many channel IDs to include in the query parameters.", "operationId": "removeChannelsPost", "requestBody": { "description": "The IDs of the channels to remove.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels": { "get": { "tags": [ "Channels" ], "summary": "Retrieve a list of all channels, or multiple channels by ID.", "operationId": "getChannels", "parameters": [ { "name": "channelId", "in": "query", "description": "The IDs of the channels to retrieve. If absent, all channels will be retrieved.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "pollingOnly", "in": "query", "description": "If true, only channels with polling source connectors will be returned.", "schema": { "type": "boolean" } }, { "name": "includeCodeTemplateLibraries", "in": "query", "description": "If true, code template libraries will be included in the channel.", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } }, "examples": { "channelList": { "description": "channelList", "$ref": "../apiexamples/channel_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } }, "examples": { "channelList": { "description": "channelList", "$ref": "../apiexamples/channel_list_json" } } } }, "description": "Default response for the operation 'getChannels'." } } }, "post": { "tags": [ "Channels" ], "summary": "Creates a new channel.", "operationId": "createChannel", "requestBody": { "description": "The Channel object to create.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Channel" }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Channel" }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/plain": { "schema": { "type": "boolean" } } } } } }, "delete": { "tags": [ "Channels" ], "summary": "Removes the channels with the specified IDs.", "operationId": "removeChannels", "parameters": [ { "name": "channelId", "in": "query", "description": "The IDs of the channels to remove.", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/metaDataColumns": { "get": { "tags": [ "Channels" ], "summary": "Returns all metadata columns for a channel.", "operationId": "getMetaDataColumns", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetaDataColumn" } }, "examples": { "metadataColumnList": { "description": "metadataColumnList", "$ref": "../apiexamples/metadatacolumn_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetaDataColumn" } }, "examples": { "metadataColumnList": { "description": "metadataColumnList", "$ref": "../apiexamples/metadatacolumn_list_json" } } } }, "description": "Default response for the operation 'getMetaDataColumns'." } } } }, "/channels/{channelId}/enabled/{enabled}": { "post": { "tags": [ "Channels" ], "summary": "Enables/disables the specified channel.", "operationId": "setChannelEnabled", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "enabled", "in": "path", "description": "The enabled flag (true/false) to set.", "required": true, "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_setEnabled": { "post": { "tags": [ "Channels" ], "summary": "Enables/disables the specified channels. (\"Try it Out\" only works when submitting an array containing one element for this endpoint, but the descriptions are valid. If you want to modify multiple items at once, please use another tool for testing.)", "operationId": "setChannelEnabled_1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "enabled" ], "type": "object", "properties": { "channelId": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_setInitialState": { "post": { "tags": [ "Channels" ], "summary": "Sets the initial state for the specified channels. (\"Try it Out\" only works when submitting an array containing one element for this endpoint, but the descriptions are valid. If you want to modify multiple items at once, please use another tool for testing.)", "operationId": "setChannelInitialState", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "initialState" ], "type": "object", "properties": { "channelId": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "initialState": { "type": "string", "enum": [ "STARTED", "PAUSED", "STOPPED" ] } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/initialState/{initialState}": { "post": { "tags": [ "Channels" ], "summary": "Sets the initial state for a single channel.", "operationId": "setChannelInitialState_1", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "initialState", "in": "path", "description": "The initial state of the channel.", "required": true, "schema": { "type": "string", "enum": [ "STARTED", "PAUSED", "STOPPED" ] } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}": { "get": { "tags": [ "Channels" ], "summary": "Retrieve a single channel by ID.", "operationId": "getChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "includeCodeTemplateLibraries", "in": "query", "description": "If true, code template libraries will be included in the channel.", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Channel" }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Channel" }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_json" } } } }, "description": "Default response for the operation 'getChannel'." } } }, "put": { "tags": [ "Channels" ], "summary": "Updates the specified channel.", "operationId": "updateChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to update.", "required": true, "schema": { "type": "string" } }, { "name": "override", "in": "query", "description": "If true, the channel will be updated even if a different revision exists on the server.", "schema": { "type": "boolean", "default": false } }, { "name": "startEdit", "in": "query", "description": "Date and time starting to edit this channel. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string" } } ], "requestBody": { "description": "The Channel object to update with.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Channel" }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Channel" }, "examples": { "channel": { "description": "channel", "$ref": "../apiexamples/channel_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/plain": { "schema": { "type": "boolean" } } } } } }, "delete": { "tags": [ "Channels" ], "summary": "Removes the channel with the specified ID.", "operationId": "removeChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to remove.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/connectorNames": { "get": { "tags": [ "Channels" ], "summary": "Returns all connector names for a channel.", "operationId": "getConnectorNames", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "connectorNameMap": { "description": "connectorNameMap", "$ref": "../apiexamples/connector_name_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "connectorNameMap": { "description": "connectorNameMap", "$ref": "../apiexamples/connector_name_map_json" } } } }, "description": "Default response for the operation 'getConnectorNames'." } } } }, "/channels/_getSummary": { "post": { "tags": [ "Channels" ], "summary": "Returns a list of channel summaries, indicating to a client which channels have changed (been updated, deleted, undeployed, etc.). If a channel was modified, the entire Channel object will be returned.", "operationId": "getChannelSummary", "parameters": [ { "name": "ignoreNewChannels", "in": "query", "description": "If true, summaries will only be returned for channels in the map's entry set.", "required": true, "schema": { "type": "boolean" } } ], "requestBody": { "description": "A map of ChannelHeader objects telling the server the state of the client-side channel cache.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelHeader" } }, "examples": { "cachedChannels": { "description": "cachedChannels", "$ref": "../apiexamples/channel_header_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelHeader" } }, "examples": { "cachedChannels": { "description": "cachedChannels", "$ref": "../apiexamples/channel_header_map_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelSummary" } }, "examples": { "channelSummaryList": { "description": "channelSummaryList", "$ref": "../apiexamples/channel_summary_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelSummary" } }, "examples": { "channelSummaryList": { "description": "channelSummaryList", "$ref": "../apiexamples/channel_summary_list_json" } } } }, "description": "Default response for the operation 'getChannelSummary'." } } } }, "/channels/statistics/_getStatistics": { "post": { "tags": [ "Channel Statistics" ], "summary": "Returns the Statistics for all channels. This is a POST request alternative to GET /statistics that may be used when there are too many channel IDs to include in the query parameters.", "operationId": "getStatisticsPost", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "channelIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includeUndeployed": { "type": "boolean" }, "includeMetadataIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeMetadataIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "aggregateStats": { "type": "boolean" } } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelStatistics" } }, "examples": { "channel_statistics_list": { "description": "channel_statistics_list", "$ref": "../apiexamples/channel_statistics_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelStatistics" } }, "examples": { "channel_statistics_list": { "description": "channel_statistics_list", "$ref": "../apiexamples/channel_statistics_list_json" } } } }, "description": "Default response for the operation 'getStatisticsPost'." } } } }, "/channels/_clearAllStatistics": { "post": { "tags": [ "Channel Statistics" ], "summary": "Clears all statistics (including lifetime) for all channels/connectors.", "operationId": "clearAllStatistics", "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_clearStatistics": { "post": { "tags": [ "Channel Statistics" ], "summary": "Clears the statistics for the given channels and/or connectors.", "operationId": "clearStatistics", "parameters": [ { "name": "received", "in": "query", "description": "If true, received stats will be cleared.", "schema": { "type": "boolean" } }, { "name": "filtered", "in": "query", "description": "If true, filtered stats will be cleared.", "schema": { "type": "boolean" } }, { "name": "sent", "in": "query", "description": "If true, sent stats will be cleared.", "schema": { "type": "boolean" } }, { "name": "error", "in": "query", "description": "If true, error stats will be cleared.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Channel IDs mapped to lists of metaDataIds (connectors). If the metaDataId list is null, then all statistics for the channel will be cleared.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "examples": { "connector_map": { "description": "connector_map", "$ref": "../apiexamples/connector_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "examples": { "connector_map": { "description": "connector_map", "$ref": "../apiexamples/connector_map_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/statistics": { "get": { "tags": [ "Channel Statistics" ], "summary": "Returns the Statistics for the channel with the specified id.", "operationId": "getStatistics", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to retrieve statistics for.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ChannelStatistics" }, "examples": { "channel_statistics": { "description": "channel_statistics", "$ref": "../apiexamples/channel_statistics_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChannelStatistics" }, "examples": { "channel_statistics": { "description": "channel_statistics", "$ref": "../apiexamples/channel_statistics_json" } } } }, "description": "Default response for the operation 'getStatistics'." } } } }, "/channels/statistics": { "get": { "tags": [ "Channel Statistics" ], "summary": "Returns the Statistics for all channels.", "operationId": "getStatistics_1", "parameters": [ { "name": "channelId", "in": "query", "description": "The IDs of the channels to retrieve. If absent, all channels will be retrieved.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "includeUndeployed", "in": "query", "description": "If true, statistics for undeployed channels will also be included.", "schema": { "type": "boolean" } }, { "name": "includeMetadataId", "in": "query", "description": "The ids of connectors to include. Cannot include and exclude connectors.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "excludeMetadataId", "in": "query", "description": "The ids of connectors to exclude. Cannot include and exclude connectors.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "aggregateStats", "in": "query", "description": "If true, statistics will be aggregated into one result", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelStatistics" } }, "examples": { "channel_statistics_list": { "description": "channel_statistics_list", "$ref": "../apiexamples/channel_statistics_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelStatistics" } }, "examples": { "channel_statistics_list": { "description": "channel_statistics_list", "$ref": "../apiexamples/channel_statistics_list_json" } } } }, "description": "Default response for the operation 'getStatistics_1'." } } } }, "/channels/statuses/_getChannelStatusList": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Returns all channel dashboard statuses, or multiple statuses by channel ID. This is a POST request alternative to GET /statuses that may be used when there are too many channel IDs to include in the query parameters.", "operationId": "getChannelStatusListPost", "parameters": [ { "name": "filter", "in": "query", "description": "The filter string to limit dashboard statuses with.", "schema": { "type": "string" } }, { "name": "includeUndeployed", "in": "query", "description": "If true, statuses for undeployed channels will also be included.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The channel IDs to return dashboard statuses for. If absent, all statuses will be returned.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channel_set": { "description": "channel_set", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channel_set": { "description": "channel_set", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardStatus" } }, "examples": { "dashboard_status_list": { "description": "dashboard_status_list", "$ref": "../apiexamples/dashboard_status_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardStatus" } }, "examples": { "dashboard_status_list": { "description": "dashboard_status_list", "$ref": "../apiexamples/dashboard_status_list_json" } } } }, "description": "Default response for the operation 'getChannelStatusListPost'." } } } }, "/channels/statuses/initial": { "get": { "tags": [ "Channel Status Operations" ], "summary": "Returns a DashboardChannelInfo object containing a partial channel status list and a set of remaining channel IDs.", "operationId": "getDashboardChannelInfo", "parameters": [ { "name": "fetchSize", "in": "query", "description": "Specifies the maximum number of statuses to return.", "required": true, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "filter", "in": "query", "description": "The filter string to limit dashboard statuses with.", "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/DashboardChannelInfo" }, "examples": { "dashboard_channel_info": { "description": "dashboard_channel_info", "$ref": "../apiexamples/dashboard_channel_info_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DashboardChannelInfo" }, "examples": { "dashboard_channel_info": { "description": "dashboard_channel_info", "$ref": "../apiexamples/dashboard_channel_info_json" } } } }, "description": "Default response for the operation 'getDashboardChannelInfo'." } } } }, "/channels/{channelId}/_start": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Starts the channel with the specified ID.", "operationId": "startChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to start.", "required": true, "schema": { "type": "string" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/_stop": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Stops the channel with the specified ID.", "operationId": "stopChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to stop.", "required": true, "schema": { "type": "string" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/_halt": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Halts the channel with the specified ID.", "operationId": "haltChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to halt.", "required": true, "schema": { "type": "string" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/_pause": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Pauses the channel with the specified ID.", "operationId": "pauseChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to pause.", "required": true, "schema": { "type": "string" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/_resume": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Resumes the channel with the specified ID.", "operationId": "resumeChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to resume.", "required": true, "schema": { "type": "string" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_startConnectors": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Starts the connectors with the specified channel and metadata IDs.", "operationId": "startConnectors", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "A map of channel and metadata IDs to start connectors for.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "examples": { "start_connector_map": { "description": "start_connector_map", "$ref": "../apiexamples/start_connector_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "examples": { "start_connector_map": { "description": "start_connector_map", "$ref": "../apiexamples/start_connector_map_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_stopConnectors": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Stops the connectors with the specified channel and metadata IDs.", "operationId": "stopConnectors", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "A map of channel and metadata IDs to stop connectors for.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "examples": { "start_connector_map": { "description": "start_connector_map", "$ref": "../apiexamples/start_connector_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "examples": { "start_connector_map": { "description": "start_connector_map", "$ref": "../apiexamples/start_connector_map_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_start": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Starts the channels with the specified IDs. (\"Try it Out\" only works when submitting an array containing one element for this endpoint, but the descriptions are valid. If you want to modify multiple items at once, please use another tool for testing.)", "operationId": "startChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId" ], "type": "object", "properties": { "channelId": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_stop": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Stops the channels with the specified IDs. (\"Try it Out\" only works when submitting an array containing one element for this endpoint, but the descriptions are valid. If you want to modify multiple items at once, please use another tool for testing.)", "operationId": "stopChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId" ], "type": "object", "properties": { "channelId": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_pause": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Pauses the channels with the specified IDs. (\"Try it Out\" only works when submitting an array containing one element for this endpoint, but the descriptions are valid. If you want to modify multiple items at once, please use another tool for testing.)", "operationId": "pauseChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId" ], "type": "object", "properties": { "channelId": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_resume": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Resume the channels with the specified IDs. (\"Try it Out\" only works when submitting an array containing one element for this endpoint, but the descriptions are valid. If you want to modify multiple items at once, please use another tool for testing.)", "operationId": "resumeChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId" ], "type": "object", "properties": { "channelId": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/connector/{metaDataId}/_start": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Starts the connector with the specified channel and metadata ID.", "operationId": "startConnector", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to start a connector for.", "required": true, "schema": { "type": "string" } }, { "name": "metaDataId", "in": "path", "description": "The connector metadata ID to start.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/connector/{metaDataId}/_stop": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Stops the connector with the specified channel and metadata ID.", "operationId": "stopConnector", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to stop a connector for.", "required": true, "schema": { "type": "string" } }, { "name": "metaDataId", "in": "path", "description": "The connector metadata ID to stop.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_halt": { "post": { "tags": [ "Channel Status Operations" ], "summary": "Halts the channels with the specified IDs. (\"Try it Out\" only works when submitting an array containing one element for this endpoint, but the descriptions are valid. If you want to modify multiple items at once, please use another tool for testing.)", "operationId": "haltChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "channelId" ], "type": "object", "properties": { "channelId": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/status": { "get": { "tags": [ "Channel Status Operations" ], "summary": "Returns the dashboard status for a single channel ID.", "operationId": "getChannelStatus", "parameters": [ { "name": "channelId", "in": "path", "description": "The channel ID to return a dashboard status for.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/DashboardStatus" }, "examples": { "dashboard_status": { "description": "dashboard_status", "$ref": "../apiexamples/dashboard_status_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DashboardStatus" }, "examples": { "dashboard_status": { "description": "dashboard_status", "$ref": "../apiexamples/dashboard_status_json" } } } }, "description": "Default response for the operation 'getChannelStatus'." } } } }, "/channels/statuses": { "get": { "tags": [ "Channel Status Operations" ], "summary": "Returns all channel dashboard statuses, or multiple statuses by channel ID.", "operationId": "getChannelStatusList", "parameters": [ { "name": "channelId", "in": "query", "description": "The channel IDs to return dashboard statuses for. If absent, all statuses will be returned.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "filter", "in": "query", "description": "The filter string to limit dashboard statuses with.", "schema": { "type": "string" } }, { "name": "includeUndeployed", "in": "query", "description": "If true, statuses for undeployed channels will also be included.", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardStatus" } }, "examples": { "dashboard_status_list": { "description": "dashboard_status_list", "$ref": "../apiexamples/dashboard_status_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardStatus" } }, "examples": { "dashboard_status_list": { "description": "dashboard_status_list", "$ref": "../apiexamples/dashboard_status_list_json" } } } }, "description": "Default response for the operation 'getChannelStatusList'." } } } }, "/codeTemplateLibraries/_getCodeTemplateLibraries": { "post": { "tags": [ "Code Templates" ], "summary": "Retrieves multiple code template libraries by ID, or all libraries if not specified. This is a POST request alternative to GET /codeTemplateLibraries that may be used when there are too many library IDs to include in the query parameters.", "operationId": "getCodeTemplateLibrariesPost", "parameters": [ { "name": "includeCodeTemplates", "in": "query", "description": "If true, full code templates will be included inside each library.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The ID of the library(s) to retrieve.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "code_template_library_id_set": { "description": "code_template_library_id_set", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "code_template_library_id_set": { "description": "code_template_library_id_set", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "examples": { "code_template_library_list": { "description": "code_template_library_list", "$ref": "../apiexamples/code_template_library_list_xml" }, "code_template_library_list_full_templates": { "description": "code_template_library_list_full_templates", "$ref": "../apiexamples/code_template_library_list_full_templates_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "examples": { "code_template_library_list": { "description": "code_template_library_list", "$ref": "../apiexamples/code_template_library_list_json" }, "code_template_library_list_full_templates": { "description": "code_template_library_list_full_templates", "$ref": "../apiexamples/code_template_library_list_full_templates_json" } } } }, "description": "Default response for the operation 'getCodeTemplateLibrariesPost'." } } } }, "/codeTemplateLibraries/{libraryId}": { "get": { "tags": [ "Code Templates" ], "summary": "Retrieves a single code template library.", "operationId": "getCodeTemplateLibrary", "parameters": [ { "name": "libraryId", "in": "path", "description": "The ID of the library to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "includeCodeTemplates", "in": "query", "description": "If true, full code templates will be included inside each library.", "schema": { "type": "boolean", "default": false } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CodeTemplateLibrary" }, "examples": { "code_template_library": { "description": "code_template_library", "$ref": "../apiexamples/code_template_library_xml" }, "code_template_library_full_templates": { "description": "code_template_library_full_templates", "$ref": "../apiexamples/code_template_library_full_templates_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CodeTemplateLibrary" }, "examples": { "code_template_library": { "description": "code_template_library", "$ref": "../apiexamples/code_template_library_json" }, "code_template_library_full_templates": { "description": "code_template_library_full_templates", "$ref": "../apiexamples/code_template_library_full_templates_json" } } } }, "description": "Default response for the operation 'getCodeTemplateLibrary'." } } } }, "/codeTemplates/{codeTemplateId}": { "get": { "tags": [ "Code Templates" ], "summary": "Retrieves a single code template.", "operationId": "getCodeTemplate", "parameters": [ { "name": "codeTemplateId", "in": "path", "description": "The ID of the code template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CodeTemplate" }, "examples": { "code_template": { "description": "code_template", "$ref": "../apiexamples/code_template_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CodeTemplate" }, "examples": { "code_template": { "description": "code_template", "$ref": "../apiexamples/code_template_json" } } } }, "description": "Default response for the operation 'getCodeTemplate'." } } }, "put": { "tags": [ "Code Templates" ], "summary": "Updates a single code template.", "operationId": "updateCodeTemplate", "parameters": [ { "name": "codeTemplateId", "in": "path", "description": "The ID of the code template.", "required": true, "schema": { "type": "string" } }, { "name": "override", "in": "query", "description": "If true, the code template will be updated even if a different revision exists on the server.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The CodeTemplate object to update with.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CodeTemplate" }, "examples": { "code_template": { "description": "code_template", "$ref": "../apiexamples/code_template_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CodeTemplate" }, "examples": { "code_template": { "description": "code_template", "$ref": "../apiexamples/code_template_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "boolean" }, "examples": { "code_template_replaced": { "description": "code_template_replaced", "$ref": "../apiexamples/boolean_xml" } } }, "application/json": { "schema": { "type": "boolean" }, "examples": { "code_template_replaced": { "description": "code_template_replaced", "$ref": "../apiexamples/boolean_json" } } } }, "description": "Default response for the operation 'updateCodeTemplate'." } } }, "delete": { "tags": [ "Code Templates" ], "summary": "Removes a single code template.", "operationId": "removeCodeTemplate", "parameters": [ { "name": "codeTemplateId", "in": "path", "description": "The ID of the code template.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/codeTemplateLibraries": { "get": { "tags": [ "Code Templates" ], "summary": "Retrieves multiple code template libraries by ID, or all libraries if not specified.", "operationId": "getCodeTemplateLibraries", "parameters": [ { "name": "libraryId", "in": "query", "description": "The ID of the library(s) to retrieve.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "includeCodeTemplates", "in": "query", "description": "If true, full code templates will be included inside each library.", "schema": { "type": "boolean", "default": false } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "examples": { "code_template_library_list": { "description": "code_template_library_list", "$ref": "../apiexamples/code_template_library_list_xml" }, "code_template_library_list_full_templates": { "description": "code_template_library_list_full_templates", "$ref": "../apiexamples/code_template_library_list_full_templates_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "examples": { "code_template_library_list": { "description": "code_template_library_list", "$ref": "../apiexamples/code_template_library_list_json" }, "code_template_library_list_full_templates": { "description": "code_template_library_list_full_templates", "$ref": "../apiexamples/code_template_library_list_full_templates_json" } } } }, "description": "Default response for the operation 'getCodeTemplateLibraries'." } } }, "put": { "tags": [ "Code Templates" ], "summary": "Replaces all code template libraries.", "operationId": "updateCodeTemplateLibraries", "parameters": [ { "name": "override", "in": "query", "description": "If true, the code template library will be updated even if a different revision exists on the server.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The list of code template libraries to replace with.", "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "examples": { "code_template_library_list_full_templates": { "description": "code_template_library_list_full_templates", "$ref": "../apiexamples/code_template_library_list_full_templates_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "examples": { "code_template_library_list_full_templates": { "description": "code_template_library_list_full_templates", "$ref": "../apiexamples/code_template_library_list_full_templates_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "boolean" }, "examples": { "libraries_replaced": { "description": "libraries_replaced", "$ref": "../apiexamples/boolean_xml" } } }, "application/json": { "schema": { "type": "boolean" }, "examples": { "libraries_replaced": { "description": "libraries_replaced", "$ref": "../apiexamples/boolean_json" } } } }, "description": "Default response for the operation 'updateCodeTemplateLibraries'." } } } }, "/codeTemplates/_getCodeTemplates": { "post": { "tags": [ "Code Templates" ], "summary": "Retrieves multiple code templates by ID, or all templates if not specified. This is a POST request alternative to GET /codeTemplates that may be used when there are too many code template IDs to include in the query parameters.", "operationId": "getCodeTemplatesPost", "requestBody": { "description": "The ID of the code template(s) to retrieve.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "code_template_id_set": { "description": "code_template_id_set", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "code_template_id_set": { "description": "code_template_id_set", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplate" } }, "examples": { "code_template_list": { "description": "code_template_list", "$ref": "../apiexamples/code_template_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplate" } }, "examples": { "code_template_list": { "description": "code_template_list", "$ref": "../apiexamples/code_template_list_json" } } } }, "description": "Default response for the operation 'getCodeTemplatesPost'." } } } }, "/codeTemplates": { "get": { "tags": [ "Code Templates" ], "summary": "Retrieves multiple code templates by ID, or all templates if not specified.", "operationId": "getCodeTemplates", "parameters": [ { "name": "codeTemplateId", "in": "query", "description": "The ID of the code template(s) to retrieve.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplate" } }, "examples": { "code_template_list": { "description": "code_template_list", "$ref": "../apiexamples/code_template_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplate" } }, "examples": { "code_template_list": { "description": "code_template_list", "$ref": "../apiexamples/code_template_list_json" } } } }, "description": "Default response for the operation 'getCodeTemplates'." } } } }, "/codeTemplates/_getSummary": { "post": { "tags": [ "Code Templates" ], "summary": "Returns a list of code template summaries, indicating to a client which code templates have changed. If a code template was modified, the entire CodeTemplate object will be returned.", "operationId": "getCodeTemplateSummary", "requestBody": { "description": "A map of revisions telling the server the state of the client-side code template cache.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "examples": { "guid_to_int_map": { "description": "guid_to_int_map", "$ref": "../apiexamples/guid_to_int_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "examples": { "guid_to_int_map": { "description": "guid_to_int_map", "$ref": "../apiexamples/guid_to_int_map_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateSummary" } }, "examples": { "code_template_summary_list": { "description": "code_template_summary_list", "$ref": "../apiexamples/code_template_summary_list_xml" }, "code_template_summary_list_revision_changed": { "description": "code_template_summary_list_revision_changed", "$ref": "../apiexamples/code_template_summary_list_revision_changed_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateSummary" } }, "examples": { "code_template_summary_list": { "description": "code_template_summary_list", "$ref": "../apiexamples/code_template_summary_list_json" }, "code_template_summary_list_revision_changed": { "description": "code_template_summary_list_revision_changed", "$ref": "../apiexamples/code_template_summary_list_revision_changed_json" } } } }, "description": "Default response for the operation 'getCodeTemplateSummary'." } } } }, "/codeTemplateLibraries/_bulkUpdate": { "post": { "tags": [ "Code Templates" ], "summary": "Updates all libraries and updates/removes selected code templates in one request. (\"Try it out\" doesn't work for this endpoint, but the descriptions are valid. Please use another tool for testing.)", "operationId": "updateLibrariesAndTemplates", "parameters": [ { "name": "override", "in": "query", "description": "If true, the libraries and code templates will be updated even if different revisions exist on the server.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "libraries": { "type": "array", "description": "The set of code template libraries to replace with.", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "removedLibraryIds": { "uniqueItems": true, "type": "array", "description": "All library IDs known to be removed.", "items": { "type": "string", "description": "All library IDs known to be removed." } }, "updatedCodeTemplates": { "type": "array", "description": "The set of code templates to update.", "items": { "$ref": "#/components/schemas/CodeTemplate" } }, "removedCodeTemplateIds": { "uniqueItems": true, "type": "array", "description": "All code template IDs known to be removed.", "items": { "type": "string", "description": "All code template IDs known to be removed." } } } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CodeTemplateLibrarySaveResult" }, "examples": { "code_template_library_saved_result": { "description": "code_template_library_saved_result", "$ref": "../apiexamples/code_template_library_saved_result_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/CodeTemplateLibrarySaveResult" }, "examples": { "code_template_library_saved_result": { "description": "code_template_library_saved_result", "$ref": "../apiexamples/code_template_library_saved_result_json" } } } }, "description": "Default response for the operation 'updateLibrariesAndTemplates'." } } } }, "/server/jvm": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the name of the JVM running Mirth Connect.", "operationId": "getJVMName", "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/server/about": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a map of common information about the Mirth Connect server.", "operationId": "getAbout", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "examples": { "aboutMap": { "description": "aboutMap", "$ref": "../apiexamples/generic_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "examples": { "aboutMap": { "description": "aboutMap", "$ref": "../apiexamples/generic_map_json" } } } }, "description": "Default response for the operation 'getAbout'." } } } }, "/server/licenseInfo": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a LicenseInfo object with the expiration date and other information.", "operationId": "getLicenseInfo", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/LicenseInfo" }, "examples": { "licenseInfo": { "description": "licenseInfo", "$ref": "../apiexamples/license_info_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LicenseInfo" }, "examples": { "licenseInfo": { "description": "licenseInfo", "$ref": "../apiexamples/license_info_json" } } } }, "description": "Default response for the operation 'getLicenseInfo'." } } } }, "/server/_generateGUID": { "post": { "tags": [ "Server Configuration" ], "summary": "Returns a globally unique id.", "operationId": "getGuid", "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/server/protocolsAndCipherSuites": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a map containing all supported and enabled TLS protocols and cipher suites.", "operationId": "getProtocolsAndCipherSuites", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "protocolsAndCipherSuites": { "description": "protocolsAndCipherSuites", "$ref": "../apiexamples/protocols_and_cipher_suites_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "protocolsAndCipherSuites": { "description": "protocolsAndCipherSuites", "$ref": "../apiexamples/protocols_and_cipher_suites_map_json" } } } }, "description": "Default response for the operation 'getProtocolsAndCipherSuites'." } } } }, "/server/version": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the version of the Mirth Connect server.", "operationId": "getVersion", "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/server/status": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the status of the Mirth Connect server.", "operationId": "getStatus", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "integer", "format": "int32" }, "examples": { "status": { "description": "status", "$ref": "../apiexamples/integer_xml" } } }, "application/json": { "schema": { "type": "integer", "format": "int32" }, "examples": { "status": { "description": "status", "$ref": "../apiexamples/integer_json" } } } }, "description": "Default response for the operation 'getStatus'." } } } }, "/server/id": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the server id.", "operationId": "getServerId", "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/server/updateSettings": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns an UpdateSettings object with all update settings.", "operationId": "getUpdateSettings", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/UpdateSettings" }, "examples": { "updateSettings": { "description": "updateSettings", "$ref": "../apiexamples/update_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSettings" }, "examples": { "updateSettings": { "description": "updateSettings", "$ref": "../apiexamples/update_settings_json" } } } }, "description": "Default response for the operation 'getUpdateSettings'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates the update settings.", "operationId": "setUpdateSettings", "requestBody": { "description": "The UpdateSettings object containing all of the settings to update.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/UpdateSettings" }, "examples": { "updateSetings": { "description": "updateSetings", "$ref": "../apiexamples/update_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSettings" }, "examples": { "updateSettings": { "description": "updateSettings", "$ref": "../apiexamples/update_settings_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/configurationMap": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns all entries in the configuration map.", "operationId": "getConfigurationMap", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConfigurationProperty" } }, "examples": { "configurationMap": { "description": "configurationMap", "$ref": "../apiexamples/configuration_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConfigurationProperty" } }, "examples": { "configurationMap": { "description": "configurationMap", "$ref": "../apiexamples/configuration_map_json" } } } }, "description": "Default response for the operation 'getConfigurationMap'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates all entries in the configuration map.", "operationId": "setConfigurationMap", "requestBody": { "description": "The new configuration map to update with.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConfigurationProperty" } }, "examples": { "configurationMap": { "description": "configurationMap", "$ref": "../apiexamples/configuration_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConfigurationProperty" } }, "examples": { "configurationMap": { "description": "configurationMap", "$ref": "../apiexamples/configuration_map_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/settings": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a ServerSettings object with all server settings.", "operationId": "getServerSettings", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ServerSettings" }, "examples": { "serverSettings": { "description": "serverSettings", "$ref": "../apiexamples/server_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServerSettings" }, "examples": { "serverSettings": { "description": "serverSettings", "$ref": "../apiexamples/server_settings_json" } } } }, "description": "Default response for the operation 'getServerSettings'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates the server configuration settings.", "operationId": "setServerSettings", "requestBody": { "description": "The ServerSettings object containing all of the settings to update.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ServerSettings" }, "examples": { "serverSettings": { "description": "serverSettings", "$ref": "../apiexamples/server_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServerSettings" }, "examples": { "serverSettings": { "description": "serverSettings", "$ref": "../apiexamples/server_settings_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/channelMetadata": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns all channel metadata for the server.", "operationId": "getChannelMetadata", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelMetadata" } }, "examples": { "channelMetadata": { "description": "channelMetadata", "$ref": "../apiexamples/channel_metadata_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelMetadata" } }, "examples": { "channelMetadata": { "description": "channelMetadata", "$ref": "../apiexamples/channel_metadata_map_json" } } } }, "description": "Default response for the operation 'getChannelMetadata'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates all channel metadata for the server.", "operationId": "setChannelMetadata", "requestBody": { "description": "The map of channel metadata to set.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelMetadata" } }, "examples": { "channelMetadata": { "description": "channelMetadata", "$ref": "../apiexamples/channel_metadata_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelMetadata" } }, "examples": { "channelMetadata": { "description": "channelMetadata", "$ref": "../apiexamples/channel_metadata_map_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/channelTags": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a set containing all channel tags for the server.", "operationId": "getChannelTags", "responses": { "default": { "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelTag" } }, "examples": { "channelTags": { "description": "channelTags", "$ref": "../apiexamples/channel_tag_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelTag" } }, "examples": { "channelTags": { "description": "channelTags", "$ref": "../apiexamples/channel_tag_set_json" } } } }, "description": "Default response for the operation 'getChannelTags'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates all channel tags.", "operationId": "setChannelTags", "requestBody": { "description": "The channel tags to set.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelTag" } }, "examples": { "channelTags": { "description": "channelTags", "$ref": "../apiexamples/channel_tag_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelTag" } }, "examples": { "channelTags": { "description": "channelTags", "$ref": "../apiexamples/channel_tag_set_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/globalScripts": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a map containing all of the global scripts.", "operationId": "getGlobalScripts", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "globalScripts": { "description": "globalScripts", "$ref": "../apiexamples/global_scripts_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "globalScripts": { "description": "globalScripts", "$ref": "../apiexamples/global_scripts_json" } } } }, "description": "Default response for the operation 'getGlobalScripts'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates all of the global scripts.", "operationId": "setGlobalScripts", "requestBody": { "description": "The map of global scripts to update with. Script keys: Deploy, Undeploy, Preprocessor, Postprocessor", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "globalScripts": { "description": "globalScripts", "$ref": "../apiexamples/global_scripts_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "globalScripts": { "description": "globalScripts", "$ref": "../apiexamples/global_scripts_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/channelDependencies": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns all channel dependencies for the server.", "operationId": "getChannelDependencies", "responses": { "default": { "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelDependency" } }, "examples": { "channelDependencies": { "description": "channelDependencies", "$ref": "../apiexamples/channel_dependency_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelDependency" } }, "examples": { "channelDependencies": { "description": "channelDependencies", "$ref": "../apiexamples/channel_dependency_set_json" } } } }, "description": "Default response for the operation 'getChannelDependencies'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates all channel dependencies for the server.", "operationId": "setChannelDependencies", "requestBody": { "description": "The channel dependencies to set.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelDependency" } }, "examples": { "channelDependencies": { "description": "channelDependencies", "$ref": "../apiexamples/channel_dependency_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelDependency" } }, "examples": { "channelDependencies": { "description": "channelDependencies", "$ref": "../apiexamples/channel_dependency_set_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/rhinoLanguageVersion": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the language version that the Rhino engine should use.", "operationId": "getRhinoLanguageVersion", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "integer", "format": "int32" }, "examples": { "rhinoLanguageVersion": { "description": "rhinoLanguageVersion", "$ref": "../apiexamples/integer_xml" } } }, "application/json": { "schema": { "type": "integer", "format": "int32" }, "examples": { "rhinoLanguageVersion": { "description": "rhinoLanguageVersion", "$ref": "../apiexamples/integer_json" } } } }, "description": "Default response for the operation 'getRhinoLanguageVersion'." } } } }, "/server/timezone": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the time zone of the server.", "operationId": "getServerTimezone", "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/server/time": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the time of the server.", "operationId": "getServerTime", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "string", "format": "date-time" }, "examples": { "serverTime": { "description": "serverTime", "$ref": "../apiexamples/calendar_xml" } } }, "application/json": { "schema": { "type": "string", "format": "date-time" }, "examples": { "serverTime": { "description": "serverTime", "$ref": "../apiexamples/calendar_json" } } } }, "description": "Default response for the operation 'getServerTime'." } } } }, "/server/charsets": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a List of all of the charset encodings supported by the server.", "operationId": "getAvailableCharsetEncodings", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "charsetEncodings": { "description": "charsetEncodings", "$ref": "../apiexamples/charset_encoding_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "charsetEncodings": { "description": "charsetEncodings", "$ref": "../apiexamples/charset_encoding_list_json" } } } }, "description": "Default response for the operation 'getAvailableCharsetEncodings'." } } } }, "/server/publicSettings": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a PublicServerSettings object containing server settings available to all users.", "operationId": "getPublicServerSettings", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PublicServerSettings" }, "examples": { "publicServerSettings": { "description": "publicServerSettings", "$ref": "../apiexamples/public_server_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicServerSettings" }, "examples": { "publicServerSettings": { "description": "publicServerSettings", "$ref": "../apiexamples/public_server_settings_json" } } } }, "description": "Default response for the operation 'getPublicServerSettings'." } } } }, "/server/encryption": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns an EncryptionSettings object with all encryption settings.", "operationId": "getEncryptionSettings", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/EncryptionSettings" }, "examples": { "encryptionSettings": { "description": "encryptionSettings", "$ref": "../apiexamples/encryption_settings_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncryptionSettings" }, "examples": { "encryptionSettings": { "description": "encryptionSettings", "$ref": "../apiexamples/encryption_settings_json" } } } }, "description": "Default response for the operation 'getEncryptionSettings'." } } } }, "/server/databaseDrivers": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the database driver list.", "operationId": "getDatabaseDrivers", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DriverInfo" } }, "examples": { "driverInfoList": { "description": "driverInfoList", "$ref": "../apiexamples/driver_info_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DriverInfo" } }, "examples": { "driverInfoList": { "description": "driverInfoList", "$ref": "../apiexamples/driver_info_list_json" } } } }, "description": "Default response for the operation 'getDatabaseDrivers'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates the list of database drivers.", "operationId": "setDatabaseDrivers", "requestBody": { "description": "The new list of database drivers to update.", "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DriverInfo" } }, "examples": { "driverInfoList": { "description": "driverInfoList", "$ref": "../apiexamples/driver_info_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DriverInfo" } }, "examples": { "driverInfoList": { "description": "driverInfoList", "$ref": "../apiexamples/driver_info_list_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/buildDate": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns the build date of the Mirth Connect server.", "operationId": "getBuildDate", "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/server/configuration": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns a ServerConfiguration object which contains all of the channels, alerts, configuration map, and properties stored on the Mirth Connect server.", "operationId": "getServerConfiguration", "parameters": [ { "name": "initialState", "in": "query", "description": "The initial state to set all channels in the configuration to.", "schema": { "type": "string", "enum": [ "STARTED", "PAUSED", "STOPPED" ] } }, { "name": "pollingOnly", "in": "query", "description": "If true, and the initialState parameter is set, only channels with polling source connectors will have their initial states overwritten in the returned server configuration.", "schema": { "type": "boolean" } }, { "name": "disableAlerts", "in": "query", "description": "If true, all alerts returned in the server configuration will be disabled.", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ServerConfiguration" }, "examples": { "serverConfiguration": { "description": "serverConfiguration", "$ref": "../apiexamples/server_configuration_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfiguration" }, "examples": { "serverConfiguration": { "description": "serverConfiguration", "$ref": "../apiexamples/server_configuration_json" } } } }, "description": "Default response for the operation 'getServerConfiguration'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates all of the channels, alerts and properties stored on the Mirth Connect server.", "operationId": "setServerConfiguration", "parameters": [ { "name": "deploy", "in": "query", "description": "If true, all enabled channels will be deployed after the configuration is restored.", "schema": { "type": "boolean", "default": false } }, { "name": "overwriteConfigMap", "in": "query", "description": "If true, overwrite the Configuration Map", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The ServerConfiguration object containing all channels, users, alerts, and properties to update.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ServerConfiguration" }, "examples": { "serverConfiguration": { "description": "serverConfiguration", "$ref": "../apiexamples/server_configuration_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfiguration" }, "examples": { "serverConfiguration": { "description": "serverConfiguration", "$ref": "../apiexamples/server_configuration_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/resources": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns all resources for the server.", "operationId": "getResources", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceProperties" } }, "examples": { "resources": { "description": "resources", "$ref": "../apiexamples/resource_properties_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceProperties" } }, "examples": { "resources": { "description": "resources", "$ref": "../apiexamples/resource_properties_list_json" } } } }, "description": "Default response for the operation 'getResources'." } } }, "put": { "tags": [ "Server Configuration" ], "summary": "Updates all resources for the server.", "operationId": "setResources", "requestBody": { "description": "The new list of resource properties to update with.", "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceProperties" } }, "examples": { "resources": { "description": "resources", "$ref": "../apiexamples/resource_properties_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceProperties" } }, "examples": { "resources": { "description": "resources", "$ref": "../apiexamples/resource_properties_list_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/server/_testEmail": { "post": { "tags": [ "Server Configuration" ], "summary": "Sends a test e-mail.", "operationId": "sendTestEmail_1", "requestBody": { "description": "Contains all properties needed to send the e-mail. Properties include: port, encryption, host, timeout, authentication, username, password, toAddress, fromAddress", "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_xml" } } }, "application/json": { "schema": { "type": "string" }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTestResponse" } } } } } } }, "/server/passwordRequirements": { "get": { "tags": [ "Server Configuration" ], "summary": "Returns all password requirements for the server.", "operationId": "getPasswordRequirements", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PasswordRequirements" }, "examples": { "passwordRequirements": { "description": "passwordRequirements", "$ref": "../apiexamples/password_requirements_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordRequirements" }, "examples": { "passwordRequirements": { "description": "passwordRequirements", "$ref": "../apiexamples/password_requirements_json" } } } }, "description": "Default response for the operation 'getPasswordRequirements'." } } } }, "/server/resources/{resourceId}/_reload": { "post": { "tags": [ "Server Configuration" ], "summary": "Reloads a resource and all libraries associated with it.", "operationId": "reloadResource", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique ID of the resource to reload.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/databaseTasks/{databaseTaskId}": { "get": { "tags": [ "Database Tasks" ], "summary": "Retrieves a single database task.", "operationId": "getDatabaseTask", "parameters": [ { "name": "databaseTaskId", "in": "path", "description": "The ID of the database task.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/DatabaseTask" }, "examples": { "database_task": { "description": "database_task", "$ref": "../apiexamples/database_task_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/DatabaseTask" }, "examples": { "database_task": { "description": "database_task", "$ref": "../apiexamples/database_task_json" } } } }, "description": "Default response for the operation 'getDatabaseTask'." } } } }, "/databaseTasks/{databaseTaskId}/_run": { "post": { "tags": [ "Database Tasks" ], "summary": "Executes the specified database task.", "operationId": "runDatabaseTask", "parameters": [ { "name": "databaseTaskId", "in": "path", "description": "The ID of the database task.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Table SOME_TABLE successfully dropped." } }, "description": "Default response for the operation 'runDatabaseTask'." } } } }, "/databaseTasks/{databaseTaskId}/_cancel": { "post": { "tags": [ "Database Tasks" ], "summary": "Cancels execution of the specified database task.", "operationId": "cancelDatabaseTask", "parameters": [ { "name": "databaseTaskId", "in": "path", "description": "The ID of the database task.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/databaseTasks": { "get": { "tags": [ "Database Tasks" ], "summary": "Retrieves all current database tasks.", "operationId": "getDatabaseTasks", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DatabaseTask" } }, "examples": { "database_task_map": { "description": "database_task_map", "$ref": "../apiexamples/database_task_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DatabaseTask" } }, "examples": { "database_task_map": { "description": "database_task_map", "$ref": "../apiexamples/database_task_map_json" } } } }, "description": "Default response for the operation 'getDatabaseTasks'." } } } }, "/channels/{channelId}/_deploy": { "post": { "tags": [ "Channel Deployment Operations" ], "summary": "Deploys (or redeploys) a single channel.", "operationId": "deployChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to deploy.", "required": true, "schema": { "type": "string" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } }, { "name": "debugOptions", "in": "query", "description": "If present, the channel will deploy in debug mode and use these options. The input should be a comma-separated list of 't' and 'f' values that indicate whether to debug Deploy/Undeploy/Preprocessor/Postprocessor scripts, Attachment/Batch scripts, Source Connectors scripts, Source Filter/Transformer scripts, Destination Filter/Transformer scripts, Destination Connector scripts, and Destination Response Transformer scripts, in that order. Example: \"f,f,f,f,f,f,f\")", "schema": { "type": "string" }, "example": "f,f,f,f,f,f,f" } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/_undeploy": { "post": { "tags": [ "Channel Deployment Operations" ], "summary": "Undeploys a single channel.", "operationId": "undeployChannel", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel to undeploy.", "required": true, "schema": { "type": "string" } }, { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_deploy": { "post": { "tags": [ "Channel Deployment Operations" ], "summary": "Deploys (or redeploys) selected channels.", "operationId": "deployChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The ID of the channel(s) to deploy. If absent, all channels will be deployed.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channel_set": { "description": "channel_set", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channel_set": { "description": "channel_set", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_undeploy": { "post": { "tags": [ "Channel Deployment Operations" ], "summary": "Undeploys selected channels.", "operationId": "undeployChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The IDs of the channels to retrieve. If absent, all channels will be retrieved.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channel_set": { "description": "channel_set", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channel_set": { "description": "channel_set", "$ref": "../apiexamples/guid_set_json" } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_redeployAll": { "post": { "tags": [ "Channel Deployment Operations" ], "summary": "Redeploys all channels.", "operationId": "redeployAllChannels", "parameters": [ { "name": "returnErrors", "in": "query", "description": "If true, an error response code and the exception will be returned.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/events/{eventId}": { "get": { "tags": [ "Events" ], "summary": "Retrieves an event by ID.", "operationId": "getEvent", "parameters": [ { "name": "eventId", "in": "path", "description": "The ID of the event.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ServerEvent" }, "examples": { "serverEvent": { "description": "serverEvent", "$ref": "../apiexamples/server_event_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServerEvent" }, "examples": { "serverEvent": { "description": "serverEvent", "$ref": "../apiexamples/server_event_json" } } } }, "description": "Default response for the operation 'getEvent'." } } } }, "/events/maxEventId": { "get": { "tags": [ "Events" ], "summary": "Returns the maximum event ID currently in the database.", "operationId": "getMaxEventId", "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/plain": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/events/_search": { "post": { "tags": [ "Events" ], "summary": "Search for events by specific filter criteria.", "operationId": "getEvents", "parameters": [ { "name": "offset", "in": "query", "description": "Used for pagination, determines where to start in the search results.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Used for pagination, determines the maximum number of results to return.", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "requestBody": { "description": "The EventFilter object to use to query events by.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/EventFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/event_filter_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/event_filter_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerEvent" } }, "examples": { "serverEventList": { "description": "serverEventList", "$ref": "../apiexamples/server_event_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerEvent" } }, "examples": { "serverEventList": { "description": "serverEventList", "$ref": "../apiexamples/server_event_list_json" } } } }, "description": "Default response for the operation 'getEvents'." } } } }, "/events": { "get": { "tags": [ "Events" ], "summary": "Search for events by specific filter criteria.", "operationId": "getEvents_1", "parameters": [ { "name": "maxEventId", "in": "query", "description": "The maximum event ID to query.", "schema": { "type": "integer", "format": "int32" } }, { "name": "minEventId", "in": "query", "description": "The minimum event ID to query.", "schema": { "type": "integer", "format": "int32" } }, { "name": "level", "in": "query", "description": "The type of events to query.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "INFORMATION", "WARNING", "ERROR" ] } } }, { "name": "startDate", "in": "query", "description": "The earliest event date to query by. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The latest event date to query by. Example: 2015-10-21T07:28:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "name", "in": "query", "description": "Searches the event name for this string.", "schema": { "type": "string" } }, { "name": "outcome", "in": "query", "description": "Searches on whether the event outcome was successful or not.", "schema": { "type": "string", "enum": [ "SUCCESS", "FAILURE" ] } }, { "name": "userId", "in": "query", "description": "The user ID to query events by.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeSearch", "in": "query", "description": "Searches the attributes for this string.", "schema": { "type": "string" } }, { "name": "ipAddress", "in": "query", "description": "The IP address that originated the event.", "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "description": "The ID of the server that the event was created from.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Used for pagination, determines where to start in the search results.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Used for pagination, determines the maximum number of results to return.", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerEvent" } }, "examples": { "serverEventList": { "description": "serverEventList", "$ref": "../apiexamples/server_event_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerEvent" } }, "examples": { "serverEventList": { "description": "serverEventList", "$ref": "../apiexamples/server_event_list_json" } } } }, "description": "Default response for the operation 'getEvents_1'." } } } }, "/events/count": { "get": { "tags": [ "Events" ], "summary": "Count number for events by specific filter criteria.", "operationId": "getEventCount", "parameters": [ { "name": "maxEventId", "in": "query", "description": "The maximum event ID to query.", "schema": { "type": "integer", "format": "int32" } }, { "name": "minEventId", "in": "query", "description": "The minimum event ID to query.", "schema": { "type": "integer", "format": "int32" } }, { "name": "level", "in": "query", "description": "The type of events to query.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "INFORMATION", "WARNING", "ERROR" ] } } }, { "name": "startDate", "in": "query", "description": "The earliest event date to query by. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The latest event date to query by. Example: 2015-10-21T07:28:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "name", "in": "query", "description": "Searches the event name for this string.", "schema": { "type": "string" } }, { "name": "outcome", "in": "query", "description": "Searches on whether the event outcome was successful or not.", "schema": { "type": "string", "enum": [ "SUCCESS", "FAILURE" ] } }, { "name": "userId", "in": "query", "description": "The user ID to query events by.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeSearch", "in": "query", "description": "Searches the attributes for this string.", "schema": { "type": "string" } }, { "name": "ipAddress", "in": "query", "description": "The IP address that originated the event.", "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "description": "The ID of the server that the event was created from.", "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } }, "text/plain": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/events/count/_search": { "post": { "tags": [ "Events" ], "summary": "Count number for events by specific filter criteria.", "operationId": "getEventCount_1", "requestBody": { "description": "The EventFilter object to use to query events by.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/EventFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/event_filter_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/event_filter_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } }, "text/plain": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/events/_export": { "post": { "tags": [ "Events" ], "summary": "Exports all events to the application data directory on the server.", "operationId": "exportAllEvents", "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/extensions/_uninstall": { "post": { "tags": [ "Extensions" ], "summary": "Uninstalls an extension.", "operationId": "uninstallExtension", "requestBody": { "description": "The path attribute of the extension to uninstall.", "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "extensionPath": { "description": "extensionPath", "value": "/path/to/extension" } } }, "application/json": { "schema": { "type": "string" }, "examples": { "extensionPath": { "description": "extensionPath", "value": "/path/to/extension" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/{extensionName}": { "get": { "tags": [ "Extensions" ], "summary": "Returns extension metadata by name.", "operationId": "getExtensionMetaData", "parameters": [ { "name": "extensionName", "in": "path", "description": "The name of the extension to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MetaData" }, "examples": { "metadata": { "description": "metadata", "$ref": "../apiexamples/connector_metadata_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaData" }, "examples": { "metadata": { "description": "metadata", "$ref": "../apiexamples/connector_metadata_json" } } } }, "description": "Default response for the operation 'getExtensionMetaData'." } } } }, "/extensions/_install": { "post": { "tags": [ "Extensions" ], "summary": "Installs an extension.", "operationId": "installExtension", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "The extension file to upload.", "format": "binary" } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/connectors": { "get": { "tags": [ "Extensions" ], "summary": "Returns all active connector metadata.", "operationId": "getConnectorMetaData", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectorMetaData" } }, "examples": { "connectorMetaDataMap": { "description": "connectorMetaDataMap", "$ref": "../apiexamples/connector_metadata_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectorMetaData" } }, "examples": { "connectorMetaDataMap": { "description": "connectorMetaDataMap", "$ref": "../apiexamples/connector_metadata_map_json" } } } }, "description": "Default response for the operation 'getConnectorMetaData'." } } } }, "/extensions/plugins": { "get": { "tags": [ "Extensions" ], "summary": "Returns all active plugin metadata.", "operationId": "getPluginMetaData", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PluginMetaData" } }, "examples": { "pluginMetaData": { "description": "pluginMetaData", "$ref": "../apiexamples/plugin_metadata_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PluginMetaData" } }, "examples": { "pluginMetaData": { "description": "pluginMetaData", "$ref": "../apiexamples/plugin_metadata_map_json" } } } }, "description": "Default response for the operation 'getPluginMetaData'." } } } }, "/extensions/{extensionName}/properties": { "get": { "tags": [ "Extensions" ], "summary": "Returns filtered properties for a specified extension.", "operationId": "getPluginProperties", "parameters": [ { "name": "extensionName", "in": "path", "description": "The name of the extension to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "propertyKeys", "in": "query", "description": "The set of properties to retrieve.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_json" } } } }, "description": "Default response for the operation 'getPluginProperties'." } } }, "put": { "tags": [ "Extensions" ], "summary": "Sets properties for a specified extension.", "operationId": "setPluginProperties", "parameters": [ { "name": "extensionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mergeProperties", "in": "query", "description": "Merge or replace properties. Defaults to replace.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "description", "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_xml" } } }, "application/json": { "schema": { "type": "string" }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_json" } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/extensions/{extensionName}/enabled": { "get": { "tags": [ "Extensions" ], "summary": "Returns the enabled status of an extension.", "operationId": "isExtensionEnabled", "parameters": [ { "name": "extensionName", "in": "path", "description": "The name of the extension to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "boolean" }, "examples": { "extensionEnabled": { "description": "extensionEnabled", "$ref": "../apiexamples/boolean_xml" } } }, "application/json": { "schema": { "type": "boolean" }, "examples": { "extensionEnabled": { "description": "extensionEnabled", "$ref": "../apiexamples/boolean_json" } } } }, "description": "Default response for the operation 'isExtensionEnabled'." } } } }, "/extensions/{extensionName}/_setEnabled": { "post": { "tags": [ "Extensions" ], "summary": "Enables or disables an extension.", "operationId": "setExtensionEnabled", "parameters": [ { "name": "extensionName", "in": "path", "description": "The name of the extension to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "description": "The new enabled status to set.", "required": true, "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/_export": { "post": { "tags": [ "Messages" ], "summary": "Exports messages into a specific directory path accessible by the server.", "operationId": "exportMessagesServer", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "minMessageId", "in": "query", "description": "The minimum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxMessageId", "in": "query", "description": "The maximum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minOriginalId", "in": "query", "description": "The minimum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxOriginalId", "in": "query", "description": "The maximum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minImportId", "in": "query", "description": "The minimum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxImportId", "in": "query", "description": "The maximum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "startDate", "in": "query", "description": "The earliest original received date to query by. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The latest original received date to query by. Example: 2015-10-21T07:28:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "textSearch", "in": "query", "description": "Searches all message content for this string. This process could take a long time depending on the amount of message content currently stored. Any message content that was encrypted by this channel will not be searchable.", "schema": { "type": "string" } }, { "name": "textSearchRegex", "in": "query", "description": "If true, text search input will be considered a regular expression pattern to be matched. Only supported by PostgreSQL, MySQL and Oracle databases.", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Determines which message statuses to query by.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "FILTERED", "TRANSFORMED", "SENT", "QUEUED", "ERROR", "PENDING" ] } } }, { "name": "includedMetaDataId", "in": "query", "description": "If present, only connector metadata IDs in this list will be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "excludedMetaDataId", "in": "query", "description": "If present, connector metadata IDs in this list will not be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "serverId", "in": "query", "description": "The server ID associated with messages.", "schema": { "type": "string" } }, { "name": "rawContentSearch", "in": "query", "description": "Searches the raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedRawContentSearch", "in": "query", "description": "Searches the processed raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "transformedContentSearch", "in": "query", "description": "Searches the transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "encodedContentSearch", "in": "query", "description": "Searches the encoded content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sentContentSearch", "in": "query", "description": "Searches the sent content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseContentSearch", "in": "query", "description": "Searches the response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseTransformedContentSearch", "in": "query", "description": "Searches the response transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedResponseContentSearch", "in": "query", "description": "Searches the processed response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "connectorMapContentSearch", "in": "query", "description": "Searches the connector map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "channelMapContentSearch", "in": "query", "description": "Searches the channel map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sourceMapContentSearch", "in": "query", "description": "Searches the source map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseMapContentSearch", "in": "query", "description": "Searches the response map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processingErrorContentSearch", "in": "query", "description": "Searches the processing error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "postprocessorErrorContentSearch", "in": "query", "description": "Searches the postprocessor error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseErrorContentSearch", "in": "query", "description": "Searches the response error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "metaDataSearch", "in": "query", "description": "Searches a custom metadata column. Value should be in the form: COLUMN_NAME <operator> value, where operator is one of the following: =, !=, <, <=, >, >=, CONTAINS, DOES NOT CONTAIN, STARTS WITH, DOES NOT START WITH, ENDS WITH, DOES NOT END WITH", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "metaDataCaseInsensitiveSearch", "in": "query", "description": "Searches a custom metadata column, ignoring case. Value should be in the form: COLUMN_NAME <operator> value.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "textSearchMetaDataColumn", "in": "query", "description": "When using a text search, these custom metadata columns will also be searched.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "minSendAttempts", "in": "query", "description": "The minimum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxSendAttempts", "in": "query", "description": "The maximum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attachment", "in": "query", "description": "If true, only messages with attachments are included in the results.", "schema": { "type": "boolean" } }, { "name": "error", "in": "query", "description": "If true, only messages with errors are included in the results.", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "description": "The maximum number of messages that will be queried at a time. Default Value: 100", "schema": { "type": "integer", "format": "int32" } }, { "name": "contentType", "in": "query", "description": "The ContentType that will be extracted from the message for writing. If null or not provided, the entire message will be written in serialized format.", "schema": { "type": "string", "enum": [ "Raw", "Processed Raw", "Transformed", "Encoded", "Sent", "Response", "Response Transformed", "Processed Response", "Connector Map", "Channel Map", "Response Map", "Processing Error", "Postprocessor Error", "Response Error", "Source Map" ] } }, { "name": "destinationContent", "in": "query", "description": "If true, the content to write will be extracted from the destination message(s), rather than the source message.", "schema": { "type": "boolean", "default": false } }, { "name": "encrypt", "in": "query", "description": "If true, message content will be encrypted before writing.", "schema": { "type": "boolean", "default": false } }, { "name": "includeAttachments", "in": "query", "description": "Determines whether attachments will be included with messages.", "schema": { "type": "boolean", "default": false } }, { "name": "baseFolder", "in": "query", "description": "The base directory to use when resolving relative paths in the root folder.", "schema": { "type": "string" } }, { "name": "rootFolder", "in": "query", "description": "The root folder to contain the written messages/sub-folders.", "required": true, "schema": { "type": "string" } }, { "name": "filePattern", "in": "query", "description": "A string defining the folder/filename(s) for writing messages. It may contain variables to be replaced.", "required": true, "schema": { "type": "string" } }, { "name": "archiveFileName", "in": "query", "description": "The file name to use for archive exports.", "schema": { "type": "string" } }, { "name": "archiveFormat", "in": "query", "description": "The archiver format to use to archive messages/folders that are written to the root folder. Valid values: zip, tar", "schema": { "type": "string" } }, { "name": "compressFormat", "in": "query", "description": "The compressor format to use to compress the archive file. Only valid when using the TAR archive format. Valid values: gz, bzip2", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The password used to protect the archive file. Only valid when using the ZIP archive format.", "schema": { "type": "string" } }, { "name": "encryptionType", "in": "query", "description": "The algorithm used to encrypt the password-protected archive file. Only valid when using the ZIP archive format. Valid values: STANDARD, AES128, AES256", "schema": { "type": "string", "enum": [ "STANDARD", "AES128", "AES256" ] } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/channels/{channelId}/messages/_exportUsingFilter": { "post": { "tags": [ "Messages" ], "summary": "Exports messages into a specific directory path accessible by the server. (\"Try it out\" doesn't work for this endpoint, but the descriptions are valid. Please use another tool for testing.)", "operationId": "exportMessagesServer_1", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The maximum number of messages that will be queried at a time.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "filter" ], "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/MessageFilter" }, "writerOptions": { "$ref": "#/components/schemas/MessageWriterOptions" } } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/channels/{channelId}/messages/_reprocessWithFilter": { "post": { "tags": [ "Messages" ], "summary": "Reprocesses messages through a channel filtering with a MessageFilter.", "operationId": "reprocessMessages", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "replace", "in": "query", "description": "If true, the message will overwrite the current one", "schema": { "type": "boolean", "default": false } }, { "name": "filterDestinations", "in": "query", "description": "If true, the metaDataId parameter will be used to determine which destinations to reprocess the message through.", "schema": { "type": "boolean", "default": false } }, { "name": "metaDataId", "in": "query", "description": "Indicates which destinations to send the message to.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "The MessageFilter object to use to query messages by.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/_reprocess": { "post": { "tags": [ "Messages" ], "summary": "Reprocesses messages through a channel by specific filter criteria.", "operationId": "reprocessMessages_1", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "minMessageId", "in": "query", "description": "The minimum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxMessageId", "in": "query", "description": "The maximum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minOriginalId", "in": "query", "description": "The minimum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxOriginalId", "in": "query", "description": "The maximum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minImportId", "in": "query", "description": "The minimum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxImportId", "in": "query", "description": "The maximum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "startDate", "in": "query", "description": "The earliest original received date to query by. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The latest original received date to query by. Example: 2015-10-21T07:28:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "textSearch", "in": "query", "description": "Searches all message content for this string. This process could take a long time depending on the amount of message content currently stored. Any message content that was encrypted by this channel will not be searchable.", "schema": { "type": "string" } }, { "name": "textSearchRegex", "in": "query", "description": "If true, text search input will be considered a regular expression pattern to be matched. Only supported by PostgreSQL, MySQL and Oracle databases.", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Determines which message statuses to query by.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "FILTERED", "TRANSFORMED", "SENT", "QUEUED", "ERROR", "PENDING" ] } } }, { "name": "includedMetaDataId", "in": "query", "description": "If present, only connector metadata IDs in this list will be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "excludedMetaDataId", "in": "query", "description": "If present, connector metadata IDs in this list will not be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "serverId", "in": "query", "description": "The server ID associated with messages.", "schema": { "type": "string" } }, { "name": "rawContentSearch", "in": "query", "description": "Searches the raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedRawContentSearch", "in": "query", "description": "Searches the processed raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "transformedContentSearch", "in": "query", "description": "Searches the transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "encodedContentSearch", "in": "query", "description": "Searches the encoded content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sentContentSearch", "in": "query", "description": "Searches the sent content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseContentSearch", "in": "query", "description": "Searches the response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseTransformedContentSearch", "in": "query", "description": "Searches the response transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedResponseContentSearch", "in": "query", "description": "Searches the processed response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "connectorMapContentSearch", "in": "query", "description": "Searches the connector map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "channelMapContentSearch", "in": "query", "description": "Searches the channel map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sourceMapContentSearch", "in": "query", "description": "Searches the source map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseMapContentSearch", "in": "query", "description": "Searches the response map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processingErrorContentSearch", "in": "query", "description": "Searches the processing error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "postprocessorErrorContentSearch", "in": "query", "description": "Searches the postprocessor error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseErrorContentSearch", "in": "query", "description": "Searches the response error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "metaDataSearch", "in": "query", "description": "Searches a custom metadata column. Value should be in the form: COLUMN_NAME <operator> value, where operator is one of the following: =, !=, <, <=, >, >=, CONTAINS, DOES NOT CONTAIN, STARTS WITH, DOES NOT START WITH, ENDS WITH, DOES NOT END WITH", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "metaDataCaseInsensitiveSearch", "in": "query", "description": "Searches a custom metadata column, ignoring case. Value should be in the form: COLUMN_NAME <operator> value.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "textSearchMetaDataColumn", "in": "query", "description": "When using a text search, these custom metadata columns will also be searched.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "minSendAttempts", "in": "query", "description": "The minimum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxSendAttempts", "in": "query", "description": "The maximum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attachment", "in": "query", "description": "If true, only messages with attachments are included in the results.", "schema": { "type": "boolean" } }, { "name": "error", "in": "query", "description": "If true, only messages with errors are included in the results.", "schema": { "type": "boolean" } }, { "name": "replace", "in": "query", "description": "If true, the message will overwrite the current one", "schema": { "type": "boolean", "default": false } }, { "name": "filterDestinations", "in": "query", "description": "If true, the metaDataId parameter will be used to determine which destinations to reprocess the message through.", "schema": { "type": "boolean", "default": false } }, { "name": "metaDataId", "in": "query", "description": "Indicates which destinations to send the message to.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages": { "get": { "tags": [ "Messages" ], "summary": "Search for messages by specific filter criteria.", "operationId": "getMessages", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "minMessageId", "in": "query", "description": "The minimum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxMessageId", "in": "query", "description": "The maximum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minOriginalId", "in": "query", "description": "The minimum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxOriginalId", "in": "query", "description": "The maximum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minImportId", "in": "query", "description": "The minimum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxImportId", "in": "query", "description": "The maximum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "startDate", "in": "query", "description": "The earliest original received date to query by. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The latest original received date to query by. Example: 2015-10-21T07:28:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "textSearch", "in": "query", "description": "Searches all message content for this string. This process could take a long time depending on the amount of message content currently stored. Any message content that was encrypted by this channel will not be searchable.", "schema": { "type": "string" } }, { "name": "textSearchRegex", "in": "query", "description": "If true, text search input will be considered a regular expression pattern to be matched. Only supported by PostgreSQL, MySQL and Oracle databases.", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Determines which message statuses to query by.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "FILTERED", "TRANSFORMED", "SENT", "QUEUED", "ERROR", "PENDING" ] } } }, { "name": "includedMetaDataId", "in": "query", "description": "If present, only connector metadata IDs in this list will be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "excludedMetaDataId", "in": "query", "description": "If present, connector metadata IDs in this list will not be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "serverId", "in": "query", "description": "The server ID associated with messages.", "schema": { "type": "string" } }, { "name": "rawContentSearch", "in": "query", "description": "Searches the raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedRawContentSearch", "in": "query", "description": "Searches the processed raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "transformedContentSearch", "in": "query", "description": "Searches the transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "encodedContentSearch", "in": "query", "description": "Searches the encoded content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sentContentSearch", "in": "query", "description": "Searches the sent content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseContentSearch", "in": "query", "description": "Searches the response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseTransformedContentSearch", "in": "query", "description": "Searches the response transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedResponseContentSearch", "in": "query", "description": "Searches the processed response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "connectorMapContentSearch", "in": "query", "description": "Searches the connector map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "channelMapContentSearch", "in": "query", "description": "Searches the channel map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sourceMapContentSearch", "in": "query", "description": "Searches the source map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseMapContentSearch", "in": "query", "description": "Searches the response map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processingErrorContentSearch", "in": "query", "description": "Searches the processing error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "postprocessorErrorContentSearch", "in": "query", "description": "Searches the postprocessor error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseErrorContentSearch", "in": "query", "description": "Searches the response error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "metaDataSearch", "in": "query", "description": "Searches a custom metadata column. Value should be in the form: COLUMN_NAME <operator> value, where operator is one of the following: =, !=, <, <=, >, >=, CONTAINS, DOES NOT CONTAIN, STARTS WITH, DOES NOT START WITH, ENDS WITH, DOES NOT END WITH", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "metaDataCaseInsensitiveSearch", "in": "query", "description": "Searches a custom metadata column, ignoring case. Value should be in the form: COLUMN_NAME <operator> value.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "textSearchMetaDataColumn", "in": "query", "description": "When using a text search, these custom metadata columns will also be searched.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "minSendAttempts", "in": "query", "description": "The minimum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxSendAttempts", "in": "query", "description": "The maximum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attachment", "in": "query", "description": "If true, only messages with attachments are included in the results.", "schema": { "type": "boolean" } }, { "name": "error", "in": "query", "description": "If true, only messages with errors are included in the results.", "schema": { "type": "boolean" } }, { "name": "includeContent", "in": "query", "description": "If true, message content will be returned with the results.", "schema": { "type": "boolean", "default": false } }, { "name": "offset", "in": "query", "description": "Used for pagination, determines where to start in the search results.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Used for pagination, determines the maximum number of results to return.", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "examples": { "messages": { "description": "messages", "$ref": "../apiexamples/message_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "examples": { "messages": { "description": "messages", "$ref": "../apiexamples/message_list_json" } } } }, "description": "Default response for the operation 'getMessages'." } } }, "post": { "tags": [ "Messages" ], "summary": "Processes a new message through a channel.", "operationId": "processMessage", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "destinationMetaDataId", "in": "query", "description": "Indicates which destinations to send the message to.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "sourceMapEntry", "in": "query", "description": "These entries will be injected into the source map for the message. Value should be in the format: key=value", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "overwrite", "in": "query", "description": "If true and a valid original message ID is given, this message will overwrite the existing one.", "schema": { "type": "boolean" } }, { "name": "imported", "in": "query", "description": "If true, marks this message as being imported. If the message is overwriting an existing one, then statistics will not be decremented.", "schema": { "type": "boolean" } }, { "name": "originalMessageId", "in": "query", "description": "The original message ID this message is associated with.", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "The raw message data to process.", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "integer", "format": "int64" }, "examples": { "long": { "description": "long", "$ref": "../apiexamples/long_xml" } } }, "application/json": { "schema": { "type": "integer", "format": "int64" }, "examples": { "long": { "description": "long", "$ref": "../apiexamples/long_json" } } } }, "description": "Default response for the operation 'processMessage'." } } }, "delete": { "tags": [ "Messages" ], "summary": "Remove messages by specific filter criteria.", "operationId": "removeMessages", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "minMessageId", "in": "query", "description": "The minimum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxMessageId", "in": "query", "description": "The maximum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minOriginalId", "in": "query", "description": "The minimum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxOriginalId", "in": "query", "description": "The maximum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minImportId", "in": "query", "description": "The minimum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxImportId", "in": "query", "description": "The maximum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "startDate", "in": "query", "description": "The earliest original received date to query by. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The latest original received date to query by. Example: 2015-10-21T07:28:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "textSearch", "in": "query", "description": "Searches all message content for this string. This process could take a long time depending on the amount of message content currently stored. Any message content that was encrypted by this channel will not be searchable.", "schema": { "type": "string" } }, { "name": "textSearchRegex", "in": "query", "description": "If true, text search input will be considered a regular expression pattern to be matched. Only supported by PostgreSQL, MySQL and Oracle databases.", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Determines which message statuses to query by.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "FILTERED", "TRANSFORMED", "SENT", "QUEUED", "ERROR", "PENDING" ] } } }, { "name": "includedMetaDataId", "in": "query", "description": "If present, only connector metadata IDs in this list will be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "excludedMetaDataId", "in": "query", "description": "If present, connector metadata IDs in this list will not be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "serverId", "in": "query", "description": "The server ID associated with messages.", "schema": { "type": "string" } }, { "name": "rawContentSearch", "in": "query", "description": "Searches the raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedRawContentSearch", "in": "query", "description": "Searches the processed raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "transformedContentSearch", "in": "query", "description": "Searches the transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "encodedContentSearch", "in": "query", "description": "Searches the encoded content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sentContentSearch", "in": "query", "description": "Searches the sent content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseContentSearch", "in": "query", "description": "Searches the response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseTransformedContentSearch", "in": "query", "description": "Searches the response transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedResponseContentSearch", "in": "query", "description": "Searches the processed response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "connectorMapContentSearch", "in": "query", "description": "Searches the connector map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "channelMapContentSearch", "in": "query", "description": "Searches the channel map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sourceMapContentSearch", "in": "query", "description": "Searches the source map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseMapContentSearch", "in": "query", "description": "Searches the response map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processingErrorContentSearch", "in": "query", "description": "Searches the processing error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "postprocessorErrorContentSearch", "in": "query", "description": "Searches the postprocessor error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseErrorContentSearch", "in": "query", "description": "Searches the response error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "metaDataSearch", "in": "query", "description": "Searches a custom metadata column. Value should be in the form: COLUMN_NAME <operator> value, where operator is one of the following: =, !=, <, <=, >, >=, CONTAINS, DOES NOT CONTAIN, STARTS WITH, DOES NOT START WITH, ENDS WITH, DOES NOT END WITH", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "metaDataCaseInsensitiveSearch", "in": "query", "description": "Searches a custom metadata column, ignoring case. Value should be in the form: COLUMN_NAME <operator> value.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "textSearchMetaDataColumn", "in": "query", "description": "When using a text search, these custom metadata columns will also be searched.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "minSendAttempts", "in": "query", "description": "The minimum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxSendAttempts", "in": "query", "description": "The maximum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attachment", "in": "query", "description": "If true, only messages with attachments are included in the results.", "schema": { "type": "boolean" } }, { "name": "error", "in": "query", "description": "If true, only messages with errors are included in the results.", "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/_search": { "post": { "tags": [ "Messages" ], "summary": "Search for messages by specific filter criteria.", "operationId": "getMessages_1", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "includeContent", "in": "query", "description": "If true, message content will be returned with the results.", "schema": { "type": "boolean", "default": false } }, { "name": "offset", "in": "query", "description": "Used for pagination, determines where to start in the search results.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Used for pagination, determines the maximum number of results to return.", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "requestBody": { "description": "The MessageFilter object to use to query messages by.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "examples": { "messages": { "description": "messages", "$ref": "../apiexamples/message_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "examples": { "messages": { "description": "messages", "$ref": "../apiexamples/message_list_json" } } } }, "description": "Default response for the operation 'getMessages_1'." } } } }, "/channels/{channelId}/messages/{messageId}/attachments": { "get": { "tags": [ "Messages" ], "summary": "Retrieve a list of attachments by message ID.", "operationId": "getAttachmentsByMessageId", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "description": "The ID of the message.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "includeContent", "in": "query", "description": "If false, only the attachment ID and type will be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "examples": { "attachmentList": { "description": "attachmentList", "$ref": "../apiexamples/attachment_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "examples": { "attachmentList": { "description": "attachmentList", "$ref": "../apiexamples/attachment_list_json" } } } }, "description": "Default response for the operation 'getAttachmentsByMessageId'." } } } }, "/channels/{channelId}/messages/{messageId}/_getDICOMMessage": { "post": { "tags": [ "Messages" ], "summary": "Given a ConnectorMessage object, reattaches any DICOM attachment data and returns the raw Base64 encoded message data.", "operationId": "getDICOMMessage", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "description": "The ID of the message.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "The ConnectorMessage to retrieve DICOM data for.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorMessage" }, "examples": { "connectorMessage": { "description": "connectorMessage", "$ref": "../apiexamples/connector_message_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorMessage" }, "examples": { "connectorMessage": { "description": "connectorMessage", "$ref": "../apiexamples/connector_message_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/channels/{channelId}/messages/count/_search": { "post": { "tags": [ "Messages" ], "summary": "Count number for messages by specific filter criteria.", "operationId": "getMessageCount", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The MessageFilter object to use to query messages by.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "integer", "format": "int64" }, "examples": { "messageCount": { "description": "messageCount", "$ref": "../apiexamples/long_xml" } } }, "application/json": { "schema": { "type": "integer", "format": "int64" }, "examples": { "messageCount": { "description": "messageCount", "$ref": "../apiexamples/long_json" } } } }, "description": "Default response for the operation 'getMessageCount'." } } } }, "/channels/{channelId}/messages/count": { "get": { "tags": [ "Messages" ], "summary": "Count number for messages by specific filter criteria.", "operationId": "getMessageCount_1", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "minMessageId", "in": "query", "description": "The minimum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxMessageId", "in": "query", "description": "The maximum message ID to query.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minOriginalId", "in": "query", "description": "The minimum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxOriginalId", "in": "query", "description": "The maximum original message ID to query. Messages that have been reprocessed will retain their original message ID.", "schema": { "type": "integer", "format": "int64" } }, { "name": "minImportId", "in": "query", "description": "The minimum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "maxImportId", "in": "query", "description": "The maximum import message ID to query. Messages that have been imported will retain their original message ID under this value.", "schema": { "type": "integer", "format": "int64" } }, { "name": "startDate", "in": "query", "description": "The earliest original received date to query by. Example: 1985-10-26T09:00:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "The latest original received date to query by. Example: 2015-10-21T07:28:00.000-0700", "schema": { "type": "string", "format": "date-time" } }, { "name": "textSearch", "in": "query", "description": "Searches all message content for this string. This process could take a long time depending on the amount of message content currently stored. Any message content that was encrypted by this channel will not be searchable.", "schema": { "type": "string" } }, { "name": "textSearchRegex", "in": "query", "description": "If true, text search input will be considered a regular expression pattern to be matched. Only supported by PostgreSQL, MySQL and Oracle databases.", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Determines which message statuses to query by.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "FILTERED", "TRANSFORMED", "SENT", "QUEUED", "ERROR", "PENDING" ] } } }, { "name": "includedMetaDataId", "in": "query", "description": "If present, only connector metadata IDs in this list will be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "excludedMetaDataId", "in": "query", "description": "If present, connector metadata IDs in this list will not be queried.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "serverId", "in": "query", "description": "The server ID associated with messages.", "schema": { "type": "string" } }, { "name": "rawContentSearch", "in": "query", "description": "Searches the raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedRawContentSearch", "in": "query", "description": "Searches the processed raw content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "transformedContentSearch", "in": "query", "description": "Searches the transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "encodedContentSearch", "in": "query", "description": "Searches the encoded content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sentContentSearch", "in": "query", "description": "Searches the sent content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseContentSearch", "in": "query", "description": "Searches the response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseTransformedContentSearch", "in": "query", "description": "Searches the response transformed content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processedResponseContentSearch", "in": "query", "description": "Searches the processed response content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "connectorMapContentSearch", "in": "query", "description": "Searches the connector map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "channelMapContentSearch", "in": "query", "description": "Searches the channel map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sourceMapContentSearch", "in": "query", "description": "Searches the source map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseMapContentSearch", "in": "query", "description": "Searches the response map content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "processingErrorContentSearch", "in": "query", "description": "Searches the processing error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "postprocessorErrorContentSearch", "in": "query", "description": "Searches the postprocessor error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "responseErrorContentSearch", "in": "query", "description": "Searches the response error content of messages.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "metaDataSearch", "in": "query", "description": "Searches a custom metadata column. Value should be in the form: COLUMN_NAME <operator> value, where operator is one of the following: =, !=, <, <=, >, >=, CONTAINS, DOES NOT CONTAIN, STARTS WITH, DOES NOT START WITH, ENDS WITH, DOES NOT END WITH", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "metaDataCaseInsensitiveSearch", "in": "query", "description": "Searches a custom metadata column, ignoring case. Value should be in the form: COLUMN_NAME <operator> value.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearch" } } }, { "name": "textSearchMetaDataColumn", "in": "query", "description": "When using a text search, these custom metadata columns will also be searched.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "minSendAttempts", "in": "query", "description": "The minimum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxSendAttempts", "in": "query", "description": "The maximum number of send attempts for connector messages.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attachment", "in": "query", "description": "If true, only messages with attachments are included in the results.", "schema": { "type": "boolean" } }, { "name": "error", "in": "query", "description": "If true, only messages with errors are included in the results.", "schema": { "type": "boolean" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "integer", "format": "int64" }, "examples": { "messageCount": { "description": "messageCount", "$ref": "../apiexamples/long_xml" } } }, "application/json": { "schema": { "type": "integer", "format": "int64" }, "examples": { "messageCount": { "description": "messageCount", "$ref": "../apiexamples/long_json" } } } }, "description": "Default response for the operation 'getMessageCount_1'." } } } }, "/channels/{channelId}/messages/{messageId}/_reprocess": { "post": { "tags": [ "Messages" ], "summary": "Reprocesses and overwrites a single message.", "operationId": "reprocessMessage", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "description": "The ID of the message.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "replace", "in": "query", "description": "If true, the message will overwrite the current one", "schema": { "type": "boolean", "default": false } }, { "name": "filterDestinations", "in": "query", "description": "If true, the metaDataId parameter will be used to determine which destinations to reprocess the message through.", "schema": { "type": "boolean", "default": false } }, { "name": "metaDataId", "in": "query", "description": "Indicates which destinations to send the message to.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/{messageId}": { "get": { "tags": [ "Messages" ], "summary": "Retrieve a message by ID.", "operationId": "getMessageContent", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "description": "The ID of the message.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "metaDataId", "in": "query", "description": "The metadata IDs of the connectors.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Message" }, "examples": { "message": { "description": "message", "$ref": "../apiexamples/message_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Message" }, "examples": { "message": { "description": "message", "$ref": "../apiexamples/message_json" } } } }, "description": "Default response for the operation 'getMessageContent'." } } }, "delete": { "tags": [ "Messages" ], "summary": "Remove a single message by ID.", "operationId": "removeMessage", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "description": "The ID of the message.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "metaDataId", "in": "query", "description": "If present, only the specific connector message will be removed. If the metadata ID is 0, the entire message will be removed.", "schema": { "type": "integer", "format": "int32" } }, { "name": "patientId", "in": "query", "description": "The patient ID of the channel message.", "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_removeAllMessagesPost": { "post": { "tags": [ "Messages" ], "summary": "Removes all messages for multiple specified channels. This is a POST request alternative to DELETE /_removeAllMessages that may be used when there are too many channel IDs to include in the query parameters.", "operationId": "removeAllMessagesPost", "parameters": [ { "name": "restartRunningChannels", "in": "query", "description": "If true, currently running channels will be stopped and restarted as part of the remove process. Otherwise, currently running channels will not be included.", "schema": { "type": "boolean", "default": false } }, { "name": "clearStatistics", "in": "query", "description": "If true, message statistics will also be cleared.", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "description": "The IDs of the channels.", "content": { "application/xml": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_xml" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "channelIds": { "description": "channelIds", "$ref": "../apiexamples/guid_set_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/_import": { "post": { "tags": [ "Messages" ], "summary": "Imports a Message object into a channel. The message will not actually be processed through the channel, only imported.", "operationId": "importMessage", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The Message object to import.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Message" }, "examples": { "message": { "description": "message", "$ref": "../apiexamples/message_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Message" }, "examples": { "message": { "description": "message", "$ref": "../apiexamples/message_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/_importFromPath": { "post": { "tags": [ "Messages" ], "summary": "Imports messages into a channel from a path accessible by the server. The messages will not actually be processed through the channel, only imported.", "operationId": "importMessagesServer", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "includeSubfolders", "in": "query", "description": "If true, sub-folders will also be scanned recursively for messages.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The directory path on the server side to import messages from.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "path": { "description": "path", "value": "/path/to/message/directory" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MessageImportResult" }, "examples": { "messageImportResult": { "description": "messageImportResult", "$ref": "../apiexamples/message_import_result_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageImportResult" }, "examples": { "messageImportResult": { "description": "messageImportResult", "$ref": "../apiexamples/message_import_result_json" } } } }, "description": "Default response for the operation 'importMessagesServer'." } } } }, "/channels/{channelId}/messages/{messageId}/attachments/{attachmentId}/_export": { "post": { "tags": [ "Messages" ], "summary": "Exports a message attachment into a specific file path accessible by the server.", "operationId": "exportAttachmentServer", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "description": "The ID of the message.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "attachmentId", "in": "path", "description": "The ID of the attachment.", "required": true, "schema": { "type": "string" } }, { "name": "binary", "in": "query", "description": "Indicates that the attachment is binary and should be Base64 decoded before writing to file.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The file path to export the attachment to.", "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "filePath": { "description": "filePath", "value": "/path/to/file" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_auditAccessedPHIMessage": { "post": { "tags": [ "Messages" ], "summary": "Audit that the user has accessed a channel message that contains PHI.", "operationId": "auditAccessedPHIMessage", "requestBody": { "description": "The attributes map of the channel message.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_auditQueriedPHIMessage": { "post": { "tags": [ "Messages" ], "summary": "Audit that the user has queried the channel messages panel that contains PHI.", "operationId": "auditQueriedPHIMessage", "requestBody": { "description": "The attributes map of the channel messages filter.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messagesWithObj": { "post": { "tags": [ "Messages" ], "summary": "Processes a new message through a channel, using the RawMessage object.", "operationId": "processMessage_1", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The RawMessage object to process.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/RawMessage" }, "examples": { "rawMessage": { "description": "rawMessage", "$ref": "../apiexamples/raw_message_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/RawMessage" }, "examples": { "rawMessage": { "description": "rawMessage", "$ref": "../apiexamples/raw_message_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "integer", "format": "int64" }, "examples": { "long": { "description": "long", "$ref": "../apiexamples/long_xml" } } }, "application/json": { "schema": { "type": "integer", "format": "int64" }, "examples": { "long": { "description": "long", "$ref": "../apiexamples/long_json" } } } }, "description": "Default response for the operation 'processMessage_1'." } } } }, "/channels/{channelId}/messages/_remove": { "post": { "tags": [ "Messages" ], "summary": "Remove messages by specific filter criteria.", "operationId": "removeMessages_1", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The MessageFilter object to use to query messages by.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageFilter" }, "examples": { "filter": { "description": "filter", "$ref": "../apiexamples/message_filter_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/_removeAll": { "delete": { "tags": [ "Messages" ], "summary": "Removes all messages for the specified channel.", "operationId": "removeAllMessages", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "restartRunningChannels", "in": "query", "description": "If true, currently running channels will be stopped and restarted as part of the remove process. Otherwise, currently running channels will not be included.", "schema": { "type": "boolean", "default": false } }, { "name": "clearStatistics", "in": "query", "description": "If true, message statistics will also be cleared.", "schema": { "type": "boolean", "default": true } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/_removeAllMessages": { "delete": { "tags": [ "Messages" ], "summary": "Removes all messages for multiple specified channels.", "operationId": "removeAllMessages_1", "parameters": [ { "name": "channelId", "in": "query", "description": "The IDs of the channels.", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "restartRunningChannels", "in": "query", "description": "If true, currently running channels will be stopped and restarted as part of the remove process. Otherwise, currently running channels will not be included.", "schema": { "type": "boolean", "default": false } }, { "name": "clearStatistics", "in": "query", "description": "If true, message statistics will also be cleared.", "schema": { "type": "boolean", "default": true } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/channels/{channelId}/messages/maxMessageId": { "get": { "tags": [ "Messages" ], "summary": "Returns the maximum message ID for the given channel.", "operationId": "getMaxMessageId", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "integer", "format": "int64" }, "examples": { "messageId": { "description": "messageId", "$ref": "../apiexamples/long_xml" } } }, "application/json": { "schema": { "type": "integer", "format": "int64" }, "examples": { "messageId": { "description": "messageId", "$ref": "../apiexamples/long_json" } } } }, "description": "Default response for the operation 'getMaxMessageId'." } } } }, "/channels/{channelId}/messages/{messageId}/attachments/{attachmentId}": { "get": { "tags": [ "Messages" ], "summary": "Retrieve a message attachment by ID.", "operationId": "getAttachment", "parameters": [ { "name": "channelId", "in": "path", "description": "The ID of the channel.", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "description": "The ID of the message.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "attachmentId", "in": "path", "description": "The ID of the attachment.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": { "attachment": { "description": "attachment", "$ref": "../apiexamples/attachment_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": { "attachment": { "description": "attachment", "$ref": "../apiexamples/attachment_json" } } } }, "description": "Default response for the operation 'getAttachment'." } } } }, "/system/stats": { "get": { "tags": [ "System Information and Statistics" ], "summary": "Returns statistics for the underlying system.", "operationId": "getStats", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SystemStats" }, "examples": { "systemStats": { "description": "systemStats", "$ref": "../apiexamples/system_stats_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemStats" }, "examples": { "systemStats": { "description": "systemStats", "$ref": "../apiexamples/system_stats_json" } } } }, "description": "Default response for the operation 'getStats'." } } } }, "/system/info": { "get": { "tags": [ "System Information and Statistics" ], "summary": "Returns information about the underlying system.", "operationId": "getInfo", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SystemInfo" }, "examples": { "systemInfo": { "description": "systemInfo", "$ref": "../apiexamples/system_info_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemInfo" }, "examples": { "systemInfo": { "description": "systemInfo", "$ref": "../apiexamples/system_info_json" } } } }, "description": "Default response for the operation 'getInfo'." } } } }, "/usageData/_generate": { "post": { "tags": [ "Usage Data" ], "summary": "Generates usage document using data from both the client and server.", "operationId": "getUsageData", "requestBody": { "description": "The map of client usage data to use.", "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "examples": { "clientStats": { "description": "clientStats", "$ref": "../apiexamples/generic_map_xml" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "examples": { "clientStats": { "description": "clientStats", "$ref": "../apiexamples/generic_map_json" } } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "purgedDocument": { "description": "purgedDocument", "$ref": "../apiexamples/purged_document_xml" } } }, "application/json": { "schema": { "type": "string" }, "examples": { "purgedDocument": { "description": "purgedDocument", "$ref": "../apiexamples/purged_document_json" } } } }, "description": "Default response for the operation 'getUsageData'." } } } }, "/users/_login": { "post": { "tags": [ "Users" ], "summary": "Logs in to the Mirth Connect server using the specified name and password.", "operationId": "login", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "password", "username" ], "type": "object", "properties": { "username": { "type": "string", "default": "admin" }, "password": { "type": "string", "default": "admin" } } } } } }, "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/LoginStatus" }, "examples": { "loginStatus": { "description": "loginStatus", "$ref": "../apiexamples/login_status_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginStatus" }, "examples": { "loginStatus": { "description": "loginStatus", "$ref": "../apiexamples/login_status_json" } } } }, "description": "Default response for the operation 'login'." } } } }, "/users/_logout": { "post": { "tags": [ "Users" ], "summary": "Logs out of the server.", "operationId": "logout", "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/users/_inactivityLogout": { "post": { "tags": [ "Users" ], "summary": "User has been inactive and automatically logged out.", "operationId": "inactivityLogout", "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/users": { "get": { "tags": [ "Users" ], "summary": "Returns a List of all users.", "operationId": "getAllUsers", "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "examples": { "allUsers": { "description": "allUsers", "$ref": "../apiexamples/user_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "examples": { "allUsers": { "description": "allUsers", "$ref": "../apiexamples/user_list_json" } } } }, "description": "Default response for the operation 'getAllUsers'." } } }, "post": { "tags": [ "Users" ], "summary": "Creates a new user.", "operationId": "createUser", "requestBody": { "description": "The User object to create.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/new_user_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/new_user_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/users/current": { "get": { "tags": [ "Users" ], "summary": "Returns the current logged in user.", "operationId": "getCurrentUser", "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/user_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/user_json" } } } }, "description": "Default response for the operation 'getCurrentUser'." } } } }, "/users/_checkPassword": { "post": { "tags": [ "Users" ], "summary": "Checks the password against the configured password policies.", "operationId": "checkUserPassword", "requestBody": { "description": "The plaintext password to check.", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "passwordRequirementList": { "description": "passwordRequirementList", "$ref": "../apiexamples/password_requirement_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "passwordRequirementList": { "description": "passwordRequirementList", "$ref": "../apiexamples/password_requirement_list_json" } } } }, "description": "Default response for the operation 'checkUserPassword'." } } } }, "/users/{userId}/password": { "put": { "tags": [ "Users" ], "summary": "Updates a user's password.", "operationId": "updateUserPassword", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user to update the password for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The plaintext password to update with.", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "content": { "application/xml": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "passwordRequirementList": { "description": "passwordRequirementList", "$ref": "../apiexamples/password_requirement_list_xml" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "passwordRequirementList": { "description": "passwordRequirementList", "$ref": "../apiexamples/password_requirement_list_json" } } } }, "description": "Default response for the operation 'updateUserPassword'." } } } }, "/users/{userId}/notificationAcknowledged": { "post": { "tags": [ "Users" ], "summary": "User notification has been acknowledged.", "operationId": "setUserNotificationAcknowledged", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/users/{userId}": { "put": { "tags": [ "Users" ], "summary": "Updates a specified user.", "operationId": "updateUser", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user to update.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The User object to update.", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/user_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/user_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } }, "delete": { "tags": [ "Users" ], "summary": "Removes a specific user.", "operationId": "removeUser", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user to remove.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/users/{userIdOrName}": { "get": { "tags": [ "Users" ], "summary": "Returns a specific user by ID or username.", "operationId": "getUser", "parameters": [ { "name": "userIdOrName", "in": "path", "description": "The unique ID or username of the user to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/user_xml" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "user": { "description": "user", "$ref": "../apiexamples/user_json" } } } }, "description": "Default response for the operation 'getUser'." } } } }, "/users/{userId}/loggedIn": { "get": { "tags": [ "Users" ], "summary": "Returns a true if the specified user is logged in to the server.", "operationId": "isUserLoggedIn", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "default": { "content": { "application/xml": { "schema": { "type": "boolean" }, "examples": { "loggedIn": { "description": "loggedIn", "$ref": "../apiexamples/boolean_xml" } } }, "application/json": { "schema": { "type": "boolean" }, "examples": { "loggedIn": { "description": "loggedIn", "$ref": "../apiexamples/boolean_json" } } } }, "description": "Default response for the operation 'isUserLoggedIn'." } } } }, "/users/{userId}/preferences": { "get": { "tags": [ "Users" ], "summary": "Returns a Map of user preferences, optionally filtered by a set of property names.", "operationId": "getUserPreferences", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "An optional set of property names to filter by.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_xml" } } }, "application/json": { "schema": { "type": "string" }, "examples": { "propertiesObject": { "description": "propertiesObject", "$ref": "../apiexamples/properties_json" } } } }, "description": "Response for the operation 'getUserPreferences' with status code 200." }, "default": { "description": "Default response for the operation 'getUserPreferences'." } } }, "put": { "tags": [ "Users" ], "summary": "Updates multiple user preferences.", "operationId": "setUserPreferences", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The properties to update for the user.", "content": { "application/xml": { "schema": { "type": "string" }, "examples": { "properties": { "description": "properties", "$ref": "../apiexamples/properties_xml" } } }, "application/json": { "schema": { "type": "string" }, "examples": { "properties": { "description": "properties", "$ref": "../apiexamples/properties_json" } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } }, "/users/{userId}/preferences/{name}": { "get": { "tags": [ "Users" ], "summary": "Returns a specific user preference.", "operationId": "getUserPreference", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "description": "The name of the user property to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Users" ], "summary": "Updates a user preference.", "operationId": "setUserPreference", "parameters": [ { "name": "userId", "in": "path", "description": "The unique ID of the user.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "description": "The name of the user property to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The value to update the property with.", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/xml": {}, "application/json": {} } } } } } }, "components": { "schemas": { "ConnectionTestResponse": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SUCCESS", "TIME_OUT", "FAILURE" ] }, "message": { "type": "string" }, "connectionInfo": { "type": "string" } } }, "RequestCapabilityResponse": { "type": "object", "properties": { "capabilityStatement": { "type": "string" } } }, "ConnectorPluginProperties": { "type": "object", "properties": { "name": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "DestinationConnectorProperties": { "type": "object", "properties": { "queueEnabled": { "type": "boolean" }, "sendFirst": { "type": "boolean" }, "retryIntervalMillis": { "type": "integer", "format": "int32" }, "regenerateTemplate": { "type": "boolean" }, "retryCount": { "type": "integer", "format": "int32" }, "rotate": { "type": "boolean" }, "includeFilterTransformer": { "type": "boolean" }, "threadCount": { "type": "integer", "format": "int32" }, "threadAssignmentVariable": { "type": "string" }, "validateResponse": { "type": "boolean" }, "resourceIds": { "type": "object", "additionalProperties": { "type": "string" } }, "queueBufferSize": { "type": "integer", "format": "int32" }, "reattachAttachments": { "type": "boolean" }, "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "FhirDispatcherProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "destinationConnectorProperties": { "$ref": "#/components/schemas/DestinationConnectorProperties" }, "host": { "type": "string" }, "useProxyServer": { "type": "boolean" }, "proxyAddress": { "type": "string" }, "proxyPort": { "type": "string" }, "method": { "type": "string" }, "useHeadersVariable": { "type": "boolean" }, "headersVariable": { "type": "string" }, "useParametersVariable": { "type": "boolean" }, "parametersVariable": { "type": "string" }, "responseXmlBody": { "type": "boolean" }, "responseParseMultipart": { "type": "boolean" }, "responseIncludeMetadata": { "type": "boolean" }, "responseBinaryMimeTypes": { "type": "string" }, "responseBinaryMimeTypesRegex": { "type": "boolean" }, "multipart": { "type": "boolean" }, "useAuthentication": { "type": "boolean" }, "authenticationType": { "type": "string" }, "usePreemptiveAuthentication": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "dataTypeBinary": { "type": "boolean" }, "charset": { "type": "string" }, "socketTimeout": { "type": "string" }, "capabilitiesURL": { "type": "string" }, "cachedCapabilityStatement": { "type": "string" }, "systemInteraction": { "type": "boolean" }, "resource": { "type": "string" }, "interaction": { "type": "string" }, "operationScopeInstance": { "type": "boolean" }, "path": { "type": "string" }, "pathVariables": { "type": "array", "items": { "type": "string" } }, "usingBuilder": { "type": "boolean" }, "modelProperties": { "$ref": "#/components/schemas/Model" }, "fhirVersion": { "type": "string", "enum": [ "DSTU2", "DSTU2_HL7ORG", "DSTU2_1", "STU3", "R4", "R5_P1" ] }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" }, "headersMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "parametersMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "Model": { "type": "object", "properties": { "stringValue": { "type": "string" }, "type": { "type": "string", "enum": [ "array", "boolean", "integer", "number", "null", "object", "string", "unknown" ] } } }, "CronProperty": { "type": "object", "properties": { "description": { "type": "string" }, "expression": { "type": "string" } } }, "FileReceiverProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "pollConnectorProperties": { "$ref": "#/components/schemas/PollConnectorProperties" }, "sourceConnectorProperties": { "$ref": "#/components/schemas/SourceConnectorProperties" }, "scheme": { "type": "string", "enum": [ "file", "ftp", "sftp", "Amazon S3", "smb", "webdav" ] }, "schemeProperties": { "$ref": "#/components/schemas/SchemeProperties" }, "host": { "type": "string" }, "fileFilter": { "type": "string" }, "regex": { "type": "boolean" }, "directoryRecursion": { "type": "boolean" }, "ignoreDot": { "type": "boolean" }, "anonymous": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "timeout": { "type": "string" }, "secure": { "type": "boolean" }, "passive": { "type": "boolean" }, "validateConnection": { "type": "boolean" }, "afterProcessingAction": { "type": "string", "enum": [ "None", "Move", "Delete", "After Processing Action" ] }, "moveToDirectory": { "type": "string" }, "moveToFileName": { "type": "string" }, "errorReadingAction": { "type": "string", "enum": [ "None", "Move", "Delete", "After Processing Action" ] }, "errorResponseAction": { "type": "string", "enum": [ "None", "Move", "Delete", "After Processing Action" ] }, "errorMoveToDirectory": { "type": "string" }, "errorMoveToFileName": { "type": "string" }, "checkFileAge": { "type": "boolean" }, "fileAge": { "type": "string" }, "fileSizeMinimum": { "type": "string" }, "fileSizeMaximum": { "type": "string" }, "ignoreFileSizeMaximum": { "type": "boolean" }, "sortBy": { "type": "string" }, "binary": { "type": "boolean" }, "charsetEncoding": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "PollConnectorProperties": { "type": "object", "properties": { "pollingType": { "type": "string", "enum": [ "INTERVAL", "TIME", "CRON" ] }, "pollOnStart": { "type": "boolean" }, "pollingFrequency": { "type": "integer", "format": "int32" }, "pollingHour": { "type": "integer", "format": "int32" }, "pollingMinute": { "type": "integer", "format": "int32" }, "cronJobs": { "type": "array", "items": { "$ref": "#/components/schemas/CronProperty" } }, "pollConnectorPropertiesAdvanced": { "$ref": "#/components/schemas/PollConnectorPropertiesAdvanced" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "PollConnectorPropertiesAdvanced": { "type": "object", "properties": { "weekly": { "type": "boolean" }, "inactiveDays": { "type": "array", "items": { "type": "boolean" } }, "dayOfMonth": { "type": "integer", "format": "int32" }, "allDay": { "type": "boolean" }, "startingHour": { "type": "integer", "format": "int32" }, "startingMinute": { "type": "integer", "format": "int32" }, "endingHour": { "type": "integer", "format": "int32" }, "endingMinute": { "type": "integer", "format": "int32" }, "activeDays": { "type": "array", "writeOnly": true, "items": { "type": "boolean" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "SchemeProperties": { "type": "object", "properties": { "fileSchemeProperties": { "$ref": "#/components/schemas/SchemeProperties" }, "summaryText": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "SourceConnectorProperties": { "type": "object", "properties": { "responseVariable": { "type": "string" }, "respondAfterProcessing": { "type": "boolean" }, "processBatch": { "type": "boolean" }, "firstResponse": { "type": "boolean" }, "processingThreads": { "type": "integer", "format": "int32" }, "resourceIds": { "type": "object", "additionalProperties": { "type": "string" } }, "queueBufferSize": { "type": "integer", "format": "int32" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "FileDispatcherProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "destinationConnectorProperties": { "$ref": "#/components/schemas/DestinationConnectorProperties" }, "scheme": { "type": "string", "enum": [ "file", "ftp", "sftp", "Amazon S3", "smb", "webdav" ] }, "schemeProperties": { "$ref": "#/components/schemas/SchemeProperties" }, "host": { "type": "string" }, "outputPattern": { "type": "string" }, "anonymous": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "timeout": { "type": "string" }, "keepConnectionOpen": { "type": "boolean" }, "maxIdleTime": { "type": "string" }, "secure": { "type": "boolean" }, "passive": { "type": "boolean" }, "validateConnection": { "type": "boolean" }, "outputAppend": { "type": "boolean" }, "errorOnExists": { "type": "boolean" }, "temporary": { "type": "boolean" }, "binary": { "type": "boolean" }, "charsetEncoding": { "type": "string" }, "template": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "HttpDispatcherProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "destinationConnectorProperties": { "$ref": "#/components/schemas/DestinationConnectorProperties" }, "host": { "type": "string" }, "useProxyServer": { "type": "boolean" }, "proxyAddress": { "type": "string" }, "proxyPort": { "type": "string" }, "method": { "type": "string" }, "useHeadersVariable": { "type": "boolean" }, "headersVariable": { "type": "string" }, "useParametersVariable": { "type": "boolean" }, "parametersVariable": { "type": "string" }, "responseXmlBody": { "type": "boolean" }, "responseParseMultipart": { "type": "boolean" }, "responseIncludeMetadata": { "type": "boolean" }, "responseBinaryMimeTypes": { "type": "string" }, "responseBinaryMimeTypesRegex": { "type": "boolean" }, "multipart": { "type": "boolean" }, "useAuthentication": { "type": "boolean" }, "authenticationType": { "type": "string" }, "usePreemptiveAuthentication": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "dataTypeBinary": { "type": "boolean" }, "charset": { "type": "string" }, "socketTimeout": { "type": "string" }, "headersMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "parametersMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "Column": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "precision": { "type": "integer", "format": "int32" } } }, "Table": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/Column" } } } }, "JmsConnectorProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "useJndi": { "type": "boolean" }, "jndiProviderUrl": { "type": "string" }, "jndiInitialContextFactory": { "type": "string" }, "jndiConnectionFactoryName": { "type": "string" }, "connectionFactoryClass": { "type": "string" }, "connectionProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "username": { "type": "string" }, "password": { "type": "string" }, "destinationName": { "type": "string" }, "topic": { "type": "boolean" }, "clientId": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "Attachment": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "array", "items": { "type": "string", "format": "byte" } }, "type": { "type": "string" }, "encryptionHeader": { "type": "string" }, "attachmentId": { "type": "string" }, "encrypted": { "type": "boolean" } } }, "SmtpDispatcherProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "destinationConnectorProperties": { "$ref": "#/components/schemas/DestinationConnectorProperties" }, "smtpHost": { "type": "string" }, "smtpPort": { "type": "string" }, "overrideLocalBinding": { "type": "boolean" }, "localAddress": { "type": "string" }, "localPort": { "type": "string" }, "timeout": { "type": "string" }, "encryption": { "type": "string" }, "authentication": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "to": { "type": "string" }, "from": { "type": "string" }, "cc": { "type": "string" }, "bcc": { "type": "string" }, "replyTo": { "type": "string" }, "headersVariable": { "type": "string" }, "subject": { "type": "string" }, "charsetEncoding": { "type": "string" }, "html": { "type": "boolean" }, "body": { "type": "string" }, "attachmentsVariable": { "type": "string" }, "headersMap": { "type": "object", "additionalProperties": { "type": "string" } }, "useAttachmentsVariable": { "type": "boolean" }, "attachmentsList": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "useHeadersVariable": { "type": "boolean" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "TcpDispatcherProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "destinationConnectorProperties": { "$ref": "#/components/schemas/DestinationConnectorProperties" }, "transmissionModeProperties": { "$ref": "#/components/schemas/TransmissionModeProperties" }, "serverMode": { "type": "boolean" }, "remoteAddress": { "type": "string" }, "remotePort": { "type": "string" }, "overrideLocalBinding": { "type": "boolean" }, "localAddress": { "type": "string" }, "localPort": { "type": "string" }, "sendTimeout": { "type": "string" }, "bufferSize": { "type": "string" }, "maxConnections": { "type": "string" }, "keepConnectionOpen": { "type": "boolean" }, "checkRemoteHost": { "type": "boolean" }, "responseTimeout": { "type": "string" }, "ignoreResponse": { "type": "boolean" }, "queueOnResponseTimeout": { "type": "boolean" }, "dataTypeBinary": { "type": "boolean" }, "charsetEncoding": { "type": "string" }, "template": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "TransmissionModeProperties": { "type": "object", "properties": { "pluginPointName": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "DefinitionPortMap": { "type": "object", "properties": { "map": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PortInformation" } } } }, "DefinitionServiceMap": { "type": "object", "properties": { "map": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DefinitionPortMap" } } } }, "PortInformation": { "type": "object", "properties": { "operations": { "type": "array", "items": { "type": "string" } }, "actions": { "type": "array", "items": { "type": "string" } }, "locationURI": { "type": "string" } } }, "WebServiceDispatcherProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "destinationConnectorProperties": { "$ref": "#/components/schemas/DestinationConnectorProperties" }, "wsdlUrl": { "type": "string" }, "service": { "type": "string" }, "port": { "type": "string" }, "operation": { "type": "string" }, "locationURI": { "type": "string" }, "socketTimeout": { "type": "string" }, "useAuthentication": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "envelope": { "type": "string" }, "oneWay": { "type": "boolean" }, "headersVariable": { "type": "string" }, "useMtom": { "type": "boolean" }, "attachmentNames": { "type": "array", "items": { "type": "string" } }, "attachmentContents": { "type": "array", "items": { "type": "string" } }, "attachmentTypes": { "type": "array", "items": { "type": "string" } }, "attachmentsVariable": { "type": "string" }, "soapAction": { "type": "string" }, "wsdlDefinitionMap": { "$ref": "#/components/schemas/DefinitionServiceMap" }, "headersMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "useAttachmentsVariable": { "type": "boolean" }, "useHeadersVariable": { "type": "boolean" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "AlertLogItem": { "type": "object", "properties": { "alertName": { "type": "string" }, "alertId": { "type": "string" }, "logId": { "type": "integer", "format": "int64" }, "channelName": { "type": "string" }, "connectorName": { "type": "string" }, "groupName": { "type": "string" }, "time": { "type": "string" } } }, "AlertLogResponse": { "type": "object", "properties": { "alertLogs": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AlertLogItem" } } } } }, "AlertLogRequest": { "type": "object", "properties": { "alertIds": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } }, "logSize": { "type": "integer", "format": "int32" } } }, "Permission": { "type": "object", "properties": { "name": { "type": "string" }, "group": { "type": "string" }, "description": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } } }, "Task": { "type": "object", "properties": { "group": { "type": "string" }, "name": { "type": "string" } } }, "ConnectionLogItem": { "type": "object", "properties": { "logId": { "type": "integer", "format": "int64" }, "serverId": { "type": "string" }, "channelId": { "type": "string" }, "metadataId": { "type": "integer", "format": "int64" }, "dateAdded": { "type": "string" }, "channelName": { "type": "string" }, "connectorType": { "type": "string" }, "eventState": { "type": "string" }, "information": { "type": "string" } } }, "Snapshot": { "type": "object", "properties": { "snapshotId": { "type": "integer", "format": "int32" }, "itemId": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "dateCreated": { "type": "string", "format": "date-time" }, "text": { "type": "string" } } }, "ServerLogItem": { "type": "object", "properties": { "serverId": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "level": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "threadName": { "type": "string" }, "category": { "type": "string" }, "lineNumber": { "type": "string" }, "message": { "type": "string" }, "throwableInformation": { "type": "string" } } }, "KeyStoreEntry": { "type": "object", "properties": { "certificateChain": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } }, "publicKey": { "type": "object", "properties": { "algorithm": { "type": "string" }, "format": { "type": "string" }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } } }, "privateKey": { "type": "object", "properties": { "algorithm": { "type": "string" }, "format": { "type": "string" }, "encoded": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "password": { "type": "array", "items": { "type": "string" } }, "alias": { "type": "string" }, "valid": { "type": "boolean" } } }, "SSLManagerSettings": { "type": "object", "properties": { "validationLoginWarning": { "type": "boolean" }, "expirationTimeUntil": { "type": "string" } } }, "KeyStoreCertificates": { "type": "object", "properties": { "trustedCertificateMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } }, "myCertificateMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KeyStoreEntry" } } } }, "AlertAction": { "type": "object", "properties": { "protocol": { "type": "string" }, "recipient": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "AlertActionGroup": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/AlertAction" } }, "subject": { "type": "string" }, "template": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "AlertModel": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "trigger": { "$ref": "#/components/schemas/AlertTrigger" }, "actionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/AlertActionGroup" } }, "properties": { "type": "object", "additionalProperties": { "type": "object" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "AlertTrigger": { "type": "object", "properties": { "name": { "type": "string" } } }, "AlertInfo": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/AlertModel" }, "protocolOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "changedChannels": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelSummary" } } } }, "AttachmentHandlerProperties": { "type": "object", "properties": { "className": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "type": "string" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "BatchProperties": { "type": "object", "properties": { "batchScript": { "type": "string" }, "propertyDescriptors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataTypePropertyDescriptor" } }, "properties": { "type": "object", "additionalProperties": { "type": "object" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "Channel": { "type": "object", "properties": { "id": { "type": "string" }, "nextMetaDataId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "sourceConnector": { "$ref": "#/components/schemas/Connector" }, "destinationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/Connector" } }, "preprocessingScript": { "type": "string" }, "postprocessingScript": { "type": "string" }, "deployScript": { "type": "string" }, "undeployScript": { "type": "string" }, "properties": { "$ref": "#/components/schemas/ChannelProperties" }, "exportData": { "$ref": "#/components/schemas/ChannelExportData" }, "enabledDestinationConnectors": { "type": "array", "items": { "$ref": "#/components/schemas/Connector" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ChannelExportData": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/ChannelMetadata" }, "codeTemplateLibraries": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "dependentIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "dependencyIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "channelTags": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelTag" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ChannelMetadata": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "lastModified": { "type": "string", "format": "date-time" }, "pruningSettings": { "$ref": "#/components/schemas/ChannelPruningSettings" }, "userId": { "type": "integer", "format": "int32" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ChannelProperties": { "type": "object", "properties": { "clearGlobalChannelMap": { "type": "boolean" }, "messageStorageMode": { "type": "string", "enum": [ "DEVELOPMENT", "PRODUCTION", "RAW", "METADATA", "DISABLED" ] }, "encryptAttachments": { "type": "boolean" }, "encryptCustomMetaData": { "type": "boolean" }, "removeContentOnCompletion": { "type": "boolean" }, "removeOnlyFilteredOnCompletion": { "type": "boolean" }, "removeAttachmentsOnCompletion": { "type": "boolean" }, "initialState": { "type": "string", "enum": [ "Undeployed", "Deploying", "Undeploying", "Starting", "Started", "Pausing", "Paused", "Stopping", "Stopped", "Syncing", "Unknown" ] }, "storeAttachments": { "type": "boolean" }, "metaDataColumns": { "type": "array", "items": { "$ref": "#/components/schemas/MetaDataColumn" } }, "attachmentProperties": { "$ref": "#/components/schemas/AttachmentHandlerProperties" }, "resourceIds": { "type": "object", "additionalProperties": { "type": "string" } }, "encryptMessageContent": { "type": "boolean" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ChannelPruningSettings": { "type": "object", "properties": { "pruneMetaDataDays": { "type": "integer", "format": "int32" }, "pruneContentDays": { "type": "integer", "format": "int32" }, "archiveEnabled": { "type": "boolean" }, "pruneErroredMessages": { "type": "boolean" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ChannelStatus": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/Channel" }, "deployedDate": { "type": "string", "format": "date-time" }, "deployedRevisionDelta": { "type": "integer", "format": "int32" }, "codeTemplatesChanged": { "type": "boolean" }, "localChannelId": { "type": "integer", "format": "int64" } } }, "ChannelSummary": { "type": "object", "properties": { "channelId": { "type": "string" }, "deleted": { "type": "boolean" }, "undeployed": { "type": "boolean" }, "channelStatus": { "$ref": "#/components/schemas/ChannelStatus" } } }, "ChannelTag": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "channelIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "backgroundColor": { "type": "object", "properties": { "red": { "type": "integer", "format": "int32" }, "green": { "type": "integer", "format": "int32" }, "blue": { "type": "integer", "format": "int32" }, "alpha": { "type": "integer", "format": "int32" }, "rgb": { "type": "integer", "format": "int32" }, "colorSpace": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32" }, "numComponents": { "type": "integer", "format": "int32" }, "cs_sRGB": { "type": "boolean" } } }, "transparency": { "type": "integer", "format": "int32" } } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "CodeTemplate": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "lastModified": { "type": "string", "format": "date-time" }, "contextSet": { "uniqueItems": true, "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string", "enum": [ "Global Deploy", "Global Undeploy", "Global Preprocessor", "Global Postprocessor", "Channel Deploy", "Channel Undeploy", "Channel Preprocessor", "Channel Postprocessor", "Channel Attachment", "Channel Batch", "Source Receiver", "Source Filter Transformer", "Destination Filter Transformer", "Destination Dispatcher", "Destination Response Transformer" ] } }, "properties": { "$ref": "#/components/schemas/CodeTemplateProperties" }, "description": { "type": "string" }, "code": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "functionDefinition": { "$ref": "#/components/schemas/CodeTemplateFunctionDefinition" }, "addToScripts": { "type": "boolean" }, "type": { "type": "string", "enum": [ "Function", "Drag-and-Drop Code Block", "Compiled Code Block" ] } } }, "CodeTemplateContextSet": { "uniqueItems": true, "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "string", "enum": [ "Global Deploy", "Global Undeploy", "Global Preprocessor", "Global Postprocessor", "Channel Deploy", "Channel Undeploy", "Channel Preprocessor", "Channel Postprocessor", "Channel Attachment", "Channel Batch", "Source Receiver", "Source Filter Transformer", "Destination Filter Transformer", "Destination Dispatcher", "Destination Response Transformer" ] } }, "CodeTemplateFunctionDefinition": { "type": "object", "properties": { "name": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/Parameter" } }, "returnType": { "type": "string" }, "returnDescription": { "type": "string" }, "transferData": { "type": "string" } } }, "CodeTemplateLibrary": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "lastModified": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "includeNewChannels": { "type": "boolean" }, "enabledChannelIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "disabledChannelIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "codeTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplate" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "CodeTemplateProperties": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Function", "Drag-and-Drop Code Block", "Compiled Code Block" ] }, "description": { "type": "string" }, "functionDefinition": { "$ref": "#/components/schemas/CodeTemplateFunctionDefinition" }, "pluginPointName": { "type": "string" }, "code": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "Connector": { "type": "object", "properties": { "metaDataId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "properties": { "$ref": "#/components/schemas/ConnectorProperties" }, "transformer": { "$ref": "#/components/schemas/Transformer" }, "responseTransformer": { "$ref": "#/components/schemas/Transformer" }, "filter": { "$ref": "#/components/schemas/Filter" }, "transportName": { "type": "string" }, "mode": { "type": "string", "enum": [ "SOURCE", "DESTINATION" ] }, "enabled": { "type": "boolean" }, "waitForPrevious": { "type": "boolean" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ConnectorProperties": { "type": "object", "properties": { "pluginProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorPluginProperties" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "name": { "type": "string" }, "protocol": { "type": "string" } } }, "DataTypeProperties": { "type": "object", "properties": { "serializationProperties": { "$ref": "#/components/schemas/SerializationProperties" }, "deserializationProperties": { "$ref": "#/components/schemas/DeserializationProperties" }, "batchProperties": { "$ref": "#/components/schemas/BatchProperties" }, "responseGenerationProperties": { "$ref": "#/components/schemas/ResponseGenerationProperties" }, "responseValidationProperties": { "$ref": "#/components/schemas/ResponseValidationProperties" }, "serializerProperties": { "$ref": "#/components/schemas/SerializerProperties" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "DataTypePropertyDescriptor": { "type": "object", "properties": { "value": { "type": "object" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "editorType": { "type": "string", "enum": [ "STRING", "BOOLEAN", "JAVASCRIPT", "OPTION" ] }, "options": { "type": "array", "items": { "type": "object" } } } }, "DeserializationProperties": { "type": "object", "properties": { "serializationType": { "type": "string", "enum": [ "RAW", "XML", "JSON" ] }, "propertyDescriptors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataTypePropertyDescriptor" } }, "properties": { "type": "object", "additionalProperties": { "type": "object" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "Filter": { "type": "object", "properties": { "elements": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "enabledElements": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "MetaDataColumn": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "STRING", "NUMBER", "BOOLEAN", "TIMESTAMP" ] }, "mappingName": { "type": "string" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "Parameter": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" } } }, "ResponseGenerationProperties": { "type": "object", "properties": { "propertyDescriptors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataTypePropertyDescriptor" } }, "properties": { "type": "object", "additionalProperties": { "type": "object" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ResponseValidationProperties": { "type": "object", "properties": { "propertyDescriptors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataTypePropertyDescriptor" } }, "properties": { "type": "object", "additionalProperties": { "type": "object" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "Rule": { "type": "object", "properties": { "name": { "type": "string" }, "sequenceNumber": { "type": "string" }, "enabled": { "type": "boolean" }, "operator": { "type": "string", "enum": [ "AND", "OR", "NONE" ] }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "responseVariables": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } }, "SerializationProperties": { "type": "object", "properties": { "serializationType": { "type": "string", "enum": [ "RAW", "XML", "JSON" ] }, "propertyDescriptors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataTypePropertyDescriptor" } }, "properties": { "type": "object", "additionalProperties": { "type": "object" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "SerializerProperties": { "type": "object", "properties": { "serializationProperties": { "$ref": "#/components/schemas/SerializationProperties" }, "deserializationProperties": { "$ref": "#/components/schemas/DeserializationProperties" }, "batchProperties": { "$ref": "#/components/schemas/BatchProperties" } } }, "Step": { "type": "object", "properties": { "name": { "type": "string" }, "sequenceNumber": { "type": "string" }, "enabled": { "type": "boolean" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "responseVariables": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } }, "Transformer": { "type": "object", "properties": { "elements": { "type": "array", "items": { "$ref": "#/components/schemas/Step" } }, "inboundTemplate": { "type": "string" }, "outboundTemplate": { "type": "string" }, "inboundDataType": { "type": "string" }, "outboundDataType": { "type": "string" }, "inboundProperties": { "$ref": "#/components/schemas/DataTypeProperties" }, "outboundProperties": { "$ref": "#/components/schemas/DataTypeProperties" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "enabledElements": { "type": "array", "items": { "$ref": "#/components/schemas/Step" } } } }, "ChannelHeader": { "type": "object", "properties": { "revision": { "type": "integer", "format": "int32" }, "deployedDate": { "type": "string", "format": "date-time" }, "codeTemplatesChanged": { "type": "boolean" } } }, "AlertStatus": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "alertedCount": { "type": "integer", "format": "int32" } } }, "ChannelGroup": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "lastModified": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "Ports": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "port": { "type": "string" } } }, "ChannelStatistics": { "type": "object", "properties": { "serverId": { "type": "string" }, "channelId": { "type": "string" }, "received": { "type": "integer", "format": "int64" }, "sent": { "type": "integer", "format": "int64" }, "error": { "type": "integer", "format": "int64" }, "filtered": { "type": "integer", "format": "int64" }, "queued": { "type": "integer", "format": "int64" } } }, "DashboardStatus": { "type": "object", "properties": { "channelId": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string", "enum": [ "Undeployed", "Deploying", "Undeploying", "Starting", "Started", "Pausing", "Paused", "Stopping", "Stopped", "Syncing", "Unknown" ] }, "deployedRevisionDelta": { "type": "integer", "format": "int32" }, "deployedDate": { "type": "string", "format": "date-time" }, "codeTemplatesChanged": { "type": "boolean" }, "statistics": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } }, "lifetimeStatistics": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } }, "childStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardStatus" } }, "metaDataId": { "type": "integer", "format": "int32" }, "queueEnabled": { "type": "boolean" }, "queued": { "type": "integer", "format": "int64" }, "waitForPrevious": { "type": "boolean" }, "statusType": { "type": "string", "enum": [ "CHANNEL", "CHAIN", "SOURCE_CONNECTOR", "DESTINATION_CONNECTOR" ] }, "key": { "type": "string" } } }, "DashboardChannelInfo": { "type": "object", "properties": { "dashboardStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardStatus" } }, "remainingChannelIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "deployedChannelCount": { "type": "integer", "format": "int32" }, "deployedChannelNames": { "type": "integer", "format": "int32", "writeOnly": true } } }, "CodeTemplateSummary": { "type": "object", "properties": { "codeTemplateId": { "type": "string" }, "deleted": { "type": "boolean" }, "codeTemplate": { "$ref": "#/components/schemas/CodeTemplate" } } }, "CodeTemplateLibrarySaveResult": { "type": "object", "properties": { "overrideNeeded": { "type": "boolean" }, "librariesSuccess": { "type": "boolean" }, "cause": { "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "message": { "type": "string" }, "localizedMessage": { "type": "string" }, "suppressed": { "type": "array", "items": { "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "message": { "type": "string" }, "localizedMessage": { "type": "string" } } } } } }, "libraryResults": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LibraryUpdateResult" } }, "codeTemplateResults": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CodeTemplateUpdateResult" } } } }, "CodeTemplateUpdateResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "newRevision": { "type": "integer", "format": "int32" }, "newLastModified": { "type": "string", "format": "date-time" }, "cause": { "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "message": { "type": "string" }, "localizedMessage": { "type": "string" }, "suppressed": { "type": "array", "items": { "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "message": { "type": "string" }, "localizedMessage": { "type": "string" } } } } } } } }, "LibraryUpdateResult": { "type": "object", "properties": { "newRevision": { "type": "integer", "format": "int32" }, "newLastModified": { "type": "string", "format": "date-time" } } }, "LicenseInfo": { "type": "object", "properties": { "activated": { "type": "boolean" }, "online": { "type": "boolean" }, "expirationDate": { "type": "integer", "format": "int64" }, "warningPeriod": { "type": "integer", "format": "int64" }, "gracePeriod": { "type": "integer", "format": "int64" }, "reason": { "type": "string" }, "extensions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "downloadedExtensions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "UpdateSettings": { "type": "object", "properties": { "statsEnabled": { "type": "boolean" }, "lastStatsTime": { "type": "integer", "format": "int64" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "properties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationProperty": { "type": "object", "properties": { "value": { "type": "string" }, "comment": { "type": "string" } } }, "ServerSettings": { "type": "object", "properties": { "environmentName": { "type": "string" }, "serverName": { "type": "string" }, "clearGlobalMap": { "type": "boolean" }, "queueBufferSize": { "type": "integer", "format": "int32" }, "defaultMetaDataColumns": { "type": "array", "items": { "$ref": "#/components/schemas/MetaDataColumn" } }, "defaultAdministratorBackgroundColor": { "type": "object", "properties": { "red": { "type": "integer", "format": "int32" }, "green": { "type": "integer", "format": "int32" }, "blue": { "type": "integer", "format": "int32" }, "alpha": { "type": "integer", "format": "int32" }, "rgb": { "type": "integer", "format": "int32" }, "colorSpace": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32" }, "numComponents": { "type": "integer", "format": "int32" }, "cs_sRGB": { "type": "boolean" } } }, "transparency": { "type": "integer", "format": "int32" } } }, "smtpHost": { "type": "string" }, "smtpPort": { "type": "string" }, "smtpTimeout": { "type": "string" }, "smtpFrom": { "type": "string" }, "smtpSecure": { "type": "string" }, "smtpAuth": { "type": "boolean" }, "smtpUsername": { "type": "string" }, "smtpPassword": { "type": "string" }, "loginNotificationEnabled": { "type": "boolean" }, "loginNotificationMessage": { "type": "string" }, "administratorAutoLogoutIntervalEnabled": { "type": "boolean" }, "administratorAutoLogoutIntervalField": { "type": "integer", "format": "int32" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "properties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChannelDependency": { "type": "object", "properties": { "dependentId": { "type": "string" }, "dependencyId": { "type": "string" } } }, "PublicServerSettings": { "type": "object", "properties": { "environmentName": { "type": "string" }, "serverName": { "type": "string" }, "clearGlobalMap": { "type": "boolean" }, "queueBufferSize": { "type": "integer", "format": "int32" }, "defaultMetaDataColumns": { "type": "array", "items": { "$ref": "#/components/schemas/MetaDataColumn" } }, "defaultAdministratorBackgroundColor": { "type": "object", "properties": { "red": { "type": "integer", "format": "int32" }, "green": { "type": "integer", "format": "int32" }, "blue": { "type": "integer", "format": "int32" }, "alpha": { "type": "integer", "format": "int32" }, "rgb": { "type": "integer", "format": "int32" }, "colorSpace": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32" }, "numComponents": { "type": "integer", "format": "int32" }, "cs_sRGB": { "type": "boolean" } } }, "transparency": { "type": "integer", "format": "int32" } } }, "smtpHost": { "type": "string" }, "smtpPort": { "type": "string" }, "smtpTimeout": { "type": "string" }, "smtpFrom": { "type": "string" }, "smtpSecure": { "type": "string" }, "smtpAuth": { "type": "boolean" }, "smtpUsername": { "type": "string" }, "smtpPassword": { "type": "string" }, "loginNotificationEnabled": { "type": "boolean" }, "loginNotificationMessage": { "type": "string" }, "administratorAutoLogoutIntervalEnabled": { "type": "boolean" }, "administratorAutoLogoutIntervalField": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "type": "string" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "EncryptionSettings": { "type": "object", "properties": { "encryptExport": { "type": "boolean" }, "encryptProperties": { "type": "boolean" }, "encryptionAlgorithm": { "type": "string" }, "encryptionCharset": { "type": "string" }, "encryptionFallbackAlgorithm": { "type": "string" }, "encryptionFallbackCharset": { "type": "string" }, "encryptionKeyLength": { "type": "integer", "format": "int32" }, "digestAlgorithm": { "type": "string" }, "digestSaltSize": { "type": "integer", "format": "int32" }, "digestIterations": { "type": "integer", "format": "int32" }, "digestUsePBE": { "type": "boolean" }, "digestKeySize": { "type": "integer", "format": "int32" }, "digestFallbackAlgorithm": { "type": "string" }, "digestFallbackSaltSize": { "type": "integer", "format": "int32" }, "digestFallbackIterations": { "type": "integer", "format": "int32" }, "digestFallbackUsePBE": { "type": "boolean" }, "digestFallbackKeySize": { "type": "integer", "format": "int32" }, "securityProvider": { "type": "string" }, "secretKey": { "type": "array", "items": { "type": "string", "format": "byte" } }, "encryptionBaseAlgorithm": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DriverInfo": { "type": "object", "properties": { "className": { "type": "string" }, "name": { "type": "string" }, "template": { "type": "string" }, "selectLimit": { "type": "string" }, "alternativeClassNames": { "type": "array", "items": { "type": "string" } } } }, "ResourceProperties": { "type": "object", "properties": { "pluginPointName": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "includeWithGlobalScripts": { "type": "boolean" }, "loadParentFirst": { "type": "boolean" }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ResourcePropertiesList": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceProperties" } } } }, "ServerConfiguration": { "type": "object", "properties": { "date": { "type": "string" }, "channelGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelGroup" } }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } }, "channelTags": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelTag" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "alerts": { "type": "array", "items": { "$ref": "#/components/schemas/AlertModel" } }, "codeTemplateLibraries": { "type": "array", "items": { "$ref": "#/components/schemas/CodeTemplateLibrary" } }, "serverSettings": { "$ref": "#/components/schemas/ServerSettings" }, "updateSettings": { "$ref": "#/components/schemas/UpdateSettings" }, "globalScripts": { "type": "object", "additionalProperties": { "type": "string" } }, "pluginProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "resourceProperties": { "$ref": "#/components/schemas/ResourcePropertiesList" }, "channelDependencies": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChannelDependency" } }, "configurationMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConfigurationProperty" } } } }, "User": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "username": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "organization": { "type": "string" }, "description": { "type": "string" }, "phoneNumber": { "type": "string" }, "industry": { "type": "string" }, "lastLogin": { "type": "string", "format": "date-time" }, "gracePeriodStart": { "type": "string", "format": "date-time" }, "strikeCount": { "type": "integer", "format": "int32" }, "lastStrikeTime": { "type": "string", "format": "date-time" }, "country": { "type": "string" }, "stateTerritory": { "type": "string" }, "role": { "type": "string" }, "userConsent": { "type": "boolean" } } }, "PasswordRequirements": { "type": "object", "properties": { "minLength": { "type": "integer", "format": "int32" }, "minUpper": { "type": "integer", "format": "int32" }, "minLower": { "type": "integer", "format": "int32" }, "minNumeric": { "type": "integer", "format": "int32" }, "minSpecial": { "type": "integer", "format": "int32" }, "retryLimit": { "type": "integer", "format": "int32" }, "lockoutPeriod": { "type": "integer", "format": "int32" }, "expiration": { "type": "integer", "format": "int32" }, "gracePeriod": { "type": "integer", "format": "int32" }, "reusePeriod": { "type": "integer", "format": "int32" }, "reuseLimit": { "type": "integer", "format": "int32" } } }, "DatabaseTask": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "Idle", "Running" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "confirmationMessage": { "type": "string" }, "affectedChannels": { "type": "object", "additionalProperties": { "type": "string" } }, "startDateTime": { "type": "string", "format": "date-time" } } }, "ServerEvent": { "type": "object", "properties": { "dateTime": { "type": "integer", "format": "int64" }, "nanoTime": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int32" }, "eventTime": { "type": "string", "format": "date-time" }, "level": { "type": "string", "enum": [ "INFORMATION", "WARNING", "ERROR" ] }, "name": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "outcome": { "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "userId": { "type": "integer", "format": "int32" }, "patientId": { "type": "string" }, "ipAddress": { "type": "string" }, "serverId": { "type": "string" }, "channelId": { "type": "string" }, "channelName": { "type": "string" }, "messageId": { "type": "string" }, "channelIdWithMessageId": { "type": "string" } } }, "EventFilter": { "type": "object", "properties": { "maxEventId": { "type": "integer", "format": "int32" }, "minEventId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "levels": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "INFORMATION", "WARNING", "ERROR" ] } }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "outcome": { "type": "string", "enum": [ "SUCCESS", "FAILURE" ] }, "userId": { "type": "integer", "format": "int32" }, "attributeSearch": { "type": "string" }, "ipAddress": { "type": "string" }, "serverId": { "type": "string" } } }, "ApiProvider": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SERVLET_INTERFACE_PACKAGE", "SERVLET_INTERFACE", "CORE_PACKAGE", "SERVER_PACKAGE", "CORE_CLASS", "SERVER_CLASS" ] }, "name": { "type": "string" }, "minVersion": { "type": "string" }, "maxVersion": { "type": "string" } } }, "ExtensionLibrary": { "type": "object", "properties": { "path": { "type": "string" }, "type": { "type": "string", "enum": [ "SERVER", "CLIENT", "SHARED" ] } } }, "MetaData": { "type": "object", "properties": { "path": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "mirthVersion": { "type": "string" }, "pluginVersion": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "apiProviders": { "type": "array", "items": { "$ref": "#/components/schemas/ApiProvider" } }, "libraries": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionLibrary" } }, "templateClassName": { "type": "string" }, "userutilPackages": { "type": "array", "items": { "type": "string" } }, "notify": { "type": "boolean" } } }, "ConnectorMetaData": { "type": "object", "properties": { "path": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "mirthVersion": { "type": "string" }, "pluginVersion": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "apiProviders": { "type": "array", "items": { "$ref": "#/components/schemas/ApiProvider" } }, "libraries": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionLibrary" } }, "templateClassName": { "type": "string" }, "userutilPackages": { "type": "array", "items": { "type": "string" } }, "notify": { "type": "boolean" }, "serverClassName": { "type": "string" }, "sharedClassName": { "type": "string" }, "clientClassName": { "type": "string" }, "transformers": { "type": "string" }, "protocol": { "type": "string" }, "type": { "type": "string", "enum": [ "SOURCE", "DESTINATION" ] }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "PluginClass": { "type": "object", "properties": { "name": { "type": "string" }, "weight": { "type": "integer", "format": "int32" }, "conditionClass": { "type": "string" } } }, "PluginMetaData": { "type": "object", "properties": { "path": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "mirthVersion": { "type": "string" }, "pluginVersion": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "apiProviders": { "type": "array", "items": { "$ref": "#/components/schemas/ApiProvider" } }, "libraries": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionLibrary" } }, "templateClassName": { "type": "string" }, "userutilPackages": { "type": "array", "items": { "type": "string" } }, "notify": { "type": "boolean" }, "serverClasses": { "type": "array", "items": { "$ref": "#/components/schemas/PluginClass" } }, "clientClasses": { "type": "array", "items": { "$ref": "#/components/schemas/PluginClass" } }, "controllerClasses": { "type": "array", "items": { "$ref": "#/components/schemas/PluginClass" } }, "migratorClass": { "type": "string" }, "sqlScript": { "type": "string" }, "sqlMapConfigs": { "type": "object", "additionalProperties": { "type": "string" } }, "purgedProperties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "MetaDataSearch": { "type": "object", "properties": { "columnName": { "type": "string" }, "operator": { "type": "string", "enum": [ "=", "!=", "<", "<=", ">", ">=", "CONTAINS", "DOES NOT CONTAIN", "STARTS WITH", "DOES NOT START WITH", "ENDS WITH", "DOES NOT END WITH" ] }, "value": { "type": "string" } } }, "ContentSearchElement": { "type": "object", "properties": { "contentCode": { "type": "integer", "format": "int32" }, "searches": { "type": "array", "items": { "type": "string" } } } }, "MessageFilter": { "type": "object", "properties": { "maxMessageId": { "type": "integer", "format": "int64" }, "minMessageId": { "type": "integer", "format": "int64" }, "originalIdUpper": { "type": "integer", "format": "int64" }, "originalIdLower": { "type": "integer", "format": "int64" }, "importIdUpper": { "type": "integer", "format": "int64" }, "importIdLower": { "type": "integer", "format": "int64" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "textSearch": { "type": "string" }, "textSearchRegex": { "type": "boolean" }, "statuses": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "FILTERED", "TRANSFORMED", "SENT", "QUEUED", "ERROR", "PENDING" ] } }, "includedMetaDataIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludedMetaDataIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "serverId": { "type": "string" }, "contentSearch": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSearchElement" } }, "metaDataSearch": { "type": "array", "items": { "$ref": "#/components/schemas/MetaDataSearchElement" } }, "textSearchMetaDataColumns": { "type": "array", "items": { "type": "string" } }, "sendAttemptsLower": { "type": "integer", "format": "int32" }, "sendAttemptsUpper": { "type": "integer", "format": "int32" }, "attachment": { "type": "boolean" }, "error": { "type": "boolean" } } }, "MetaDataSearchElement": { "type": "object", "properties": { "columnName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "object" }, "ignoreCase": { "type": "boolean" } } }, "MessageWriterOptions": { "type": "object", "properties": { "contentType": { "type": "string", "enum": [ "Raw", "Processed Raw", "Transformed", "Encoded", "Sent", "Response", "Response Transformed", "Processed Response", "Connector Map", "Channel Map", "Response Map", "Processing Error", "Postprocessor Error", "Response Error", "Source Map" ] }, "destinationContent": { "type": "boolean" }, "encrypt": { "type": "boolean" }, "includeAttachments": { "type": "boolean", "writeOnly": true }, "baseFolder": { "type": "string" }, "rootFolder": { "type": "string" }, "filePattern": { "type": "string" }, "archiveFileName": { "type": "string" }, "archiveFormat": { "type": "string" }, "compressFormat": { "type": "string" }, "passwordEnabled": { "type": "boolean" }, "password": { "type": "string" }, "encryptionType": { "type": "string", "enum": [ "STANDARD", "AES128", "AES256" ] } } }, "ConnectorMessage": { "type": "object", "properties": { "messageId": { "type": "integer", "format": "int64" }, "metaDataId": { "type": "integer", "format": "int32" }, "channelId": { "type": "string" }, "channelName": { "type": "string" }, "connectorName": { "type": "string" }, "serverId": { "type": "string" }, "receivedDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "RECEIVED", "FILTERED", "TRANSFORMED", "SENT", "QUEUED", "ERROR", "PENDING" ] }, "raw": { "$ref": "#/components/schemas/MessageContent" }, "processedRaw": { "$ref": "#/components/schemas/MessageContent" }, "transformed": { "$ref": "#/components/schemas/MessageContent" }, "encoded": { "$ref": "#/components/schemas/MessageContent" }, "sent": { "$ref": "#/components/schemas/MessageContent" }, "response": { "$ref": "#/components/schemas/MessageContent" }, "responseTransformed": { "$ref": "#/components/schemas/MessageContent" }, "processedResponse": { "$ref": "#/components/schemas/MessageContent" }, "sourceMapContent": { "$ref": "#/components/schemas/MapContent" }, "connectorMapContent": { "$ref": "#/components/schemas/MapContent" }, "channelMapContent": { "$ref": "#/components/schemas/MapContent" }, "responseMapContent": { "$ref": "#/components/schemas/MapContent" }, "metaDataMap": { "type": "object", "additionalProperties": { "type": "object" } }, "processingErrorContent": { "$ref": "#/components/schemas/ErrorContent" }, "postProcessorErrorContent": { "$ref": "#/components/schemas/ErrorContent" }, "responseErrorContent": { "$ref": "#/components/schemas/ErrorContent" }, "errorCode": { "type": "integer", "format": "int32" }, "sendAttempts": { "type": "integer", "format": "int32" }, "sendDate": { "type": "string", "format": "date-time" }, "responseDate": { "type": "string", "format": "date-time" }, "chainId": { "type": "integer", "format": "int32" }, "orderId": { "type": "integer", "format": "int32" }, "sentProperties": { "$ref": "#/components/schemas/ConnectorProperties" }, "queueBucket": { "type": "integer", "format": "int32" }, "attemptedFirst": { "type": "boolean" }, "dispatcherId": { "type": "integer", "format": "int64" }, "responseMap": { "type": "object", "additionalProperties": { "type": "object" } }, "connectorMap": { "type": "object", "additionalProperties": { "type": "object" } }, "channelMap": { "type": "object", "additionalProperties": { "type": "object" } }, "responseError": { "type": "string" }, "processingError": { "type": "string" }, "sourceMap": { "type": "object", "additionalProperties": { "type": "object" } }, "messageContent": { "$ref": "#/components/schemas/MessageContent" }, "postProcessorError": { "type": "string" } } }, "ErrorContent": { "type": "object", "properties": { "encrypted": { "type": "boolean" }, "content": { "type": "string" }, "persisted": { "type": "boolean" } } }, "MapContent": { "type": "object", "properties": { "encrypted": { "type": "boolean" }, "content": { "type": "object" }, "persisted": { "type": "boolean" }, "map": { "type": "object", "additionalProperties": { "type": "object" } } } }, "Message": { "type": "object", "properties": { "messageId": { "type": "integer", "format": "int64" }, "serverId": { "type": "string" }, "channelId": { "type": "string" }, "channelName": { "type": "string" }, "receivedDate": { "type": "string", "format": "date-time" }, "processed": { "type": "boolean" }, "originalId": { "type": "integer", "format": "int64" }, "importId": { "type": "integer", "format": "int64" }, "importChannelId": { "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "connectorMessages": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectorMessage" } }, "mergedConnectorMessage": { "$ref": "#/components/schemas/ConnectorMessage" } } }, "MessageContent": { "type": "object", "properties": { "encrypted": { "type": "boolean" }, "channelId": { "type": "string" }, "messageId": { "type": "integer", "format": "int64" }, "metaDataId": { "type": "integer", "format": "int32" }, "contentType": { "type": "string", "enum": [ "Raw", "Processed Raw", "Transformed", "Encoded", "Sent", "Response", "Response Transformed", "Processed Response", "Connector Map", "Channel Map", "Response Map", "Processing Error", "Postprocessor Error", "Response Error", "Source Map" ] }, "content": { "type": "string" }, "dataType": { "type": "string" } } }, "MessageImportResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "successCount": { "type": "integer", "format": "int32" } } }, "RawMessage": { "type": "object", "properties": { "overwrite": { "type": "boolean" }, "imported": { "type": "boolean" }, "originalMessageId": { "type": "integer", "format": "int64" }, "rawData": { "type": "string" }, "rawBytes": { "type": "array", "items": { "type": "string", "format": "byte" } }, "destinationMetaDataIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "sourceMap": { "type": "object", "additionalProperties": { "type": "object" } }, "binary": { "type": "boolean" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } } } }, "SystemStats": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "cpuUsagePct": { "type": "number", "format": "double" }, "allocatedMemoryBytes": { "type": "integer", "format": "int64" }, "freeMemoryBytes": { "type": "integer", "format": "int64" }, "maxMemoryBytes": { "type": "integer", "format": "int64" }, "diskFreeBytes": { "type": "integer", "format": "int64" }, "diskTotalBytes": { "type": "integer", "format": "int64" } } }, "SystemInfo": { "type": "object", "properties": { "jvmVersion": { "type": "string" }, "osName": { "type": "string" }, "osVersion": { "type": "string" }, "osArchitecture": { "type": "string" }, "dbName": { "type": "string" }, "dbVersion": { "type": "string" } } }, "LoginStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "SUCCESS", "SUCCESS_GRACE_PERIOD", "FAIL", "FAIL_EXPIRED", "FAIL_LOCKED_OUT", "FAIL_VERSION_MISMATCH" ] }, "message": { "type": "string" }, "updatedUsername": { "type": "string" } } } } } }