swagger: "2.0"
info:
  description: "Qorus Integration Engine(R) REST API"
  version: "7.0"
  title: "Qorus REST API"
  contact:
    email: "info@qoretechnologies.com"
host: "localhost"
basePath: "/api/v7"
schemes:
- "https"
- "http"
produces:
- "text/x-yaml"
- "application/json"
consumes:
- "text/x-yaml"
- "application/json"
paths:
  /slas/{sla}:
    delete:
      summary: "Deletes the SLA from the system"
      description: "Deletes the SLA from the system"
      operationId: "delete-slas-{sla}"
      parameters:
      - in: "path"
        name: "sla"
        description: "path param \"sla\""
        required: true
        type: "string"
      responses:
        "200":
          description: "hash of the SLA created or of the existing SLA if all arguments match an existing SLA exactly"
          schema:
            $ref: "#/definitions/SlaInfo"
  /slas:
    post:
      summary: "Creates a system SLA according to the arguments"
      description: "Creates a system SLA according to the arguments"
      operationId: "post-slas"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-slas-body"
      responses:
        "200":
          description: "hash of the SLA created or of the existing SLA if all arguments match an existing SLA exactly"
          schema:
            $ref: "#/definitions/SlaInfo"
        "400":
          description: "the given SLA name already exists; invalid or missing argument"
          schema: {}
  /jobs/{id_or_name}/run:
    put:
      summary: "Runs a job and returns the results of job execution"
      description: "Runs a job and returns the results of job execution"
      operationId: "put-jobs-{id_or_name}-run"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "the result of job execution"
          schema:
            $ref: "#/definitions/JobExecResultInfo"
  /jobs/{id_or_name}/reset:
    put:
      summary: "Resets and reloads the current job"
      description: "Resets and reloads the current job by reloading its configuration in the metadata cache; if the job is currently running, then the reset will cause the job configuration to be reset as soon as it completes its current run."
      operationId: "put-jobs-{id_or_name}-reset"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a descriptive string for the operation"
          schema:
            type: "string"
        "409":
          description: "API-CALL-ERROR: cannot reset a disabled job"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /jobs/{id_or_name}/setExpiry:
    put:
      summary: "Updates the active status of a job"
      description: "Updates the expiry date of a job; if any errors occur an exception is thrown. This API works on all jobs regardless of state; the job does not have to be running or active to be updated. Removing the expiry date or setting a future expiry date from a job that is not started because it has expired will result in the job starting immediately (unless the job is inactive or a member of a disabled group. Setting a past expiry date on a currently-active job will stop the job immediately."
      operationId: "put-jobs-{id_or_name}-setExpiry"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-jobs-id_or_name-setExpiry-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash of information about the update operation"
          schema:
            $ref: "#/definitions/JobExpiryUpdateInfo"
  /jobs/{id_or_name}/schedule:
    put:
      summary: "Updates the schedule of a job"
      description: "Updates the schedule of a job; if any errors occur an exception is thrown. This API works on all jobs regardless of state; the job does not have to be running or active to be updated."
      operationId: "put-jobs-{id_or_name}-schedule"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-jobs-id_or_name-schedule-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash of information about the update operation"
          schema:
            $ref: "#/definitions/JobScheduleUpdateInfo"
  /jobs/{id_or_name}/enable:
    put:
      summary: "Enables the current job if it is disabled"
      description: "Enables the current job if it is disabled; if the job is already enabled, the action is reported as successful anyway"
      operationId: "put-jobs-{id_or_name}-enable"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/JobUpdateResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /jobs/{id_or_name}/disable:
    put:
      summary: "Disables the current job if it is disabled"
      description: "Disables the current job if it is enabled; if the job is already disabled, the action is reported as successful anyway"
      operationId: "put-jobs-{id_or_name}-disable"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/JobUpdateResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /system/listeners/{id_or_name}:
    get:
      summary: "Returns a hash of information about the current listener"
      description: "Returns a hash of information about the current listener"
      operationId: "get-system-listeners-{id_or_name}"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current listener"
          schema:
            $ref: "#/definitions/ListenerInfoHash"
  /system/listeners:
    get:
      summary: "Returns a hash of hashes providing information about HTTP listeners"
      description: "Returns a hash of hashes of information about HTTP listeners"
      operationId: "get-system-listeners"
      parameters: []
      responses:
        "200":
          description: "hash of hashes keyed by listener ID providing information about Qorus listeners"
          schema:
            $ref: "#/definitions/ListenerInfoSet"
  /system/wstoken:
    get:
      summary: "Returns an empty string in the Community Edition"
      description: "Returns an empty string in the Community Edition"
      operationId: "get-system-wstoken"
      parameters:
      - in: "query"
        name: "ttl"
        description: "ignored in the Community Edition"
        required: false
        type: "integer"
        format: "int64"
        x-nullable: true
      responses:
        "200":
          description: "an empty string in the Community Edition"
          schema:
            type: "string"
  /system/validateWsToken:
    get:
      summary: "Returns nothing in the Community Edition"
      description: "Returns nothing in the Community Edition; not implemented in the Community Edition"
      operationId: "get-system-validateWsToken"
      parameters:
      - in: "query"
        name: "token"
        description: "the token string"
        required: true
        type: "string"
      responses:
        "200":
          description: "returns nothing in the Community Edition"
          schema:
            type: "string"
            x-nullable: true
        "400":
          description: "missing \"token\" argument or invalid argument type"
          schema: {}
  /system/echo:
    put:
      summary: "Echos the argument(s) passed"
      description: "Echos the argument(s) passed"
      operationId: "put-system-echo"
      parameters:
      - in: "body"
        name: "body"
        description: "This API takes any arguments"
        required: false
        schema:
          type: "object"
      responses:
        "200":
          description: "all arguments are returned in the response body"
          schema:
            $ref: "#/definitions/AnyType"
  /system/ping:
    get:
      summary: "Returns \"OK\""
      description: "Returns \"OK\""
      operationId: "get-system-ping"
      parameters: []
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
  /system/rotateLogFiles:
    put:
      summary: "Rotates all system log files"
      description: "Rotates all system log files. The number of old log files kept is controlled by system option max-log-files . It is recommended to use the qorus-log-rotator service to rotate log files instead of calling this API method directly."
      operationId: "put-system-rotateLogFiles"
      parameters: []
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
  /system/reloadRbac:
    put:
      summary: "Reloads the all RBAC information (users, permissions, roles, groups) from the system schema"
      description: "Reloads the all RBAC information (users, permissions, roles, groups) from the system schema"
      operationId: "put-system-reloadRbac"
      parameters: []
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
  /system/shutdown:
    put:
      summary: "Starts the asynchronous system shutdown process"
      description: "This API will start the asynchronous shutdown process in the Qorus system. The response indicates only that the shutdown process has begun, and not that the system has been fully shut down. Check the log file or the process list to verify that the system has completely stopped."
      operationId: "put-system-shutdown"
      parameters: []
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
  /system/shutdownWait:
    put:
      summary: "Shuts down the system and returns when the system shutdown process is complete"
      description: "Shuts down the system and returns when the system shutdown process is complete"
      operationId: "put-system-shutdownWait"
      parameters: []
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
  /workflows/{id_or_name}/orders/{id}/cancel:
    put:
      summary: "Cancels the current workflow order data instance"
      description: "Blocks the current workflow order data instance by changing its status to CANCELED. An exception will be thrown if the status is IN-PROGRESS. No further processing can be done on workflow order data instances with a CANCELED status (unless the workflow order instance is recovered back from CANCELED to its original status or the status is first updated to ERROR and then to RETRY). Note that CANCELED and BLOCKED statuses have the same effect, however CANCELED is meant to be a permanent or final status, while BLOCKED is meant to be temporary."
      operationId: "put-workflows-{id_or_name}-orders-{id}-cancel-cancel"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/orders/{id}/uncancel:
    put:
      summary: "Resets the status of a canceled workflow order data instance to its original status"
      description: "Resets the status of a canceled workflow order data instance to its original status before canceling."
      operationId: "put-workflows-{id_or_name}-orders-{id}-uncancel-uncancel"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/orders/{id}/block:
    put:
      summary: "Blocks the current workflow order data instance"
      description: "Blocks the current workflow order data instance by changing its status to BLOCKED. An exception will be thrown if the status is IN-PROGRESS. No further processing can be done on workflow order data instances with a CANCELED status (unless the workflow order instance is recovered back from CANCELED to its original status or the status is first updated to ERROR and then to RETRY). Note that CANCELED and BLOCKED statuses have the same effect, however CANCELED is meant to be a permanent or final status, while BLOCKED is meant to be temporary."
      operationId: "put-workflows-{id_or_name}-orders-{id}-block-block"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/orders/{id}/unblock:
    put:
      summary: "Resets the status of a blocked workflow order data instance to its original status"
      description: "Resets the status of a blocked workflow order data instance to its original status before blocking."
      operationId: "put-workflows-{id_or_name}-orders-{id}-unblock-unblock"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/orders/{id}/notes:
    post:
      summary: "Creates an order note on the current workflow order"
      description: "Creates an order note on the current workflow order"
      operationId: "post-workflows-{id_or_name}-orders-{id}-notes-notes"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-orders-id-notes-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "OK"
          schema:
            type: "string"
  /workflows/{id_or_name}/orders/{id}/staticData:
    put:
      summary: "Replaces the static data for the current order"
      description: "Replaces the static data for the current order"
      operationId: "put-workflows-{id_or_name}-orders-{id}-staticData-staticData"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-orders-id-staticData-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "OK"
          schema:
            type: "string"
        "400":
          description: "invalid or missing argument"
          schema: {}
  /workflows/{id_or_name}/orders/{id}/dynamicData:
    put:
      summary: "Replaces the dynamic data for the current order"
      description: "Replaces the dynamic data for the current order"
      operationId: "put-workflows-{id_or_name}-orders-{id}-dynamicData-dynamicData"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-orders-id-dynamicData-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "OK"
          schema:
            type: "string"
        "400":
          description: "invalid or missing argument"
          schema: {}
  /workflows/{id_or_name}/orders/{id}/updateKeys:
    put:
      summary: "Replace all order keys for the current workflow order"
      description: "Replace all order keys for the current workflow order"
      operationId: "put-workflows-{id_or_name}-orders-{id}-updateKeys-updateKeys"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-orders-id-updateKeys-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "all order keys for the order after updating"
          schema:
            $ref: "#/definitions/OrderKeySet"
        "400":
          description: "invalid orderkeys argument"
          schema: {}
  /workflows/{id_or_name}/enable:
    put:
      summary: "Enables the current workflow if it is disabled"
      description: "Enables the current workflow if it is disabled; if the workflow is already enabled, the action is reported as successful anyway"
      operationId: "put-workflows-{id_or_name}-enable"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowUpdateResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/disable:
    put:
      summary: "Disables the current workflow if it is enabled"
      description: "Disables the current workflow if it is enabled; if the workflow is already disabled, the action is reported as successful anyway"
      operationId: "put-workflows-{id_or_name}-disable"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowUpdateResultInfo"
  /workflows/{id_or_name}/setAutostart:
    put:
      summary: "Sets the autostart attribute for the current workflow"
      description: "Sets the autostart attribute for the current workflow which specifies the targeted numbe of workflow execution instances to be running for the workflow at one time. If the new autostart value is higher than current one, and the workflow is eligible to be started, then new workflow execution instances will be started automatically, while reducing a workflow's autostart value will result in workflow execution instances being stopped immediately."
      operationId: "put-workflows-{id_or_name}-setAutostart"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-workflows-id_or_name-setAutostart-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowSetAutostartResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/incAutostart:
    put:
      summary: "Increments the autostart value for the current workflow"
      description: "Increments the autostart value for the current workflow; if the workflow is eligible to be started, an additional workflow execution instance is started immediately"
      operationId: "put-workflows-{id_or_name}-incAutostart"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowSetAutostartResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/decAutostart:
    put:
      summary: "Decrements the autostart value for the current workflow"
      description: "Decrements the autostart value for the current workflow; if the workflow is running, a running workflow execution instance is stopped immediately"
      operationId: "put-workflows-{id_or_name}-decAutostart"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowSetAutostartResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/reset:
    put:
      summary: "Resets and reloads the current workflow"
      description: "Resets and reloads the current workflow by reloading the configuration for the current workflow in the metadata cache; if there are any running execution instances, then the reset will cause the workflow configuration to be reset on their next iteration."
      operationId: "put-workflows-{id_or_name}-reset"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "the value \"OK\""
          schema:
            type: "string"
  /workflows/{id_or_name}/createOrder:
    post:
      summary: "Creates a workflow order data instance"
      description: "Creates a workflow order data instance for the current workflow with the data passed as arguments. To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee the uniqueness of the order: - global_unique_key - workflow_specific_unique_key - workflow_unique_key"
      operationId: "post-workflows-{id_or_name}-createOrder"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-workflows-id_or_name-createOrder-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "201":
          description: "describes the workflow order created"
          schema:
            $ref: "#/definitions/WorkflowOrderCreateInfo"
        "409":
          description: "exception processing create order request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/execSynchronous:
    post:
      summary: "Creates a new order for the current workflow and executes it synchronous mode."
      description: "Creates a new order for the current workflow and executes it synchronous mode. This API call will return only after the workflow order reaches a COMPLETE or ERROR state, unless the system or the workflow order data instance are manually stopped while the workflow order data instance is being processed, in which case other statuses can be returned. To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee the uniqueness of the order: - global_unique_key - workflow_specific_unique_key - workflow_unique_key"
      operationId: "post-workflows-{id_or_name}-execSynchronous"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-workflows-id_or_name-execSynchronous-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "201":
          description: "describes the workflow order created"
          schema:
            $ref: "#/definitions/WorkflowOrderExecutionInfo"
        "409":
          description: "exception processing create order request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /orders/{id}/cancel:
    put:
      summary: "Cancels the current workflow order data instance"
      description: "Blocks the current workflow order data instance by changing its status to CANCELED. An exception will be thrown if the status is IN-PROGRESS. No further processing can be done on workflow order data instances with a CANCELED status (unless the workflow order instance is recovered back from CANCELED to its original status or the status is first updated to ERROR and then to RETRY). Note that CANCELED and BLOCKED statuses have the same effect, however CANCELED is meant to be a permanent or final status, while BLOCKED is meant to be temporary."
      operationId: "put-orders-{id}-cancel-cancel"
      parameters:
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /orders/{id}/uncancel:
    put:
      summary: "Resets the status of a canceled workflow order data instance to its original status"
      description: "Resets the status of a canceled workflow order data instance to its original status before canceling."
      operationId: "put-orders-{id}-uncancel-uncancel"
      parameters:
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /orders/{id}/block:
    put:
      summary: "Blocks the current workflow order data instance"
      description: "Blocks the current workflow order data instance by changing its status to BLOCKED. An exception will be thrown if the status is IN-PROGRESS. No further processing can be done on workflow order data instances with a CANCELED status (unless the workflow order instance is recovered back from CANCELED to its original status or the status is first updated to ERROR and then to RETRY). Note that CANCELED and BLOCKED statuses have the same effect, however CANCELED is meant to be a permanent or final status, while BLOCKED is meant to be temporary."
      operationId: "put-orders-{id}-block-block"
      parameters:
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /orders/{id}/unblock:
    put:
      summary: "Resets the status of a blocked workflow order data instance to its original status"
      description: "Resets the status of a blocked workflow order data instance to its original status before blocking."
      operationId: "put-orders-{id}-unblock-unblock"
      parameters:
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "provides status information about the order processed"
          schema:
            $ref: "#/definitions/WorkflowOrderStatusInfo"
        "409":
          description: "exception processing request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /orders/{id}/notes:
    post:
      summary: "Creates an order note on the current workflow order"
      description: "Creates an order note on the current workflow order"
      operationId: "post-orders-{id}-notes-notes"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-orders-id-notes-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "OK"
          schema:
            type: "string"
  /orders/{id}/staticData:
    put:
      summary: "Replaces the static data for the current order"
      description: "Replaces the static data for the current order"
      operationId: "put-orders-{id}-staticData-staticData"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-orders-id-staticData-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "OK"
          schema:
            type: "string"
        "400":
          description: "invalid or missing argument"
          schema: {}
  /orders/{id}/dynamicData:
    put:
      summary: "Replaces the dynamic data for the current order"
      description: "Replaces the dynamic data for the current order"
      operationId: "put-orders-{id}-dynamicData-dynamicData"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-orders-id-dynamicData-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "OK"
          schema:
            type: "string"
        "400":
          description: "invalid or missing argument"
          schema: {}
  /orders/{id}/updateKeys:
    put:
      summary: "Replace all order keys for the current workflow order"
      description: "Replace all order keys for the current workflow order"
      operationId: "put-orders-{id}-updateKeys-updateKeys"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-orders-id-updateKeys-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "all order keys for the order after updating"
          schema:
            $ref: "#/definitions/OrderKeySet"
        "400":
          description: "invalid orderkeys argument"
          schema: {}
  /orders/{id}/sensitiveData:
    put:
      summary: "Replaces the sensitive data for the current order"
      description: "Replaces the sensitive data for the current order given the sensitive data key and"
      operationId: "put-orders-{id}-sensitiveData"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-orders-id-sensitiveData-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
        "400":
          description: "invalid arguments or request made over a non-encrypted connection"
          schema: {}
  /async-queues/{queue}/update:
    post:
      summary: "Updates an asynchronous queue entry to allow an asynchronous step to continue processing"
      description: "Updates a pending entry in a system queue with status WAITING and sets the status to RECEIVED. Data is stored serialized in YAML format so that type information is preserved when passed to the asynchronous step back end function"
      operationId: "post-async-queues-{queue}-update"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-async-queues-queue-update-body"
      - in: "path"
        name: "queue"
        description: "path param \"queue\""
        required: true
        type: "string"
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
        "400":
          description: "invalid argument, invalid status in queue entry"
          schema: {}
        "404":
          description: "unknown queue or queue key"
          schema: {}
  /orders/{id}/lockUserInteractionStep:
    post:
      summary: "Locks the next available queue entry in a user interaction step"
      description: "Qorus 4.0.1"
      operationId: "post-orders-{id}-lockUserInteractionStep"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_post-orders-id-lockUserInteractionStep-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowLockUseInteractionStepResultInfo"
        "400":
          description: "missing or invalid arguments"
          schema: {}
        "404":
          description: "no data available on the queue to lock"
          schema: {}
  /orders/{id}/stepData:
    put:
      summary: "Replaces the dynamic step data for an existing order step"
      description: "Qorus 4.0.1"
      operationId: "put-orders-{id}-stepData"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-orders-id-stepData-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
        "400":
          description: "invalid arguments"
          schema: {}
        "409":
          description: "cannot lock order for updating, order has COMPLETE status"
          schema:
            $ref: "#/definitions/UndefinedHash"
    get:
      summary: "Returns dynamic step data for the order and step instance"
      description: "Qorus 4.0.1"
      operationId: "get-orders-{id}-stepData"
      parameters:
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "the workflow order dynamic step data for the given step instance"
          schema:
            $ref: "#/definitions/_UndefinedHash"
        "404":
          description: "the given stepid and ind values do not exist in the workflow order"
          schema: {}
  /orders/{id}/releaseUserInteractionStepLock:
    post:
      summary: "Releases a lock owned by the calling user on a step supporting user interaction"
      description: "Qorus 4.0.1"
      operationId: "post-orders-{id}-releaseUserInteractionStepLock"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-orders-id-releaseUserInteractionStepLock-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
        "400":
          description: "invalid arguments"
          schema: {}
        "404":
          description: "the given stepid and ind values do not exist in the workflow order or the step is not an asynchronous step with the user-interaction API enabled"
          schema: {}
  /orders/{id}/breakUserInteractionStepLock:
    post:
      summary: "Forcibly releases a lock on a step supporting user interaction"
      description: "Qorus 4.0.1"
      operationId: "post-orders-{id}-breakUserInteractionStepLock"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-orders-id-breakUserInteractionStepLock-body"
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "\"OK\""
          schema:
            type: "string"
        "400":
          description: "invalid arguments"
          schema: {}
        "404":
          description: "the given stepid and ind values do not exist in the workflow order or the step is not an asynchronous step with the user-interaction API enabled"
          schema: {}
  /workflows/{id_or_name}/setRemote:
    put:
      summary: "Sets the 'remote' attribute for the current workflow"
      description: "Sets the 'remote' attribute for the current workflow, determining if it will run in a separate remote qwf process or locally in qorus-core. Workflows updated with this API are disabled before the change and reenabled after the change."
      operationId: "put-workflows-{id_or_name}-setRemote"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-workflows-id_or_name-setRemote-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowSetRemoteResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}/setSla:
    put:
      summary: "Sets the SLA attribute for the current workflow"
      description: "Sets the SLA attribute for the current workflow which specifies the maximum targeted time a workflow order should get a final status (being one of COMPLETE or CANCELED)"
      operationId: "put-workflows-{id_or_name}-setSla"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-workflows-id_or_name-setSla-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowSetSlaResultInfo"
        "409":
          description: "exception processing the request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /workflows/{id_or_name}:
    get:
      summary: "Returns information about the current workflow"
      description: "Returns information about the current workflow"
      operationId: "get-workflows-{id_or_name}"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current workflow"
          schema:
            $ref: "#/definitions/WorkflowDefinitionInfoV3"
  /workflows/{id_or_name}/kill:
    post:
      summary: "Kills a remote workflow cluster process"
      description: "Kills a remote workflow cluster process"
      operationId: "post-workflows-{id_or_name}-kill"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/KillResultInfo"
        "404":
          description: "if no remote process is running for the workflow"
          schema: {}
  /workflows/{id_or_name}/lockUserInteractionStep:
    post:
      summary: "Locks the next available queue entry in a user interaction step"
      description: "Locks the next available queue entry eligible for user interaction for the named step and returns the step information or a 404 Not Found error if no such data is available"
      operationId: "post-workflows-{id_or_name}-lockUserInteractionStep"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_post-workflows-id_or_name-lockUserInteractionStep-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/WorkflowLockUseInteractionStepResultInfo"
        "400":
          description: "missing or invalid arguments"
          schema: {}
        "404":
          description: "no data available on the queue to lock"
          schema: {}
  /jobs/{id_or_name}/setActive:
    put:
      summary: "Updates the active status of a job"
      description: "Updates the active status of a job; if any errors occur an exception is thrown. \\n"
      operationId: "put-jobs-{id_or_name}-setActive"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-jobs-id_or_name-setActive-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash of information about the update operation"
          schema:
            $ref: "#/definitions/JobActiveUpdateInfo"
        "409":
          description: "JOB-ERROR: cannot set expired jobs to active"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /jobs/{id_or_name}/setRemote:
    put:
      summary: "Updates the remote status of a job"
      description: "Updates the remote status of a job, determining if a job runs in a remote process or not. Jobs that have their remote value changed are temporarily disabled and then reenabled after the change."
      operationId: "put-jobs-{id_or_name}-setRemote"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-jobs-id_or_name-setRemote-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash of information about the update operation"
          schema:
            $ref: "#/definitions/JobRemoteUpdateInfo"
  /jobs/{id_or_name}/kill:
    post:
      summary: "Kills a remote job cluster process"
      description: "Kills a remote job cluster process"
      operationId: "post-jobs-{id_or_name}-kill"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/KillResultInfo"
        "404":
          description: "if no remote process is running for the job"
          schema: {}
  /system:
    get:
      summary: "Returns a hash of system information"
      description: "Returns a hash of system information"
      operationId: "get-system"
      parameters: []
      responses:
        "200":
          description: "Current system information"
          schema:
            $ref: "#/definitions/QorusSystemInfo"
  /jobs/{id_or_name}:
    get:
      summary: "Returns a hash of information about the current job"
      description: "Returns a hash of information about the current job"
      operationId: "get-jobs-{id_or_name}"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash of information about the current job"
          schema:
            $ref: "#/definitions/JobDetailInfo"
  /workflows/{id_or_name}/execSynchronousAsync:
    post:
      summary: "Creates a new order for the current workflow and executes it synchronous mode."
      description: "Creates a new order for the current workflow and executes it synchronous mode in a background thread. The call returns as soon as the order instance has been created and returns the workflow_instanceid for the new workflow order as well as the new execution ID. To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee the uniqueness of the order: - global_unique_key - workflow_specific_unique_key - workflow_unique_key"
      operationId: "post-workflows-{id_or_name}-execSynchronousAsync"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-workflows-id_or_name-execSynchronousAsync-body"
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "201":
          description: "describes the workflow order created"
          schema:
            $ref: "#/definitions/WorkflowOrderExecutionAsyncInfo"
        "409":
          description: "exception processing create order request"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /dataprovider/factories/{factory}/provider:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-dataprovider-factories-{factory}-provider"
      parameters:
      - in: "path"
        name: "factory"
        description: "path param \"factory\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /remote/datasources/{name}/provider:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-remote-datasources-{name}-provider"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /remote/qorus/{name}/provider:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-remote-qorus-{name}-provider"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /remote/user/{name}/provider:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-remote-user-{name}-provider"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /dataprovider/compareTypes:
    put:
      summary: "Compares two types for assignment compatibility"
      description: "Compares two types for assignment compatibility; takes a base_type and a type argument and returns"
      operationId: "put-dataprovider-compareTypes"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-dataprovider-compareTypes-body"
      responses:
        "200":
          description: "True if type can be assigned to base_type, False if not"
          schema:
            type: "boolean"
        "400":
          description: "missing or invalid types argument; non-unique name in types list"
          schema: {}
        "404":
          description: "the given type, factory, connection, etc cannot be found"
          schema: {}
  /dataprovider/compareManyTypes:
    put:
      summary: "Compares multiple types for compatibility and returns the result of each comparison"
      description: "Takes a list of hashes in types giving type and base_type information to compare and returns a list of the results of each comparison."
      operationId: "put-dataprovider-compareManyTypes"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-dataprovider-compareManyTypes-body"
      responses:
        "200":
          description: "Returns a hash keyed by hash keys in the types argument where the values are boolean values of the results of the type comparisons"
          schema:
            $ref: "#/definitions/QorusBooleanSetInfo"
        "400":
          description: "missing or invalid types argument; non-unique name in types list"
          schema: {}
        "404":
          description: "the given type, factory, connection, etc cannot be found"
          schema: {}
  /orders/{id}:
    get:
      summary: "Returns information about the current workflow order data instance"
      description: "Returns information about the current workflow order data instance"
      operationId: "get-orders-{id}"
      parameters:
      - in: "path"
        name: "id"
        description: "path param \"id\""
        required: true
        type: "string"
      responses:
        "200":
          description: "detailed information about the workflow order"
          schema:
            $ref: "#/definitions/WorkflowOrderInfo"
  /system/templates:
    get:
      summary: "Returns template information"
      description: "Returns template information"
      operationId: "get-system-templates"
      parameters:
      - in: "query"
        name: "filter"
        description: "a bitfield of TemplateContextValues to filter the results: 1: workflow context, 2: service context, 4: job context, 8: generic context, 7: interface context, 15: all contexts"
        required: false
        type: "integer"
        format: "int64"
        x-nullable: true
      responses:
        "200":
          description: "a list of template info hashes"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/TemplateInfo"
            x-nullable: true
  /dataprovider/factories/{factory}/provider/apiEndpoints:
    put:
      summary: "Returns a list of request/response endpoint information for the data provider"
      description: "Returns a list of request/response endpoint information for the data provider"
      operationId: "put-dataprovider-factories-{factory}-provider-apiEndpoints"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-factories-factory-provider-apiEndpoints-body"
      - in: "path"
        name: "factory"
        description: "path param \"factory\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a list of API endpoints supported by the data provider"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/EndpointInfo"
  /dataprovider/factories/{factory}/provider/Description:
    put:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "put-dataprovider-factories-{factory}-provider-Description"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-factories-factory-provider-Description-body"
      - in: "path"
        name: "factory"
        description: "path param \"factory\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /dataprovider/factories/{factory}/provider/childDetails:
    put:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "put-dataprovider-factories-{factory}-provider-childDetails"
      parameters:
      - in: "path"
        name: "factory"
        description: "path param \"factory\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
    get:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "get-dataprovider-factories-{factory}-provider-childDetails"
      parameters:
      - in: "path"
        name: "factory"
        description: "path param \"factory\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /connections/{name}/provider:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-connections-{name}-provider"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /connections/{name}/provider/apiEndpoints:
    put:
      summary: "Returns a list of request/response endpoint information for the data provider"
      description: "Returns a list of request/response endpoint information for the data provider"
      operationId: "put-connections-{name}-provider-apiEndpoints-apiEndpoints"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-factories-factory-provider-apiEndpoints-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a list of API endpoints supported by the data provider"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/EndpointInfo"
  /connections/{name}/provider/Description:
    put:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "put-connections-{name}-provider-Description-Description"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-factories-factory-provider-Description-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /connections/{name}/provider/childDetails:
    put:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "put-connections-{name}-provider-childDetails-childDetails"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
    get:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "get-connections-{name}-provider-childDetails-childDetails"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type; also ui: to return a format for the UI"
        required: false
        type: "array"
        items:
          type: "string"
        x-nullable: true
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/factory/{provider}:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-factory-{provider}"
      parameters:
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-factory-{provider}"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-body"
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/factory/{provider}/info:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-factory-{provider}-info"
      parameters:
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
    put:
      summary: "Returns information about the current DataProvider"
      description: "Returns information about the current DataProvider"
      operationId: "put-dataprovider-browse-factory-{provider}-info"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-body"
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/factory/{provider}/info/apiEndpoints:
    put:
      summary: "Returns a list of request/response endpoint information for the data provider"
      description: "Returns a list of request/response endpoint information for the data provider"
      operationId: "put-dataprovider-browse-factory-{provider}-info-apiEndpoints"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-apiEndpoints-body"
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a list of API endpoints supported by the data provider"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/EndpointInfo"
  /dataprovider/browse/factory/{provider}/info/Description:
    put:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-factory-{provider}-info-Description"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-Description-body"
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /dataprovider/browse/factory/{provider}/info/childDetails:
    put:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-factory-{provider}-info-childDetails"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-childDetails-body"
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
    get:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-factory-{provider}-info-childDetails"
      parameters:
      - in: "path"
        name: "provider"
        description: "path param \"provider\""
        required: true
        type: "string"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/factory:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-factory"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-factory"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/factory/info:
    get:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "get-dataprovider-browse-factory-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
    put:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "put-dataprovider-browse-factory-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
  /dataprovider/browse/connection/{connection}:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-connection-{connection}"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "connection"
        description: "path param \"connection\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-connection-{connection}"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "connection"
        description: "path param \"connection\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/connection/{connection}/info:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-connection-{connection}-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "connection"
        description: "path param \"connection\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/connection/{connection}/info/apiEndpoints:
    put:
      summary: "Returns a list of request/response endpoint information for the data provider"
      description: "Returns a list of request/response endpoint information for the data provider"
      operationId: "put-dataprovider-browse-connection-{connection}-info-apiEndpoints-apiEndpoints"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-apiEndpoints-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "connection"
        description: "path param \"connection\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a list of API endpoints supported by the data provider"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/EndpointInfo"
  /dataprovider/browse/connection/{connection}/info/Description:
    put:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-connection-{connection}-info-Description-Description"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-Description-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "connection"
        description: "path param \"connection\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /dataprovider/browse/connection/{connection}/info/childDetails:
    put:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-connection-{connection}-info-childDetails-childDetails"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-childDetails-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "connection"
        description: "path param \"connection\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
    get:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-connection-{connection}-info-childDetails-childDetails"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "connection"
        description: "path param \"connection\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/connection:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-connection"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-connection"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/connection/info:
    get:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "get-dataprovider-browse-connection-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
    put:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "put-dataprovider-browse-connection-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
  /dataprovider/browse/datasource/{datasource}:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-datasource-{datasource}"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "datasource"
        description: "path param \"datasource\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-datasource-{datasource}"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "datasource"
        description: "path param \"datasource\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/datasource/{datasource}/info:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-datasource-{datasource}-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "datasource"
        description: "path param \"datasource\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/datasource/{datasource}/info/apiEndpoints:
    put:
      summary: "Returns a list of request/response endpoint information for the data provider"
      description: "Returns a list of request/response endpoint information for the data provider"
      operationId: "put-dataprovider-browse-datasource-{datasource}-info-apiEndpoints-apiEndpoints"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-apiEndpoints-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "datasource"
        description: "path param \"datasource\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a list of API endpoints supported by the data provider"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/EndpointInfo"
  /dataprovider/browse/datasource/{datasource}/info/Description:
    put:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-datasource-{datasource}-info-Description-Description"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-Description-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "datasource"
        description: "path param \"datasource\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /dataprovider/browse/datasource/{datasource}/info/childDetails:
    put:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-datasource-{datasource}-info-childDetails-childDetails"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-childDetails-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "datasource"
        description: "path param \"datasource\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
    get:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-datasource-{datasource}-info-childDetails-childDetails"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "datasource"
        description: "path param \"datasource\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/datasource:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-datasource"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-datasource"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/datasource/info:
    get:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "get-dataprovider-browse-datasource-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
    put:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "put-dataprovider-browse-datasource-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
  /dataprovider/browse/remote/{remote}:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-remote-{remote}"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "remote"
        description: "path param \"remote\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-remote-{remote}"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "remote"
        description: "path param \"remote\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/remote/{remote}/info:
    get:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-remote-{remote}-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "remote"
        description: "path param \"remote\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/remote/{remote}/info/apiEndpoints:
    put:
      summary: "Returns a list of request/response endpoint information for the data provider"
      description: "Returns a list of request/response endpoint information for the data provider"
      operationId: "put-dataprovider-browse-remote-{remote}-info-apiEndpoints-apiEndpoints"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-apiEndpoints-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "remote"
        description: "path param \"remote\""
        required: true
        type: "string"
      responses:
        "200":
          description: "a list of API endpoints supported by the data provider"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/EndpointInfo"
  /dataprovider/browse/remote/{remote}/info/Description:
    put:
      summary: "Returns data provider information"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-remote-{remote}-info-Description-Description"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-Description-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "remote"
        description: "path param \"remote\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderInfo"
  /dataprovider/browse/remote/{remote}/info/childDetails:
    put:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "put-dataprovider-browse-remote-{remote}-info-childDetails-childDetails"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-browse-factory-provider-info-childDetails-body"
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "remote"
        description: "path param \"remote\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
    get:
      summary: "Returns data provider information with details in the children key"
      description: "Returns data provider information"
      operationId: "get-dataprovider-browse-remote-{remote}-info-childDetails-childDetails"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      - in: "path"
        name: "remote"
        description: "path param \"remote\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the current data provider"
          schema:
            $ref: "#/definitions/DataProviderChildDetailInfo"
  /dataprovider/browse/remote:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse-remote"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-remote"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/remote/info:
    get:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "get-dataprovider-browse-remote-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
    put:
      summary: "Returns information about the current navigation node"
      description: "Returns information about the current navigation node"
      operationId: "put-dataprovider-browse-remote-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
  /dataprovider/browse/type:
    get:
      summary: "Returns information on available paths to child types, if any"
      description: "Returns information on available paths to child types, if any"
      operationId: "get-dataprovider-browse-type"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse-type"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/type/info:
    get:
      summary: "Returns information about the current DataProvider"
      description: "Returns information about the current DataProvider"
      operationId: "get-dataprovider-browse-type-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider type, if the node has a type, otherwise with basic information about the nav node"
          schema:
            $ref: "#/definitions/UndefinedHash"
    put:
      summary: "Returns information about the current DataProvider"
      description: "Returns information about the current DataProvider"
      operationId: "put-dataprovider-browse-type-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider type, if the node has a type, otherwise with basic information about the nav node"
          schema:
            $ref: "#/definitions/UndefinedHash"
  /dataprovider/browse:
    get:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "get-dataprovider-browse"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
    put:
      summary: "Returns information on available paths to types or data providers according to the requesting context"
      description: "Returns information on available paths to types or data providers according to the requesting context"
      operationId: "put-dataprovider-browse"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash providing information about the current node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNodeInfo"
  /dataprovider/browse/info:
    get:
      summary: "Returns information about the current DataProvider"
      description: "Returns information about the current DataProvider"
      operationId: "get-dataprovider-browse-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
    put:
      summary: "Returns information about the current DataProvider"
      description: "Returns information about the current DataProvider"
      operationId: "put-dataprovider-browse-info"
      parameters:
      - in: "query"
        name: "context"
        description: "one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, type: when browsing for a type"
        required: false
        type: "string"
        x-nullable: true
      responses:
        "200":
          description: "a hash with basic info about the current data provider nav node"
          schema:
            $ref: "#/definitions/DataProviderBrowseNavInfo"
  /connections/{name}/enableDebugData:
    put:
      summary: "Enables data debugging for a user connection"
      description: "Enables data debugging for a user connection (and only for user connections)"
      operationId: "put-connections-{name}-enableDebugData"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/ConnectionUpdateResultInfo"
  /connections/{name}/disableDebugData:
    put:
      summary: "Disables data debugging for a user connection"
      description: "Disables data debugging for a user connection (and only for user connections)"
      operationId: "put-connections-{name}-disableDebugData"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/ConnectionUpdateResultInfo"
  /connections/{name}/enable:
    put:
      summary: "Enables the current connection if it is disabled"
      description: "Enables the current user connection, datasource, or remote Qorus connection if it is disabled; if the connection is already enabled, the action is reported as successful anyway"
      operationId: "put-connections-{name}-enable"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/ConnectionUpdateResultInfo"
  /connections/{name}/disable:
    put:
      summary: "Disables the current connection if it is enabled"
      description: "Disables the current user connection, datasource, or remote Qorus connection if it is enabled; if the connection is already disabled, the action is reported as successful anyway"
      operationId: "put-connections-{name}-disable"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/ConnectionUpdateResultInfo"
  /connections/{name}/ping:
    put:
      summary: "Pings the current connection"
      description: "Checks connectivity to the current user connection, datasource, or remote Qorus connection; if the connection was up and is monitored to be down, then any dependent interfaces will be disabled. If the connection was down and is monitored to be up, then any eligible interfaces will be reenabled."
      operationId: "put-connections-{name}-ping"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "the result of the ping operation"
          schema:
            $ref: "#/definitions/PingResultInfo"
  /connections/{name}:
    get:
      summary: "Returns information about the current connection"
      description: "Returns a hash information for the current user connection, datasource, or remote Qorus connection"
      operationId: "get-connections-{name}"
      parameters:
      - in: "query"
        name: "with_password"
        description: "include the password in the \"url\" and \"url_hash\" keys"
        required: false
        type: "boolean"
        x-nullable: true
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the connection"
          schema:
            $ref: "#/definitions/ConnectionInfo"
    put:
      summary: "Modifies the current connection"
      description: "Modifies the current user connection, datasource, or remote Qorus connection"
      operationId: "put-connections-{name}"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-connections-name-body"
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/ConnectionUpdateResultInfo"
        "403":
          description: "access or authorization error"
          schema: {}
        "409":
          description: "error executing the change"
          schema:
            $ref: "#/definitions/UndefinedHash"
    delete:
      summary: "Deletes the current connection"
      description: "Permanently deletes the current user connection, datasource, or remote Qorus connection"
      operationId: "delete-connections-{name}"
      parameters:
      - in: "path"
        name: "name"
        description: "path param \"name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "information about the result of the operation"
          schema:
            $ref: "#/definitions/ConnectionUpdateResultInfo"
  /system/listeners/{id_or_name}/reloadCertificate:
    post:
      summary: "Reloads the certificate and private key from the original file locations and uses the new certificate for new connections"
      description: "Reloads the certificate and private key from the original file locations and uses the new certificate for new connections"
      operationId: "post-system-listeners-{id_or_name}-reloadCertificate"
      parameters:
      - in: "path"
        name: "id_or_name"
        description: "path param \"id_or_name\""
        required: true
        type: "string"
      responses:
        "200":
          description: "the string \"OK\""
          schema:
            type: "string"
        "401":
          description: "listener is not an HTTPS listener or no certificate source location information is stored against the listener"
          schema: {}
  /dataprovider/factories/{factory}/provider/search:
    put:
      summary: "Searches for records matching the search parameters"
      description: "Searches for records matching the search parameters"
      operationId: "put-dataprovider-factories-{factory}-provider-search"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: false
        schema:
          $ref: "#/definitions/_put-dataprovider-factories-factory-provider-search-body"
      - in: "path"
        name: "factory"
        description: "path param \"factory\""
        required: true
        type: "string"
      responses:
        "200":
          description: "list of record hashes matching the search parameters given by where_cond"
          schema:
            $ref: "#/definitions/_UndefinedHash"
        "400":
          description: "the data provider does not support searching"
          schema: {}
        "403":
          description: "AUTHORIZATION-ERROR: this exception is thrown when RBAC is enabled, and the user does not have sufficient privileges for the operation"
          schema: {}
  /dataprovider/factories/{factory}/provider/providerCreate:
    post:
      summary: "Creates a child data provider"
      description: "This API creates a child data provider, if the data provider supports child creation"
      operationId: "post-dataprovider-factories-{factory}-provider-providerCreate"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-factories-factory-provider-providerCreate-body"
      - in: "path"
        name: "factory"
        description: "path param \"factory\""
        required: true
        type: "string"
      responses:
        "200":
          description: "the string \"OK\""
          schema:
            type: "string"
        "400":
          description: "returned if the request has no name or fields keys or if the data provider does not support the current operation"
          schema: {}
  /slas/{sla}/success:
    post:
      summary: "Posts a success event for the SLA"
      description: "Posts a success event for the SLA"
      operationId: "post-slas-{sla}-success"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-slas-sla-success-body"
      - in: "path"
        name: "sla"
        description: "path param \"sla\""
        required: true
        type: "string"
      responses:
        "200":
          description: "true if the event was posted"
          schema:
            type: "boolean"
  /slas/{sla}/error:
    post:
      summary: "Posts an error event for the SLA"
      description: "Posts an error event for the SLA"
      operationId: "post-slas-{sla}-error"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-slas-sla-error-body"
      - in: "path"
        name: "sla"
        description: "path param \"sla\""
        required: true
        type: "string"
      responses:
        "200":
          description: "true if the event was posted"
          schema:
            type: "boolean"
  /dataprovider/type:
    put:
      summary: "Returns type information for the given data provider information"
      description: "Returns type information for the given data provider information"
      operationId: "put-dataprovider-type"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/put-dataprovider-type-body"
      responses:
        "200":
          description: "data provider type information"
          schema:
            $ref: "#/definitions/DataProviderTypeInfo"
  /dataprovider/callApi:
    post:
      summary: "Makes an API call and returns the response"
      description: "Makes an API call with a request-response data provider and returns the response"
      operationId: "post-dataprovider-callApi"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-callApi-body"
      responses:
        "200":
          description: "the return value of the API call"
          schema:
            $ref: "#/definitions/AnyType"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/callApiFromUi:
    post:
      summary: "Makes an API call and returns the response"
      description: "Makes an API call with a request-response data provider and returns the response; certain arguments are expected in a format used by UI clients"
      operationId: "post-dataprovider-callApiFromUi"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-callApiFromUi-body"
      responses:
        "200":
          description: "the return value of the API call"
          schema:
            $ref: "#/definitions/AnyType"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/searchRecords:
    post:
      summary: "Performs a search in a data provider and returns the result record set"
      description: "Performs a search in a record-based data provider and returns the result as a list of zero or more hashes representing the records matched"
      operationId: "post-dataprovider-searchRecords"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-searchRecords-body"
      responses:
        "200":
          description: "the records matching the search criteria"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/UndefinedHash"
            x-nullable: true
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/searchRecordsFromUi:
    post:
      summary: "Performs a search in a data provider and returns the result record set"
      description: "Performs a search in a record-based data provider and returns the result as a list of zero or more hashes representing the records matched; certain arguments are expected in a format used by UI clients"
      operationId: "post-dataprovider-searchRecordsFromUi"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-searchRecordsFromUi-body"
      responses:
        "200":
          description: "the records matching the search criteria"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/UndefinedHash"
            x-nullable: true
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/searchSingleRecord:
    post:
      summary: "Performs a search in a data provider and returns the result record or no value"
      description: "Performs a search in a record-based data provider and returns the result record, if there is a match, or no value if not"
      operationId: "post-dataprovider-searchSingleRecord"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-searchSingleRecord-body"
      responses:
        "200":
          description: "the record matching the search criteria or no value if there is no match"
          schema:
            $ref: "#/definitions/_UndefinedHash"
        "400":
          description: "missing or invalid required arguments or if multiple records match the search criteria"
          schema: {}
  /dataprovider/searchSingleRecordFromUi:
    post:
      summary: "Performs a search in a data provider and returns the result record or no value"
      description: "Performs a search in a record-based data provider and returns the result record, if there is a match, or no value if not; certain arguments are expected in a format used by UI clients"
      operationId: "post-dataprovider-searchSingleRecordFromUi"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-searchSingleRecordFromUi-body"
      responses:
        "200":
          description: "the record matching the search criteria or no value if there is no match"
          schema:
            $ref: "#/definitions/_UndefinedHash"
        "400":
          description: "missing or invalid required arguments or if multiple records match the search criteria"
          schema: {}
  /dataprovider/updateRecords:
    post:
      summary: "Performs an update action in a data provider and returns the number of records updated"
      description: "Performs an update action in a data provider and returns the number of records updated"
      operationId: "post-dataprovider-updateRecords"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-updateRecords-body"
      responses:
        "200":
          description: "a hash describing the number of records affected by the operation"
          schema:
            $ref: "#/definitions/AffectedRecordInfo"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/updateRecordsFromUi:
    post:
      summary: "Performs an update action in a data provider and returns the number of records updated"
      description: "Performs an update action in a data provider and returns the number of records updated"
      operationId: "post-dataprovider-updateRecordsFromUi"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-updateRecordsFromUi-body"
      responses:
        "200":
          description: "a hash describing the number of records affected by the operation"
          schema:
            $ref: "#/definitions/AffectedRecordInfo"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/deleteRecords:
    post:
      summary: "Deletes records from a data provider and returns the number of deleted records"
      description: "Deletes records from a data provider and returns the number of deleted records"
      operationId: "post-dataprovider-deleteRecords"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-deleteRecords-body"
      responses:
        "200":
          description: "a hash describing the number of records affected by the operation"
          schema:
            $ref: "#/definitions/AffectedRecordInfo"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/deleteRecordsFromUi:
    post:
      summary: "Deletes records from a data provider and returns the number of deleted records"
      description: "Deletes records from a data provider and returns the number of deleted records"
      operationId: "post-dataprovider-deleteRecordsFromUi"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-deleteRecordsFromUi-body"
      responses:
        "200":
          description: "a hash describing the number of records affected by the operation"
          schema:
            $ref: "#/definitions/AffectedRecordInfo"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/createRecords:
    post:
      summary: "Creates new records in a data provider and returns the number of created records"
      description: "Creates new records in a data provider and returns the number of created records"
      operationId: "post-dataprovider-createRecords"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-createRecords-body"
      responses:
        "200":
          description: "the record set inserted"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/UndefinedHash"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
  /dataprovider/createRecordsFromUi:
    post:
      summary: "Creates new records in a data provider and returns the number of created records"
      description: "Creates new records in a data provider and returns the number of created records"
      operationId: "post-dataprovider-createRecordsFromUi"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-dataprovider-createRecordsFromUi-body"
      responses:
        "200":
          description: "the record set inserted"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/UndefinedHash"
        "400":
          description: "missing or invalid required arguments"
          schema: {}
definitions:
  SlaInfo:
    type: "object"
    required:
    - "slaid"
    - "name"
    - "units"
    - "description"
    properties:
      slaid:
        type: "integer"
        format: "int64"
        description: "the ID of the SLA"
      name:
        type: "string"
        description: "the name of the SLA"
      units:
        type: "string"
        description: "describes the meaning of SLA event values (allowed values: \"seconds\" and \"other\")"
      description:
        type: "string"
        description: "the description of the SLA"
      methods:
        type: "array"
        items:
          $ref: "#/definitions/SlaServicveMethodInfo"
        x-nullable: true
        description: "list of service methods with the SLA"
      jobs:
        type: "array"
        items:
          $ref: "#/definitions/SlaJobInfo"
        x-nullable: true
        description: "list of jobs with the SLA"
  SlaServicveMethodInfo:
    type: "object"
    required:
    - "serviceid"
    - "type"
    - "service_name"
    - "service_methodid"
    - "method_name"
    properties:
      serviceid:
        type: "integer"
        format: "int64"
        description: "the service ID"
      type:
        type: "string"
        description: "the service type; either \"system\" or \"user\""
      service_name:
        type: "string"
        description: "the service name"
      service_methodid:
        type: "integer"
        format: "int64"
        description: "the service methods ID"
      method_name:
        type: "string"
        description: "the service method name"
  SlaJobInfo:
    type: "object"
    required:
    - "jobid"
    - "name"
    properties:
      jobid:
        type: "integer"
        format: "int64"
        description: "the job ID"
      name:
        type: "string"
        description: "the job name"
  post-slas-body:
    type: "object"
    required:
    - "name"
    - "description"
    properties:
      name:
        type: "string"
        description: "the unique name of the SLA"
      units:
        type: "string"
        x-nullable: true
        description: "describes the meaning of SLA event values (allowed values: \"seconds\" and \"other\"; default: \"seconds\")"
      description:
        type: "string"
        description: "the description of the SLA"
  JobExecResultInfo:
    type: "object"
    required:
    - "job_instanceid"
    - "status"
    properties:
      job_instanceid:
        type: "integer"
        format: "int64"
        description: "the job_instanceid"
      status:
        type: "string"
        description: "the status of the execution of the job; see JobStatusDescriptions for possible values"
  UndefinedHash:
    type: "object"
    additionalProperties:
      description: not available
  _put-jobs-id_or_name-setExpiry-body:
    type: "object"
    properties:
      date:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the new expiry date of the job; if not present any expiry date will be removed"
    x-nullable: true
  JobExpiryUpdateInfo:
    type: "object"
    required:
    - "jobid"
    - "name"
    - "info"
    properties:
      jobid:
        type: "integer"
        format: "int64"
        description: "the job ID"
      name:
        type: "string"
        description: "the job name"
      expiry_date:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the new expiry date of the job"
      info:
        type: "string"
        description: "a descriptive string"
  _put-jobs-id_or_name-schedule-body:
    type: "object"
    properties:
      schedule:
        type: "string"
        x-nullable: true
        description: "a cron-like string giving the job schedule, see job schedule for information about the format; either this parameter or duration must be present, but not both"
      duration:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "a duration in seconds for triggering the job; either this parameter or schedule must be present, but not both; the duration must be less than 10^7."
    x-nullable: true
  JobScheduleUpdateInfo:
    type: "object"
    required:
    - "jobid"
    - "name"
    - "info"
    properties:
      jobid:
        type: "integer"
        format: "int64"
        description: "the job ID"
      name:
        type: "string"
        description: "the job name"
      schedule:
        type: "string"
        x-nullable: true
        description: "the new schedule for the job"
      duration:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the new dduration for the job"
      info:
        type: "string"
        description: "a descriptive string"
  JobUpdateResultInfo:
    type: "object"
    required:
    - "jobid"
    - "name"
    - "version"
    - "info"
    properties:
      jobid:
        type: "integer"
        format: "int64"
        description: "the workflow ID"
      name:
        type: "string"
        description: "the wojobrkflow name"
      version:
        type: "string"
        description: "the job version"
      info:
        type: "string"
        description: "a string providing information about the job update action"
  ListenerInfoHash:
    type: "object"
    required:
    - "name"
    - "address"
    - "address_desc"
    - "family"
    - "familystr"
    - "ssl"
    - "desc"
    - "proto"
    - "id"
    - "bind"
    - "get_remote_certs"
    - "ssl_verify_flags"
    - "ssl_accept_all_certs"
    properties:
      name:
        type: "string"
        description: "the unique name of the listener"
      hostname:
        type: "string"
        x-nullable: true
        description: "the bind hostname"
      hostname_desc:
        type: "string"
        x-nullable: true
        description: "a description for the hostname"
      address:
        type: "string"
        description: "the bind address"
      address_desc:
        type: "string"
        description: "a description for the address"
      port:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the port number (not present in UNIX sockets)"
      family:
        type: "integer"
        format: "int64"
        description: "the network address family code for the socket"
      familystr:
        type: "string"
        description: "a descriptive string for the family code"
      ssl:
        type: "boolean"
        description: "true if the listener is a TLS/SSL listener"
      desc:
        type: "string"
        description: "a descriptive string for the listener"
      proto:
        type: "string"
        description: "the protocol; either \"http\" or \"https\""
      id:
        type: "integer"
        format: "int64"
        description: "the listener ID"
      bind:
        type: "string"
        description: "the bind string"
      get_remote_certs:
        type: "boolean"
        description: "flag if remote client certificates will be captured"
      ssl_verify_flags:
        type: "array"
        items:
          type: "string"
        description: "SSL verification flags (see ssl_mode_constants for the meaning of these values)"
      ssl_accept_all_certs:
        type: "boolean"
        description: "if the listener will accept all client certificates (verification disabled) or not (verification enabled)"
  ListenerInfoSet:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/ListenerInfoHash"
  AnyType: {}
  WorkflowOrderStatusInfo:
    type: "object"
    required:
    - "workflow_status"
    properties:
      workflow_status:
        type: "string"
        description: "the status of the order after updating"
  post-orders-id-notes-body:
    type: "object"
    required:
    - "note"
    properties:
      note:
        type: "string"
        description: "the note to create on the order"
  put-orders-id-staticData-body:
    type: "object"
    required:
    - "newdata"
    properties:
      newdata:
        $ref: "#/definitions/UndefinedHash"
        description: "the new static data for the current workflow order; must be a non-empty"
  _put-orders-id-dynamicData-body:
    type: "object"
    properties:
      newdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "the new dynamic data for the current workflow order"
    x-nullable: true
  put-orders-id-updateKeys-body:
    type: "object"
    required:
    - "orderkeys"
    properties:
      orderkeys:
        $ref: "#/definitions/OrderKeySet"
        description: "the order keys to replace for the current workflow order"
      truncate:
        type: "boolean"
        x-nullable: true
        description: "truncate any key values automatically to the length of the column (4000 characters)"
  OrderKeySet:
    type: "object"
    additionalProperties:
      type: "array"
      items:
        type: "string"
  WorkflowUpdateResultInfo:
    type: "object"
    required:
    - "workflowid"
    - "name"
    - "version"
    - "info"
    properties:
      workflowid:
        type: "integer"
        format: "int64"
        description: "the workflow ID"
      name:
        type: "string"
        description: "the workflow name"
      version:
        type: "string"
        description: "the workflow version"
      info:
        type: "string"
        description: "a string providing information about the workflow update action"
  put-workflows-id_or_name-setAutostart-body:
    type: "object"
    required:
    - "autostart"
    properties:
      autostart:
        type: "integer"
        format: "int64"
        description: "the new autostart value for the workflow"
  WorkflowSetAutostartResultInfo:
    type: "object"
    required:
    - "updated"
    - "autostart"
    - "info"
    - "started"
    properties:
      updated:
        type: "boolean"
        description: "a flag indicating if a change was actually made or not"
      autostart:
        type: "integer"
        format: "int64"
        description: "the new autostart value"
      info:
        type: "string"
        description: "a string providing information about the workflow update action"
      started:
        type: "integer"
        format: "int64"
        description: "if negative, then it is the number of execution instances stopped"
  post-workflows-id_or_name-createOrder-body:
    type: "object"
    required:
    - "staticdata"
    properties:
      external_order_instanceid:
        type: "string"
        x-nullable: true
        description: "the external order instance ID for the workflow data; either this key or staticdata is required"
      dynamicdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "the initial dynamic data for the order"
      global_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); if this key already exists for any order in the system, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
      orderkeys:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of order keys for the order"
      parent_workflow_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "a loosely-coupled workflow that will be marked as the parent of this workflow"
      priority:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the order priority (default OMQ::DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest"
      scheduled:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ::StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ::StatScheduled instead of OMQ::StatReady"
      sensitive_data:
        $ref: "#/definitions/_SensitiveDataSetInfo"
        description: "a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values"
      staticdata:
        $ref: "#/definitions/UndefinedHash"
        description: "the static data for the order; either this key or external_order_instanceid is required"
      status:
        type: "string"
        x-nullable: true
        description: "the initial order status (default OMQ::StatReady); must be either OMQ::StatReady or OMQ::StatBlocked"
      workflow_specific_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); if this key already exists for an order with the target workflowid, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
      workflow_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); if this key already exists for a workflow order with the same name, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
  _UndefinedHash:
    type: "object"
    additionalProperties:
      description: not available
    x-nullable: true
  WorkflowOrderCreateInfo:
    type: "object"
    required:
    - "workflow_instanceid"
    properties:
      workflow_instanceid:
        type: "string"
        description: "the workflow instance ID of the order created"
  WorkflowOrderExecutionInfo:
    type: "object"
    required:
    - "workflow_instanceid"
    - "status"
    properties:
      workflow_instanceid:
        type: "string"
        description: "the workflow instance ID of the order created"
      status:
        type: "string"
        description: "the status of the order after synchronous order processing"
      dynamicdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "the dynamic data of the workflow order instance"
  WorkflowOrderExecutionAsyncInfo:
    type: "object"
    required:
    - "workflow_instanceid"
    - "execid"
    properties:
      workflow_instanceid:
        type: "integer"
        format: "int64"
        description: "the workflow instance ID of the order created"
      execid:
        type: "integer"
        format: "int64"
        description: "the synchronous workflow execution instance ID"
  EndpointInfo:
    type: "object"
    additionalProperties:
      description: not available
  DataProviderInfo:
    type: "object"
    required:
    - "name"
    - "supports_read"
    - "supports_create"
    - "supports_update"
    - "supports_upsert"
    - "supports_delete"
    - "supports_native_search"
    - "supports_bulk_read"
    - "supports_bulk_create"
    - "supports_bulk_upsert"
    - "supports_request"
    - "supports_children"
    - "transaction_management"
    - "has_record"
    - "record_requires_search_options"
    - "supports_child_create"
    - "supports_child_delete"
    - "supports_add_field"
    - "supports_update_field"
    - "supports_delete_field"
    - "supports_schema"
    - "supports_search_expressions"
    - "supports_observable"
    - "supports_messages"
    - "children_can_support_apis"
    - "children_can_support_records"
    - "children_can_support_observers"
    - "children_can_support_messages"
    - "search_logic_capabilities"
    - "desc"
    - "type"
    properties:
      name:
        type: "string"
        description: "the name of the data provider"
      supports_read:
        type: "boolean"
        description: "if the data provider supports record read/search actions"
      supports_create:
        type: "boolean"
        description: "if the data provider support record creation"
      supports_update:
        type: "boolean"
        description: "if the data provider supports record updates"
      supports_upsert:
        type: "boolean"
        description: "if the data provider supports record upserts / merges"
      supports_delete:
        type: "boolean"
        description: "if the data provider supports record deletions"
      supports_native_search:
        type: "boolean"
        description: "if the data provider supports a native record search API"
      supports_bulk_read:
        type: "boolean"
        description: "if the data provider supports bulk record read / search actions"
      supports_bulk_create:
        type: "boolean"
        description: "if the data provider supports bulk record creation"
      supports_bulk_upsert:
        type: "boolean"
        description: "if the data provider supports bulk record upsert / merges"
      supports_request:
        type: "boolean"
        description: "if the data provider supports the request/reply integration pattern (API calls)"
      supports_children:
        type: "boolean"
        description: "if the data provider supports children"
      transaction_management:
        type: "boolean"
        description: "if the data provider supports transaction mgmt"
      has_record:
        type: "boolean"
        description: "if the data provider supports records"
      record_requires_search_options:
        type: "boolean"
        description: "if the data provider requires search options when searching"
      supports_child_create:
        type: "boolean"
        description: "if the data provider supports creating child data providers"
      supports_child_delete:
        type: "boolean"
        description: "if the data provider supports deleting child data providers"
      supports_add_field:
        type: "boolean"
        description: "if the data provider supports the add field API"
      supports_update_field:
        type: "boolean"
        description: "if the data provider supports the update field API"
      supports_delete_field:
        type: "boolean"
        description: "if the data provider supports the delete field API"
      supports_schema:
        type: "boolean"
        description: "if the data provider supports a schema"
      supports_search_expressions:
        type: "boolean"
        description: "if the data provider supports generic search expressions"
      supports_observable:
        type: "boolean"
        description: "if the data provider supports the observer pattern / event API"
      supports_messages:
        type: "string"
        description: "if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)"
      children_can_support_apis:
        type: "boolean"
        description: "if the data provider can provide children that support APIs"
      children_can_support_records:
        type: "boolean"
        description: "if the data provider can provide children that support records"
      children_can_support_observers:
        type: "boolean"
        description: "if the data provider can provide children that support event observation"
      children_can_support_messages:
        type: "boolean"
        description: "if the data provider can provide children that support messages"
      events:
        $ref: "#/definitions/_UndefinedHash"
        description: "any events supported by the data provider"
      messages:
        $ref: "#/definitions/_UndefinedHash"
        description: "any messages supported by the data provider"
      search_logic_capabilities:
        type: "integer"
        format: "int64"
        description: "a bitfield of supported search logic capabilities"
      mapper_keys:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of mapper key information"
      desc:
        type: "string"
        description: "the description of the data provider"
      type:
        type: "string"
        description: "the type (class name) of the data provider"
      constructor_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any constructor options supported by the data provider"
      create_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any record creation options supported by the data provider"
      upsert_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any record upsert options supported by the data provider"
      search_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any record search options supported by the data provider"
      child_create_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any child creation options supported by the data provider"
      children:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "a list of any data provider children"
  DataProviderBrowseNodeInfo:
    type: "object"
    required:
    - "type"
    - "children"
    properties:
      type:
        type: "string"
        description: "one of the following: nav: a navigation node, data-provider: a data provider, type: a data type"
      children:
        type: "array"
        items:
          $ref: "#/definitions/DataProviderChildBrowseInfo"
        description: "a list of children of the current node"
      matches_context:
        type: "boolean"
        x-nullable: true
        description: "if True then the node is a match for the search context"
  DataProviderChildBrowseInfo:
    type: "object"
    required:
    - "name"
    - "desc"
    - "type"
    properties:
      name:
        type: "string"
        description: "the name of the child node"
      desc:
        type: "string"
        description: "the description of the child"
      type:
        type: "string"
        description: "the type of the child node; one of the following: nav: a navigation node, data-provider: a data provider, type: a data type, factory: a data provider factory, which may require sending provider_options according to the constructor_options key in this hash to create the data provider"
      constructor_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any constructor options supported by the data provider; only present when type is \"factory\""
  DataProviderChildDetailInfo:
    type: "object"
    required:
    - "name"
    - "supports_read"
    - "supports_create"
    - "supports_update"
    - "supports_upsert"
    - "supports_delete"
    - "supports_native_search"
    - "supports_bulk_read"
    - "supports_bulk_create"
    - "supports_bulk_upsert"
    - "supports_request"
    - "supports_children"
    - "transaction_management"
    - "has_record"
    - "record_requires_search_options"
    - "supports_child_create"
    - "supports_child_delete"
    - "supports_add_field"
    - "supports_update_field"
    - "supports_delete_field"
    - "supports_schema"
    - "supports_search_expressions"
    - "supports_observable"
    - "supports_messages"
    - "children_can_support_apis"
    - "children_can_support_records"
    - "children_can_support_observers"
    - "children_can_support_messages"
    - "search_logic_capabilities"
    - "desc"
    - "type"
    properties:
      name:
        type: "string"
        description: "the name of the data provider"
      supports_read:
        type: "boolean"
        description: "if the data provider supports record read/search actions"
      supports_create:
        type: "boolean"
        description: "if the data provider support record creation"
      supports_update:
        type: "boolean"
        description: "if the data provider supports record updates"
      supports_upsert:
        type: "boolean"
        description: "if the data provider supports record upserts / merges"
      supports_delete:
        type: "boolean"
        description: "if the data provider supports record deletions"
      supports_native_search:
        type: "boolean"
        description: "if the data provider supports a native record search API"
      supports_bulk_read:
        type: "boolean"
        description: "if the data provider supports bulk record read / search actions"
      supports_bulk_create:
        type: "boolean"
        description: "if the data provider supports bulk record creation"
      supports_bulk_upsert:
        type: "boolean"
        description: "if the data provider supports bulk record upsert / merges"
      supports_request:
        type: "boolean"
        description: "if the data provider supports the request/reply integration pattern (API calls)"
      supports_children:
        type: "boolean"
        description: "if the data provider supports children"
      transaction_management:
        type: "boolean"
        description: "if the data provider supports transaction mgmt"
      has_record:
        type: "boolean"
        description: "if the data provider supports records"
      record_requires_search_options:
        type: "boolean"
        description: "if the data provider requires search options when searching"
      supports_child_create:
        type: "boolean"
        description: "if the data provider supports creating child data providers"
      supports_child_delete:
        type: "boolean"
        description: "if the data provider supports deleting child data providers"
      supports_add_field:
        type: "boolean"
        description: "if the data provider supports the add field API"
      supports_update_field:
        type: "boolean"
        description: "if the data provider supports the update field API"
      supports_delete_field:
        type: "boolean"
        description: "if the data provider supports the delete field API"
      supports_schema:
        type: "boolean"
        description: "if the data provider supports a schema"
      supports_search_expressions:
        type: "boolean"
        description: "if the data provider supports generic search expressions"
      supports_observable:
        type: "boolean"
        description: "if the data provider supports the observer pattern / event API"
      supports_messages:
        type: "string"
        description: "if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)"
      children_can_support_apis:
        type: "boolean"
        description: "if the data provider can provide children that support APIs"
      children_can_support_records:
        type: "boolean"
        description: "if the data provider can provide children that support records"
      children_can_support_observers:
        type: "boolean"
        description: "if the data provider can provide children that support event observation"
      children_can_support_messages:
        type: "boolean"
        description: "if the data provider can provide children that support messages"
      search_logic_capabilities:
        type: "integer"
        format: "int64"
        description: "a bitfield of supported search logic capabilities"
      mapper_keys:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of mapper key information"
      desc:
        type: "string"
        description: "the description of the data provider"
      type:
        type: "string"
        description: "the type (class name) of the data provider"
      constructor_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any constructor options supported by the data provider"
      create_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any record creation options supported by the data provider"
      upsert_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any record upsert options supported by the data provider"
      search_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any record search options supported by the data provider"
      child_create_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any child creation options supported by the data provider"
      children:
        type: "array"
        items:
          $ref: "#/definitions/DataProviderSummaryInfo"
        x-nullable: true
        description: "a list of any data provider children"
  DataProviderSummaryInfo:
    type: "object"
    required:
    - "name"
    - "desc"
    - "type"
    - "supports_read"
    - "supports_create"
    - "supports_update"
    - "supports_upsert"
    - "supports_delete"
    - "supports_native_search"
    - "supports_bulk_read"
    - "supports_bulk_create"
    - "supports_bulk_upsert"
    - "supports_request"
    - "supports_children"
    - "transaction_management"
    - "has_record"
    - "supports_search_expressions"
    - "supports_observable"
    - "supports_messages"
    - "children_can_support_apis"
    - "children_can_support_records"
    - "children_can_support_observers"
    - "children_can_support_messages"
    properties:
      name:
        type: "string"
        description: "the name of the data provider"
      desc:
        type: "string"
        description: "the description of the data provider"
      type:
        type: "string"
        description: "the type (class name) of the data provider"
      supports_read:
        type: "boolean"
        description: "if the data provider supports record read/search actions"
      supports_create:
        type: "boolean"
        description: "if the data provider support record creation"
      supports_update:
        type: "boolean"
        description: "if the data provider supports record updates"
      supports_upsert:
        type: "boolean"
        description: "if the data provider supports record upserts / merges"
      supports_delete:
        type: "boolean"
        description: "if the data provider supports record deletions"
      supports_native_search:
        type: "boolean"
        description: "if the data provider supports a native record search API"
      supports_bulk_read:
        type: "boolean"
        description: "if the data provider supports bulk record read / search actions"
      supports_bulk_create:
        type: "boolean"
        description: "if the data provider supports bulk record creation"
      supports_bulk_upsert:
        type: "boolean"
        description: "if the data provider supports bulk record upsert / merges"
      supports_request:
        type: "boolean"
        description: "if the data provider supports the request/reply integration pattern (API calls)"
      supports_children:
        type: "boolean"
        description: "if the data provider supports children"
      transaction_management:
        type: "boolean"
        description: "if the data provider supports transaction mgmt"
      has_record:
        type: "boolean"
        description: "if the data provider supports records"
      supports_search_expressions:
        type: "boolean"
        description: "if the data provider supports advanced search expressions"
      supports_observable:
        type: "boolean"
        description: "if the data provider supports the observer pattern / event API"
      supports_messages:
        type: "string"
        description: "if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)"
      children_can_support_apis:
        type: "boolean"
        description: "if the data provider can provide children that support APIs"
      children_can_support_records:
        type: "boolean"
        description: "if the data provider can provide children that support records"
      children_can_support_observers:
        type: "boolean"
        description: "if the data provider can provide children that support event observation"
      children_can_support_messages:
        type: "boolean"
        description: "if the data provider can provide children that support messages"
  ConnectionUpdateResultInfo:
    type: "object"
    required:
    - "info"
    properties:
      info:
        type: "string"
        description: "a string providing information about the connection update action"
  AffectedRecordInfo:
    type: "object"
    required:
    - "affected_records"
    properties:
      affected_records:
        type: "integer"
        format: "int64"
        description: "the number of records affected by the operation"
  _SensitiveDataSetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/SensitiveDataKeyInfo"
    x-nullable: true
  SensitiveDataKeyInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/SensitiveDataInfo"
  SensitiveDataInfo:
    type: "object"
    required:
    - "data"
    properties:
      aliases:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "zero or more string aliases for the sensitive data"
      data:
        $ref: "#/definitions/UndefinedHash"
        description: "the sensitive data hash itself"
      meta:
        $ref: "#/definitions/_SensitiveMetaInfo"
        description: "a hash of metadata for the sensitive data"
  _SensitiveMetaInfo:
    type: "object"
    properties:
      PURPOSE:
        description: "free-form information about the purpose of the sensitive data"
      CATEGORIES:
        description: "free-form information about the categories of sensitive data"
      RECIPIENTS:
        description: "free-form information about the recipients or recipient catories of sensitive data"
      STORAGE:
        description: "free-form information about the storage time or rules for sensitive data"
    additionalProperties:
      description: not available
    x-nullable: true
  post-workflows-id_or_name-execSynchronous-body:
    type: "object"
    required:
    - "staticdata"
    properties:
      external_order_instanceid:
        type: "string"
        x-nullable: true
        description: "the external order instance ID for the workflow data; either this key or staticdata is required"
      dynamicdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "the initial dynamic data for the order"
      global_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); if this key already exists for any order in the system, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
      orderkeys:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of order keys for the order"
      parent_workflow_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "a loosely-coupled workflow that will be marked as the parent of this workflow"
      priority:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the order priority (default OMQ::DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest"
      sensitive_data:
        $ref: "#/definitions/_SensitiveDataSetInfo"
        description: "a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values"
      staticdata:
        $ref: "#/definitions/UndefinedHash"
        description: "the static data for the order; either this key or external_order_instanceid is required"
      workflow_specific_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); if this key already exists for an order with the target workflowid, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
      workflow_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); if this key already exists for a workflow order with the same name, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
  put-orders-id-sensitiveData-body:
    type: "object"
    required:
    - "skey"
    - "svalue"
    properties:
      skey:
        type: "string"
        description: "the sensitive data key type"
      svalue:
        type: "string"
        description: "the sensitive data key value"
      aliases:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "zero or more string aliases for the sensitive data"
      data:
        $ref: "#/definitions/_UndefinedHash"
        description: "the sensitive data hash itself; if omitted then sensitive data is removed for the given skey and svalue values"
      meta:
        $ref: "#/definitions/_SensitiveMetaInfo"
        description: "a hash of metadata for the sensitive data"
  post-async-queues-queue-update-body:
    type: "object"
    required:
    - "key"
    properties:
      key:
        type: "string"
        description: "value of the key in the given queue"
      data:
        description: "data to post in the queue entry; this data will be passed to the back end function for evaluation"
  _post-orders-id-lockUserInteractionStep-body:
    type: "object"
    properties:
      stepid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the ID of the step to acquire user interaction data from; either this or stepname is required"
      stepname:
        type: "string"
        x-nullable: true
        description: "the name of the step to acquire user interaction data from; either this or stepid is required"
    x-nullable: true
  WorkflowLockUseInteractionStepResultInfo:
    type: "object"
    required:
    - "workflow_instanceid"
    - "stepid"
    - "ind"
    - "queuekey"
    - "queueid"
    - "queuename"
    properties:
      workflow_instanceid:
        type: "integer"
        format: "int64"
        description: "the workflow order instance ID"
      stepid:
        type: "integer"
        format: "int64"
        description: "the step ID of the step"
      ind:
        type: "integer"
        format: "int64"
        description: "the step instance index number"
      queuekey:
        type: "string"
        description: "the queue key ID"
      queueid:
        type: "integer"
        format: "int64"
        description: "the ID of the async queue"
      queuename:
        type: "string"
        description: "the name of the async queue"
      data:
        $ref: "#/definitions/_UndefinedHash"
        description: "any step data already present"
  put-orders-id-stepData-body:
    type: "object"
    required:
    - "stepid"
    - "ind"
    properties:
      stepid:
        type: "integer"
        format: "int64"
        description: "required: the step ID of the step"
      ind:
        type: "integer"
        format: "int64"
        description: "required: the step instance index value; use 0 for non-array steps"
      newdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "required: the new dynamic step data for the current workflow order and step; can also be no value which will remove all step data from the current step"
  post-orders-id-releaseUserInteractionStepLock-body:
    type: "object"
    required:
    - "stepid"
    - "ind"
    properties:
      stepid:
        type: "integer"
        format: "int64"
        description: "the step ID of the step"
      ind:
        type: "integer"
        format: "int64"
        description: "the step instance index value; use 0 for non-array steps"
  post-orders-id-breakUserInteractionStepLock-body:
    type: "object"
    required:
    - "stepid"
    - "ind"
    - "note"
    properties:
      stepid:
        type: "integer"
        format: "int64"
        description: "the step ID of the step"
      ind:
        type: "integer"
        format: "int64"
        description: "the step instance index value; use 0 for non-array steps"
      note:
        type: "string"
        description: "a note to be added to the order on why the lock was broken"
  put-workflows-id_or_name-setRemote-body:
    type: "object"
    required:
    - "remote"
    properties:
      remote:
        type: "boolean"
        description: "the new remote value for the workflow"
  WorkflowSetRemoteResultInfo:
    type: "object"
    required:
    - "updated"
    - "remote"
    - "info"
    properties:
      updated:
        type: "boolean"
        description: "a flag indicating if a change was actually made or not"
      remote:
        type: "boolean"
        description: "the new remote value"
      info:
        type: "string"
        description: "a string providing information about the workflow update action"
  put-workflows-id_or_name-setSla-body:
    type: "object"
    required:
    - "sla"
    properties:
      sla:
        type: "integer"
        format: "int64"
        description: "a value giving the new SLA timeout value as an integer in seconds for the workflow"
  WorkflowSetSlaResultInfo:
    type: "object"
    required:
    - "updated"
    - "sla"
    - "info"
    properties:
      updated:
        type: "boolean"
        description: "a flag indicating if a change was actually made or not"
      sla:
        type: "integer"
        format: "int64"
        description: "the new SLA value as a positive integer in seconds"
      info:
        type: "string"
        description: "a string providing information about the workflow update action"
  WorkflowDefinitionInfoV3:
    type: "object"
    required:
    - "workflowid"
    - "name"
    - "version"
    - "remote"
    - "manual_remote"
    - "has_detach"
    - "created"
    - "modified"
    - "autostart"
    - "manual_autostart"
    - "sla_threshold"
    - "manual_sla_threshold"
    - "enabled"
    - "deprecated"
    - "stepmap"
    - "steps"
    - "segment"
    - "stepinfo"
    - "wffuncs"
    - "options"
    - "exec_count"
    properties:
      workflowid:
        type: "integer"
        format: "int64"
        description: "the workflow ID"
      name:
        type: "string"
        description: "the workflow name"
      version:
        type: "string"
        description: "the workflow version"
      description:
        type: "string"
        x-nullable: true
        description: "the workflow description"
      author:
        type: "string"
        x-nullable: true
        description: "the workflow author"
      remote:
        type: "boolean"
        description: "if True, the workflow will run as a remote qwf process, otherwise it runs internally in the qorus-core process"
      manual_remote:
        type: "boolean"
        description: "set if the manual value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      onetimeinit_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the onetimeinit function ID for the workflow (if defined)"
      attach_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the attach function ID for the workflow (if defined)"
      detach_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the detach function ID for the workflow (if defined)"
      errorfunction_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the error function ID for the workflow (if defined)"
      errhandler_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the error handler function ID for the workflow (if defined)"
      has_detach:
        type: "boolean"
        description: "True if the workflow has detach logic"
      created:
        type: "string"
        format: "date-time"
        description: "the workflow creation date"
      modified:
        type: "string"
        format: "date-time"
        description: "the workflow last modified date"
      autostart:
        type: "integer"
        format: "int64"
        description: "the workflow autostart value"
      manual_autostart:
        type: "boolean"
        description: "set if the autostart value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      sla_threshold:
        type: "integer"
        format: "int64"
        description: "the workflow SLA threshold value"
      manual_sla_threshold:
        type: "boolean"
        description: "a boolean flag set if the sla_threshold value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      enabled:
        type: "boolean"
        description: "a boolean flag indicating if the workflow is enabled or not; disabled workflows cannot be started"
      deprecated:
        type: "boolean"
        description: "a boolean flag indicating if the workflow is deprecated or not; deprecated workflows are not displayed by default in the UI"
      language:
        type: "string"
        x-nullable: true
        description: "the programming language for the workflow's class (if any)"
      code:
        type: "string"
        x-nullable: true
        description: "the source code for the workflow's class (if any)"
      source:
        type: "string"
        x-nullable: true
        description: "the source for the workflow definition"
      line:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the line number offset in source for the workflow definition"
      tags:
        $ref: "#/definitions/_UndefinedHash"
        description: "any tags for the workflow"
      order_key_map:
        $ref: "#/definitions/_Set"
        description: "set of order keys in hash form"
      keylist:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "a list of workflow order keys"
      stepmap:
        $ref: "#/definitions/StringMap"
        description: "a hash where keys are step IDs and values are step names"
      steps:
        $ref: "#/definitions/IntListMap"
        description: "a hash of step dependencies, where keys are step IDs and values are lists of step IDs that must preceed the step ID given as a key"
      segment:
        type: "array"
        items:
          $ref: "#/definitions/SegmentInfo"
        description: "a list of segment description hashes, where each segment hash has the following keys:"
      stepseg:
        $ref: "#/definitions/_IntMap"
        description: "maps step IDs to segment numbers"
      lib:
        $ref: "#/definitions/_LibraryInfo"
        description: "information about any referenced Qorus objects"
      mappers:
        type: "array"
        items:
          $ref: "#/definitions/MapperInfo"
        x-nullable: true
        description: "a list of mappers associated with the workflow"
      vmaps:
        type: "array"
        items:
          $ref: "#/definitions/VMapInfo"
        x-nullable: true
        description: "a list of value maps associated with the workflow"
      stepinfo:
        type: "array"
        items:
          $ref: "#/definitions/WorkflowStepInfo"
        description: "a list of hashes giving information about workflow steps"
      wffuncs:
        type: "array"
        items:
          $ref: "#/definitions/WorkflowFuncInfo"
        description: "a list of workflow-level functions (may be empty)"
      options:
        type: "array"
        items:
          $ref: "#/definitions/OptionInfoHash"
        description: "a list option information hashes"
      config:
        $ref: "#/definitions/_ConfigItemSummarySetInfo"
        description: "a hash of configuration item info keyed by config item name"
      global_config:
        $ref: "#/definitions/_ConfigItemSummarySetInfo"
        description: "a hash of configuration item info keyed by config item name"
      exec:
        type: "array"
        items:
          $ref: "#/definitions/ExecInstanceInfoV3"
        x-nullable: true
        description: "a list of hashes describing any workflow execution instances running for this workflow"
      COMPLETE:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status COMPLETE"
      INCOMPLETE:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status INCOMPLETE"
      WAITING:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status WAITING"
      EVENT-WAITING:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status EVENT-WAITING"
      ASYNC-WAITING:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status ASYNC-WAITING"
      RETRY:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status RETRY"
      ERROR:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status ERROR"
      CANCELED:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status CANCELED"
      BLOCKED:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status BLOCKED"
      IN-PROGRESS:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status IN-PROGRESS"
      SCHEDULED:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status SCHEDULED"
      READY:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders with status READY"
      TOTAL:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of workflow orders in all statuses"
      process:
        $ref: "#/definitions/_ProcessExecInfo"
        description: "present when remote is True"
      exec_count:
        type: "integer"
        format: "int64"
        description: "the number of elements in the exec list"
      order_stats:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        x-nullable: true
        description: "a list of workflow order processing statistics; list values are OrderSummaryOutputInfo hashes for the given workflow"
      alerts:
        type: "array"
        items:
          $ref: "#/definitions/AlertInfo"
        x-nullable: true
        description: "a list of alerts raised against the workflow"
      connections:
        type: "array"
        items:
          $ref: "#/definitions/ConnectionInfo"
        x-nullable: true
        description: "a list of connection objects that this workflow depends on"
      groups:
        type: "array"
        items:
          $ref: "#/definitions/GroupInfo"
        x-nullable: true
        description: "a list of interface groups that the workflow belongs to"
  _Set:
    type: "object"
    additionalProperties:
      type: "boolean"
    x-nullable: true
  StringMap:
    type: "object"
    additionalProperties:
      type: "string"
  IntListMap:
    type: "object"
    additionalProperties:
      type: "array"
      items:
        type: "integer"
        format: "int64"
      x-nullable: true
  SegmentInfo:
    type: "object"
    required:
    - "steplist"
    - "steps"
    properties:
      steplist:
        type: "array"
        items:
          type: "integer"
          format: "int64"
        description: "a list of step IDs in the segment"
      steps:
        $ref: "#/definitions/IntListMap"
        description: "a hash of step dependencies, where keys are step IDs and values are lists of step IDs that must preceed the step ID given as a key"
      start:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the starting step ID for segments other than the initial segment"
      subworkflow:
        type: "boolean"
        x-nullable: true
        description: "set to true if the segment is a subworkflow segment"
      linksegment:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the previous segment"
      linkstepid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the step linking the segment to the previous segment"
  _IntMap:
    type: "object"
    additionalProperties:
      type: "integer"
      format: "int64"
    x-nullable: true
  _LibraryInfo:
    type: "object"
    properties:
      functions:
        type: "array"
        items:
          $ref: "#/definitions/LibraryDetailInfo"
        x-nullable: true
        description: "a list of function objects (can be empty)"
      classes:
        type: "array"
        items:
          $ref: "#/definitions/LibraryDetailInfo"
        x-nullable: true
        description: "a list of class objects (can be empty)"
      constants:
        type: "array"
        items:
          $ref: "#/definitions/LibraryDetailInfo"
        x-nullable: true
        description: "a list of constant objects (can be empty)"
      pipelines:
        type: "array"
        items:
          $ref: "#/definitions/NameInfo"
        x-nullable: true
        description: "a list of pipeline objects (can be empty)"
      fsm:
        type: "array"
        items:
          $ref: "#/definitions/NameInfo"
        x-nullable: true
        description: "a list of FSM objects (can be empty)"
    x-nullable: true
  LibraryDetailInfo:
    type: "object"
    required:
    - "name"
    - "version"
    - "id"
    properties:
      name:
        type: "string"
        description: "the name of the object"
      version:
        type: "string"
        description: "the version of the object"
      id:
        type: "integer"
        format: "int64"
        description: "the id of the object"
  NameInfo:
    type: "object"
    required:
    - "name"
    properties:
      name:
        type: "string"
        description: "the name of the object"
  MapperInfo:
    type: "object"
    required:
    - "mapperid"
    - "name"
    - "version"
    - "type"
    properties:
      mapperid:
        type: "integer"
        format: "int64"
        description: "the ID of the mapper"
      name:
        type: "string"
        description: "the name of the mapper"
      version:
        type: "string"
        description: "the version of the mapper"
      type:
        type: "string"
        description: "the type of the mapper (all types other than \"Mapper\" are deprecated)"
  VMapInfo:
    type: "object"
    required:
    - "id"
    - "name"
    - "throws_exception"
    - "valuetype"
    - "mapsize"
    properties:
      id:
        type: "integer"
        format: "int64"
        description: "the ID of the value map"
      name:
        type: "string"
        description: "the name of the value map"
      throws_exception:
        type: "boolean"
        description: "indicates how requests for unknown values should be processed"
      valuetype:
        type: "string"
        description: "the data type of the value map"
      mapsize:
        type: "integer"
        format: "int64"
        description: "the number of elements in the map"
  WorkflowStepInfo:
    type: "object"
    required:
    - "stepid"
    - "steptype"
    - "arraytype"
    - "name"
    - "version"
    - "user_interaction"
    - "created"
    - "modified"
    properties:
      stepid:
        type: "integer"
        format: "int64"
        description: "the ID of the step"
      steptype:
        type: "string"
        description: "the type of the step"
      arraytype:
        type: "string"
        description: "the array type of the step"
      name:
        type: "string"
        description: "the name of the step"
      version:
        type: "string"
        description: "the version of the step"
      author:
        type: "string"
        x-nullable: true
        description: "the author of the step (if any)"
      step_classid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the class ID of the step (if any)"
      classname:
        type: "string"
        x-nullable: true
        description: "the name of the step's class (if any)"
      code:
        type: "string"
        x-nullable: true
        description: "the source code for the step's class (if any)"
      language_info:
        $ref: "#/definitions/_UndefinedHash"
        description: "language-specific info"
      desc:
        type: "string"
        x-nullable: true
        description: "the description of the step or the description of the step's logic implementation, if the step itself has no description"
      lib:
        $ref: "#/definitions/_LibraryInfo"
        description: "information about any referenced Qorus objects"
      queueid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the ID of the async event queue for asynchronous steps (if any)"
      queuename:
        type: "string"
        x-nullable: true
        description: "the name of the async event queue for asynchronous steps (if any)"
      config:
        $ref: "#/definitions/_ConfigItemSetInfo"
        description: "a hash of configuration item info keyed by config item name"
      fsm_triggers:
        $ref: "#/definitions/_UndefinedHash"
        description: "any FSM trigges for steps"
      stepfunction_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the primary step function ID"
      validationfunction_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the function ID of the validation function (if any)"
      endfunction_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the function ID of the back end function for asynchronous steps (if any)"
      arrayfunction_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the function ID of the array function (if any)"
      workflow_event_typeid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the ID of the workflow synchronization event type for workflow synchronization event steps (if any)"
      language:
        type: "string"
        x-nullable: true
        description: "the programming language for the step's class (if any)"
      user_interaction:
        type: "boolean"
        description: "True if the asynchronous step supports user interaction APIs, False in all other cases"
      userdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "any user metadata for the step"
      sfname:
        type: "string"
        x-nullable: true
        description: "the name of the primary step function"
      vfname:
        type: "string"
        x-nullable: true
        description: "the name of the validation function (if any)"
      afname:
        type: "string"
        x-nullable: true
        description: "the name of the array function (if any)"
      efname:
        type: "string"
        x-nullable: true
        description: "the name of the back end function (if any)"
      created:
        type: "string"
        format: "date-time"
        description: "the creation date of the step in the database"
      modified:
        type: "string"
        format: "date-time"
        description: "the last modified date of the step in the database"
  _ConfigItemSetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/ConfigItemInfo"
    x-nullable: true
  ConfigItemInfo:
    type: "object"
    required:
    - "name"
    - "type"
    - "desc"
    - "strictly_local"
    - "is_set"
    - "config_group"
    - "level"
    - "is_templated_string"
    properties:
      name:
        type: "string"
        description: "the name of the configuration item"
      prefix:
        type: "string"
        x-nullable: true
        description: "the prefix of the configuration item"
      type:
        type: "string"
        description: "the data type of the configuration item"
      desc:
        type: "string"
        description: "the description of the configuration item"
      default_value:
        description: "the default value of the configuration item"
      value:
        description: "the value of the configuration item"
      strictly_local:
        type: "boolean"
        description: "if the configuration item is defined strictly on local level"
      is_set:
        type: "boolean"
        description: "true if the value is set otherwise false"
      config_group:
        type: "string"
        description: "the group of the configuration item"
      allowed_values:
        type: "array"
        items:
          $ref: "#/definitions/AnyType"
        x-nullable: true
        description: "the list of allowed values for the configuration item if defined"
      level:
        type: "string"
        description: "the level from where the value is obtained (interface level - e.g. \"step:1\" - or \"global\" or \"default\")"
      is_templated_string:
        type: "boolean"
        description: "true if the value is a templated string that can be later expanded"
  WorkflowFuncInfo:
    type: "object"
    required:
    - "type"
    - "name"
    - "version"
    - "function_instanceid"
    - "function_type"
    - "created"
    - "modified"
    properties:
      type:
        type: "string"
        description: "the type of workflow function; one of \"onetimeinit\" (workflow execution instance initialization function), \"errorfunction\" (workflow error function), \"attachfunction\" (workflow attach function), \"detachfunction\" (workflow detach function), \"errorhandlerfunction\" (workflow error handler function)"
      name:
        type: "string"
        description: "the name of the function"
      version:
        type: "string"
        description: "the version of the function"
      function_instanceid:
        type: "integer"
        format: "int64"
        description: "the function ID"
      function_type:
        type: "string"
        description: "the type of the function"
      description:
        type: "string"
        x-nullable: true
        description: "a decsription for the function"
      author:
        type: "string"
        x-nullable: true
        description: "the author of the function"
      created:
        type: "string"
        format: "date-time"
        description: "the creation date in the database"
      modified:
        type: "string"
        format: "date-time"
        description: "the last modified date in the database"
      source:
        type: "string"
        x-nullable: true
        description: "the name of the source file for the function (complete path)"
      line:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the line number offset for the function object definition in the file"
  OptionInfoHash:
    type: "object"
    required:
    - "name"
    properties:
      name:
        type: "string"
        description: "the name of the option"
      desc:
        type: "string"
        x-nullable: true
        description: "a description for the option"
      value:
        description: "the value of the option"
  _ConfigItemSummarySetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/ConfigItemSummaryInfo"
    x-nullable: true
  ConfigItemSummaryInfo:
    type: "object"
    required:
    - "name"
    - "type"
    - "desc"
    - "strictly_local"
    - "is_set"
    - "config_group"
    - "level"
    - "is_templated_string"
    properties:
      name:
        type: "string"
        description: "the name of the configuration item"
      prefix:
        type: "string"
        x-nullable: true
        description: "the prefix of the configuration item"
      type:
        type: "string"
        description: "the data type of the configuration item"
      desc:
        type: "string"
        description: "the description of the configuration item"
      default_value:
        description: "the default value of the configuration item"
      value:
        description: "the value of the configuration item"
      strictly_local:
        type: "boolean"
        description: "if the configuration item is defined strictly on local level"
      is_set:
        type: "boolean"
        description: "true if the value is set otherwise false"
      config_group:
        type: "string"
        description: "the group of the configuration item"
      allowed_values:
        type: "array"
        items:
          $ref: "#/definitions/AnyType"
        x-nullable: true
        description: "the list of allowed values for the configuration item if defined"
      level:
        type: "string"
        description: "the level from where the value is obtained (interface level (e.g. \"job:1\", \"job:2\")"
      is_templated_string:
        type: "boolean"
        description: "true if the value is a templated string that can be later expanded"
  ExecInstanceInfoV3:
    type: "object"
    required:
    - "mode"
    - "totalSegments"
    - "starttime"
    - "sync"
    - "executionID"
    - "remote"
    - "alerts"
    properties:
      mode:
        type: "string"
        description: "the workflow execution instance execution mode"
      totalSegments:
        type: "integer"
        format: "int64"
        description: "number of segments in the workflow"
      starttime:
        type: "string"
        format: "date-time"
        description: "the date/time the execution instance was started"
      logfile:
        type: "string"
        x-nullable: true
        description: "the log file name (full path)"
      sync:
        type: "boolean"
        description: "a boolean flag if the execution instance is synchronous or not"
      sync_wfiid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the workflow_instanceid currently being processed (if any)"
      executionID:
        type: "integer"
        format: "int64"
        description: "the workflow execution instance ID"
      remote:
        type: "boolean"
        description: "if True, the workflow execution instance is running in a remote qwf process, otherwise it is running internally in the qorus-core process"
      process:
        $ref: "#/definitions/_ProcessExecInfo"
        description: "present when remote is True"
      alerts:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        description: "a list of alerts"
      log_url:
        type: "string"
        x-nullable: true
        description: "the log URL (if any)"
  _ProcessExecInfo:
    type: "object"
    required:
    - "id"
    - "node"
    - "host"
    - "pid"
    - "urls"
    - "status"
    - "status_string"
    - "priv"
    - "rss"
    - "vsz"
    - "priv_str"
    - "pct"
    properties:
      id:
        type: "string"
        description: "the unique process ID in the cluster"
      node:
        type: "string"
        description: "the node name where the process is running"
      host:
        type: "string"
        description: "the hostname where the process is running"
      pid:
        type: "integer"
        format: "int64"
        description: "the PID on the host"
      urls:
        type: "array"
        items:
          type: "string"
        description: "a list of ZeroMQ URLs for the process"
      status:
        type: "integer"
        format: "int64"
        description: "the process's status code"
      status_string:
        type: "string"
        description: "the process's status as a string"
      priv:
        type: "integer"
        format: "int64"
        description: "the amount of private memory of the process in bytes"
      rss:
        type: "integer"
        format: "int64"
        description: "the resident size of the process in bytes"
      vsz:
        type: "integer"
        format: "int64"
        description: "the virtual size of the process in bytes"
      priv_str:
        type: "string"
        description: "a string description of the priv value"
      pct:
        type: "integer"
        format: "int64"
        description: "the percentage of main memory taken up by the process on the node"
    x-nullable: true
  AlertInfo:
    type: "object"
    required:
    - "type"
    - "alerttype"
    - "when"
    - "local"
    - "alert"
    - "alertid"
    - "reason"
    - "who"
    - "source"
    - "object"
    - "instance"
    - "name"
    properties:
      type:
        type: "string"
        description: "the type of object directly causing the alert"
      id:
        description: "the ID of the object directly causing the alert"
      version:
        type: "string"
        x-nullable: true
        description: "the version of the object causing the alert, if any"
      alerttype:
        type: "string"
        description: "either \"ONGOING\" or \"TRANSIENT\""
      when:
        type: "string"
        format: "date-time"
        description: "the timestamp when the alert was first raised"
      local:
        type: "boolean"
        description: "a boolean flag; true if the alert was raised by the local instance"
      alert:
        type: "string"
        description: "the name or string code of the alert"
      alertid:
        type: "integer"
        format: "int64"
        description: "a unique identifier for the alert (unique within the instance that raised the alert)"
      reason:
        type: "string"
        description: "a string giving the reason the alert was raised"
      who:
        type: "string"
        description: "a string describing the user or entity that raised the alert"
      source:
        type: "string"
        description: "a string describing the source of the alert"
      object:
        type: "string"
        description: "a string describing the object causing the alert"
      instance:
        type: "string"
        description: "the instance key of the Qorus instance where the alert was raised"
      name:
        type: "string"
        description: "the name of the object causing the alert"
      description:
        type: "string"
        x-nullable: true
        description: "the description of the object causing the alert"
      url:
        type: "string"
        x-nullable: true
        description: "the URL of any connection causing the alert"
      connection_type:
        type: "string"
        x-nullable: true
        description: "the connection type for any connection causing the alert"
      auditid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "no value if alert auditing is not enabled, otherwise an integer giving the auditid of the alert event"
  ConnectionInfo:
    type: "object"
    required:
    - "type"
    - "name"
    - "up"
    - "connectionid"
    - "conntype"
    - "description"
    - "url"
    - "monitor"
    - "status"
    - "url_hash"
    - "enabled"
    - "has_provider"
    - "children_can_support_apis"
    - "children_can_support_records"
    - "children_can_support_observers"
    - "children_can_support_messages"
    properties:
      type:
        type: "string"
        description: "the connection type (\"datasource\", \"rest\", \"soap\", etc)"
      name:
        type: "string"
        description: "the name of the connection"
      up:
        type: "boolean"
        description: "a boolean indicating if the connection was monitored to be up or not"
      connectionid:
        type: "integer"
        format: "int64"
        description: "the unique connection ID"
      conntype:
        type: "string"
        description: "either \"DATASOURCE\", \"REMOTE\", or \"USER-CONNECTION\""
      description:
        type: "string"
        description: "a description of the connection"
      url:
        type: "string"
        description: "the URL to the remote host"
      monitor:
        type: "boolean"
        description: "a boolean indicating if the connection is monitored or not"
      last_check:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the date/time value the connection was last checked (loopback remote connections are not checked)"
      updated:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the date/time the connection was last updated"
      status:
        type: "string"
        description: "\\ \"OK\", \"not checked\", or an error message"
      loopback:
        type: "boolean"
        x-nullable: true
        description: "(only for remote connections) indicates if the connection is a loopback connection"
      url_hash:
        $ref: "#/definitions/UndefinedHash"
        description: "a hash of broken-down URL components"
      enabled:
        type: "boolean"
        description: "indicates if the connecton is enabled or not"
      locked:
        type: "boolean"
        x-nullable: true
        description: "indicates if the connection can be edited or not (only the system schema connection is locked and cannot be edited)"
      debug_data:
        type: "boolean"
        x-nullable: true
        description: "if data debugging is enabled for the connection"
      tags:
        $ref: "#/definitions/_UndefinedHash"
        description: "any tags for the connection"
      has_provider:
        type: "boolean"
        description: "if the connection supports a data provider"
      children_can_support_apis:
        type: "boolean"
        description: "if the data provider or any children support APIs"
      children_can_support_records:
        type: "boolean"
        description: "if the data provider or any children support records"
      children_can_support_observers:
        type: "boolean"
        description: "if the data provider or any children support event observation"
      children_can_support_messages:
        type: "boolean"
        description: "if the data provider or any children support messages"
      opts:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of options for the connection"
      coord-mode:
        type: "boolean"
        x-nullable: true
        description: "if coordinated mode is enabled (datasources only)"
      safe_url:
        type: "string"
        x-nullable: true
        description: "a URL string without any password information"
      shared-pool:
        type: "string"
        x-nullable: true
        description: "summary information about the DatasourcePool object backing a datasource connection"
      warning-timeout:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "datasource warning timeout in milliseconds"
      error-timeout:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "datasources error timeout in milliseconds"
      pool-wait-max:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "(datasources only) the maximum wait time for a pool connection to become available in milliseconds"
      pool-reqs:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "(datasources only) the number of connection requests on the pool"
      pool-hits:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "(datasources only) the number of connection requests that could be served immediately without blocking"
      pool-miss:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "(datasources only) the number of connection requests that could be served only after blocking"
      pool-hit-pct:
        type: "number"
        format: "double"
        x-nullable: true
        description: "the percentage of hits to misses"
      deps:
        type: "array"
        items:
          $ref: "#/definitions/ConnectionDependencyInfo"
        x-nullable: true
        description: "a list of dependent interfaces"
      alerts:
        type: "array"
        items:
          $ref: "#/definitions/AlertInfo"
        x-nullable: true
        description: "a list of alerts raised against the connection"
      health:
        type: "string"
        x-nullable: true
        description: "(remote Qorus connections only) a string giving the health color code of the instance"
      instance-key:
        type: "string"
        x-nullable: true
        description: "(remote Qorus connections only) the Qorus instance key of the remote instance"
      omq-version:
        type: "string"
        x-nullable: true
        description: "(remote Qorus connections only) the Qorus version"
      alert-summary:
        $ref: "#/definitions/_SystemAlertInfo"
        description: "summary of alert info"
      error:
        type: "string"
        x-nullable: true
        description: "(remote Qorus connections only) any error summary string for the remote instance"
  ConnectionDependencyInfo:
    type: "object"
    required:
    - "type"
    - "name"
    - "version"
    - "desc"
    properties:
      type:
        type: "string"
        description: "the interface type; one of \"WORKFLOW\", \"SERVICE\", or \"JOB\""
      workflowid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the workflow ID (only present for workflows)"
      serviceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the service ID (only present for services)"
      jobid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the job ID (only present for jobs)"
      servicetype:
        type: "string"
        x-nullable: true
        description: "the service type (only present for services); one of \"user\" or \"system\""
      name:
        type: "string"
        description: "the interface name"
      version:
        type: "string"
        description: "the interface version"
      desc:
        type: "string"
        description: "a description of the interface (ex: \"job it-94-ar_payments-piteco-out v1.0 (23)\")"
  _SystemAlertInfo:
    type: "object"
    additionalProperties:
      description: not available
    x-nullable: true
  GroupInfo:
    type: "object"
    required:
    - "name"
    - "enabled"
    - "size"
    properties:
      name:
        type: "string"
        description: "the name of the group"
      enabled:
        type: "boolean"
        description: "the status of the group as a bool"
      size:
        type: "integer"
        format: "int64"
        description: "the total number of members of the group"
  KillResultInfo:
    type: "object"
    required:
    - "status"
    - "code"
    properties:
      status:
        type: "string"
        description: "either \"OK\" or \"ERR\""
      code:
        type: "integer"
        format: "int64"
        description: "the return code of the kill() command: 0 if successful, non-zero if not"
  _post-workflows-id_or_name-lockUserInteractionStep-body:
    type: "object"
    properties:
      stepid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the ID of the step to acquire user interaction data from; either this or stepname is required"
      stepname:
        type: "string"
        x-nullable: true
        description: "the name of the step to acquire user interaction data from; either this or stepid is required"
    x-nullable: true
  put-jobs-id_or_name-setActive-body:
    type: "object"
    required:
    - "active"
    properties:
      active:
        type: "boolean"
        description: "the new active state of the job"
  JobActiveUpdateInfo:
    type: "object"
    required:
    - "jobid"
    - "name"
    - "active"
    - "info"
    - "db_active"
    properties:
      jobid:
        type: "integer"
        format: "int64"
        description: "the job ID"
      name:
        type: "string"
        description: "the job name"
      active:
        type: "boolean"
        description: "the new active state of the job"
      info:
        type: "string"
        description: "a descriptive string"
      db_active:
        type: "boolean"
        description: "the active state in the DB (can differ from active if the job cannot be started for example)"
  put-jobs-id_or_name-setRemote-body:
    type: "object"
    required:
    - "remote"
    properties:
      remote:
        type: "boolean"
        description: "the new remote state of the job"
  JobRemoteUpdateInfo:
    type: "object"
    required:
    - "updated"
    - "remote"
    - "info"
    properties:
      updated:
        type: "boolean"
        description: "if the remote status was updated"
      remote:
        type: "boolean"
        description: "the new remote state of the job"
      info:
        type: "string"
        description: "a descriptive string"
  QorusSystemInfo:
    type: "object"
    required:
    - "instance-key"
    - "session-id"
    - "omq-version"
    - "omq-build"
    - "omq-version-code"
    - "qore-version"
    - "modules"
    - "datamodel-version"
    - "omq-schema"
    - "omq-driver"
    - "omquser-schema"
    - "omquser-driver"
    - "starttime"
    - "hostname"
    - "pid"
    - "threads"
    - "schema-properties"
    - "omq_dir"
    - "cache_size"
    - "shutting_down"
    - "build-type"
    - "alert-summary"
    - "debug"
    - "debug-internals"
    - "health"
    - "ui-compatibility-version"
    - "system_log_url"
    - "audit_log_url"
    - "http_log_url"
    - "mon_log_url"
    - "alert_log_url"
    - "api_version"
    - "cluster_info"
    - "processes"
    - "workflow_total"
    - "workflow_alerts"
    - "service_total"
    - "service_alerts"
    - "job_total"
    - "job_alerts"
    - "remote_total"
    - "remote_alerts"
    - "user_total"
    - "user_alerts"
    - "datasource_total"
    - "datasource_alerts"
    - "order_stats"
    - "loggerParams"
    - "auth_label_values"
    - "limits"
    - "default_mapper_keys"
    - "pipeline_options"
    - "stack_size"
    - "edition"
    - "templates"
    - "tz_region"
    - "tz_utc_offset"
    properties:
      instance-key:
        type: "string"
        description: "the system instance key"
      session-id:
        type: "integer"
        format: "int64"
        description: "the application session id"
      omq-version:
        type: "string"
        description: "the version of the Qorus server"
      omq-build:
        type: "string"
        description: "the git hash of the current Qorus build"
      omq-version-code:
        type: "integer"
        format: "int64"
        description: "an integer code for the Qorus version as MMmmSS, where MM = the major version, mm = the minor version, SS == the sub version"
      qore-version:
        type: "string"
        description: "the version of the underlying qore library used"
      modules:
        $ref: "#/definitions/QorusModuleSetInfo"
        description: "a hash of module info as returned by Qore::get_module_hash(); keys are module names"
      datamodel-version:
        type: "string"
        description: "the version of the datamodel expected by the server"
      omq-schema:
        type: "string"
        description: "\"user@dbname\" string for the system \"omq\" datasource"
      omq-driver:
        type: "string"
        description: "driver name for the system \"omq\" datasource"
      omq-db-version:
        description: "database server version for the system \"omq\" datasource; the data type depends on the driver"
      omquser-schema:
        type: "string"
        description: "\"user@dbname\" string for the \"omquser\" datasource"
      omquser-driver:
        type: "string"
        description: "driver name for the \"omquser\" datasource"
      omquser-db-version:
        description: "database server version for the \"omquser\" datasource; the data type depends on the driver"
      starttime:
        type: "string"
        format: "date-time"
        description: "date and time the qorus-core server was started"
      hostname:
        type: "string"
        description: "hostname where the qorus-core server is running"
      pid:
        type: "integer"
        format: "int64"
        description: "PID of the server process"
      threads:
        type: "integer"
        format: "int64"
        description: "count of currently active threads in qorus-core"
      schema-properties:
        $ref: "#/definitions/QorusSchemaInfo"
        description: "information about the system schema"
      omq_dir:
        type: "string"
        description: "the full path on the host to the Qorus application directory"
      cache_size:
        type: "integer"
        format: "int64"
        description: "The number of entries in the workflow order data cache"
      shutting_down:
        type: "boolean"
        description: "indicates if the system is shutting down or not"
      build-type:
        type: "string"
        description: "the build type (normally \"Production\" for public releases)"
      runtime-properties:
        $ref: "#/definitions/_UndefinedHash"
        description: "any runtime properties set on the instance"
      alert-summary:
        $ref: "#/definitions/SystemAlertInfo"
        description: "summary of alerts"
      debug:
        type: "boolean"
        description: "indicates if debugging is enabled for the instance"
      debug-internals:
        type: "boolean"
        description: "indicates if internal debugging is enabled for the instance"
      health:
        type: "string"
        description: "a string indicating the health status of the instance"
      ui-compatibility-version:
        type: "string"
        description: "a string indicating the UI compatibility for the instance"
      plugins:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "any installed plugins"
      system_log_url:
        type: "string"
        description: "a WebSocket URL for system log streaming"
      audit_log_url:
        type: "string"
        description: "a WebSocket URL for audit log streaming"
      http_log_url:
        type: "string"
        description: "a WebSocket URL for HTTP log streaming"
      mon_log_url:
        type: "string"
        description: "a WebSocket URL for connection monitor log streaming"
      alert_log_url:
        type: "string"
        description: "a WebSocket URL for alert log streaming"
      api_version:
        type: "string"
        description: "the current API version"
      cluster_info:
        $ref: "#/definitions/QorusClusterSetInfo"
        description: "cluster info; keys are node (container) names"
      processes:
        $ref: "#/definitions/QorusProcessSetInfo"
        description: "process info; keys are process IDs"
      workflow_total:
        type: "integer"
        format: "int64"
        description: "total number of workflows cached"
      workflow_alerts:
        type: "integer"
        format: "int64"
        description: "number of workflows with alerts"
      service_total:
        type: "integer"
        format: "int64"
        description: "total number of services cached"
      service_alerts:
        type: "integer"
        format: "int64"
        description: "number of services with alerts"
      job_total:
        type: "integer"
        format: "int64"
        description: "total number of jobs cached"
      job_alerts:
        type: "integer"
        format: "int64"
        description: "number of jobs with alerts"
      remote_total:
        type: "integer"
        format: "int64"
        description: "number of remote Qorus connections"
      remote_alerts:
        type: "integer"
        format: "int64"
        description: "number of remote Qorus connections with alerts"
      user_total:
        type: "integer"
        format: "int64"
        description: "number of user connections"
      user_alerts:
        type: "integer"
        format: "int64"
        description: "number of user connections with alerts"
      datasource_total:
        type: "integer"
        format: "int64"
        description: "number of datasource connections"
      datasource_alerts:
        type: "integer"
        format: "int64"
        description: "number of datasource connections with alerts"
      order_stats:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        description: "list of order status information"
      loggerParams:
        $ref: "#/definitions/UndefinedHash"
        description: "logger param info"
      auth_label_values:
        type: "array"
        items:
          type: "string"
        description: "list of auth label values"
      grafana_panel_ids:
        $ref: "#/definitions/_UndefinedHash"
        description: "hash of grafana panel ID info"
      limits:
        $ref: "#/definitions/QorusLimitInfo"
        description: "Qorus system limit information"
      default_mapper_keys:
        $ref: "#/definitions/UndefinedHash"
        description: "default mapper key info"
      pipeline_options:
        $ref: "#/definitions/UndefinedHash"
        description: "pipeline option info"
      stack_size:
        type: "integer"
        format: "int64"
        description: "thread stack size"
      edition:
        type: "string"
        description: "Enterprise for Qorus Integration Engine(R) Enterprise Edition"
      templates:
        type: "array"
        items:
          $ref: "#/definitions/TemplateInfo"
        description: "a list of template info hashes"
      tz_region:
        type: "string"
        description: "the time zone region the server is running in"
      tz_utc_offset:
        type: "integer"
        format: "int64"
        description: "the UTC offset in seconds east of UTC; negative numbers indicate west of UTC"
  QorusModuleSetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/QorusModuleInfo"
  QorusModuleInfo:
    type: "object"
    required:
    - "filename"
    - "name"
    - "desc"
    - "version"
    - "author"
    - "injected"
    - "reinjected"
    properties:
      filename:
        type: "string"
        description: "the path to the module on the host filesystem"
      name:
        type: "string"
        description: "the name of the module"
      desc:
        type: "string"
        description: "a short description of the module"
      version:
        type: "string"
        description: "the version string of the module"
      author:
        type: "string"
        description: "the module author's name"
      url:
        type: "string"
        x-nullable: true
        description: "the URL for the module"
      license:
        type: "string"
        x-nullable: true
        description: "the license for the module"
      reexported-modules:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "list of modules rexported by this module, if any"
      injected:
        type: "boolean"
        description: "if this module was injected"
      reinjected:
        type: "boolean"
        description: "if this module was reinjected"
      user:
        type: "boolean"
        x-nullable: true
        description: "if this is a user module"
      api_major:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the API major version for binary modules"
      api_minor:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the API minor version for binary modules"
  QorusSchemaInfo:
    type: "object"
    required:
    - "schema-version"
    - "schema-compatibility"
    - "schema-load-compatibility"
    properties:
      schema-version:
        type: "string"
        description: "the full system schema version"
      schema-compatibility:
        type: "string"
        description: "the runtime compatible version"
      schema-load-compatibility:
        type: "string"
        description: "the load (oload) compatible version"
  SystemAlertInfo:
    type: "object"
    required:
    - "transient"
    - "ongoing"
    properties:
      transient:
        type: "integer"
        format: "int64"
        description: "number of current transient alerts"
      ongoing:
        type: "integer"
        format: "int64"
        description: "number of ongoing alerts"
  QorusClusterSetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/QorusClusterInfo"
  QorusClusterInfo:
    type: "object"
    required:
    - "node_priv"
    - "node_priv_str"
    - "node_ram"
    - "node_ram_str"
    - "node_ram_in_use"
    - "node_ram_in_use_str"
    - "node_cpu_count"
    - "node_load_pct"
    - "mem_history"
    - "process_count"
    - "process_history"
    properties:
      node_priv:
        type: "integer"
        format: "int64"
        description: "the memory in use on this node in bytes"
      node_priv_str:
        type: "string"
        description: "the memory in use on this node"
      node_ram:
        type: "integer"
        format: "int64"
        description: "the total RAM on the host machine in bytes"
      node_ram_str:
        type: "string"
        description: "the total RAM on the host machine"
      node_ram_in_use:
        type: "integer"
        format: "int64"
        description: "the amount of RAM in use on the host machine in bytes"
      node_ram_in_use_str:
        type: "string"
        description: "the amount of RAM in use on the host machine"
      node_cpu_count:
        type: "integer"
        format: "int64"
        description: "the number of CPU cores on the host machine"
      node_load_pct:
        type: "number"
        format: "double"
        description: "the CPU load on the host machine"
      mem_history:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        description: "memory history list"
      process_count:
        type: "integer"
        format: "int64"
        description: "number of processes running"
      process_history:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        description: "process history list"
  QorusProcessSetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/QorusProcessInfo"
  QorusProcessInfo:
    type: "object"
    required:
    - "id"
    - "node"
    - "status"
    - "status_string"
    - "urls"
    - "host"
    - "pid"
    - "type"
    - "client_id"
    - "started"
    - "vsz"
    - "rss"
    - "priv"
    - "priv_str"
    properties:
      id:
        type: "string"
        description: "unique process ID"
      node:
        type: "string"
        description: "the node (container) name where the process is running"
      status:
        type: "integer"
        format: "int64"
        description: "process status code"
      status_string:
        type: "string"
        description: "process status string"
      urls:
        type: "array"
        items:
          type: "string"
        description: "list of ZeroMQ URLs for the process"
      host:
        type: "string"
        description: "the hostname of the node (container) where the process is running"
      pid:
        type: "integer"
        format: "int64"
        description: "the PID in the host of the process"
      type:
        type: "string"
        description: "the process type"
      client_id:
        type: "string"
        description: "the client ID for the process"
      started:
        type: "string"
        format: "date-time"
        description: "the date and time the process was started"
      vsz:
        type: "integer"
        format: "int64"
        description: "current virtual process size in bytes"
      rss:
        type: "integer"
        format: "int64"
        description: "current resident process size in bytes"
      priv:
        type: "integer"
        format: "int64"
        description: "current private (real memory) size in bytes"
      priv_str:
        type: "string"
        description: "current private (real memory) size for the process"
  QorusLimitInfo:
    type: "object"
    required:
    - "nofile"
    - "nproc"
    properties:
      nofile:
        type: "integer"
        format: "int64"
        description: "maximum number of open files"
      nproc:
        type: "integer"
        format: "int64"
        description: "maximum number of procesess / threads"
  TemplateInfo:
    type: "object"
    required:
    - "name"
    - "desc"
    - "doc_url"
    - "valid_context"
    - "access"
    properties:
      name:
        type: "string"
        description: "the name of the template"
      desc:
        type: "string"
        description: "a markdown description of the template"
      doc_url:
        type: "string"
        description: "a URL to online documentation for the template"
      valid_context:
        type: "integer"
        format: "int64"
        description: "a bitfield of TemplateContextValues giving the valid context for the template"
      access:
        type: "integer"
        format: "int64"
        description: "a bitfield of read/write access information for the template; 1 = read, 2 = write"
  JobDetailInfo:
    type: "object"
    required:
    - "name"
    - "jobid"
    - "version"
    - "remote"
    - "manual_remote"
    - "open"
    - "run_skipped"
    - "enabled"
    - "code"
    - "class_based"
    - "language"
    - "manually_updated"
    - "created"
    - "modified"
    - "db_active"
    - "active"
    - "manual_active"
    - "options"
    - "sched_type"
    - "sched_txt"
    properties:
      name:
        type: "string"
        description: "the name of the job"
      jobid:
        type: "integer"
        format: "int64"
        description: "the job ID"
      description:
        type: "string"
        x-nullable: true
        description: "the description of the job (if any)"
      version:
        type: "string"
        description: "the version of the job"
      author:
        type: "string"
        x-nullable: true
        description: "the author of the job (if any)"
      sessionid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "If the job is currently active and running on a Qorus instance, then this attribute will have a value, otherwise it will not be set"
      remote:
        type: "boolean"
        description: "the remote state of the job; if True, the job will run remotely in a qjob process; if False, it will run in qorus-core"
      manual_remote:
        type: "boolean"
        description: "set if the manual value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      open:
        type: "boolean"
        description: "if the current workflow is open for processing now"
      run_skipped:
        type: "boolean"
        description: "A boolean value telling the system if the job should be run immediately if the last scheduled run was missed due to system downtime"
      enabled:
        type: "boolean"
        description: "flag indicating if the job is enabled or not; disabled jobs cannot be activated"
      code:
        type: "string"
        description: "the source code for the job"
      class_based:
        type: "boolean"
        description: "True means that the job is an extension of the QorusJob class, otherwise it is a function-based job"
      class_name:
        type: "string"
        x-nullable: true
        description: "the name of the job class, if any"
      language:
        type: "string"
        description: "the programming language that the job's main code is implemented in"
      month:
        type: "string"
        x-nullable: true
        description: "the month value in a job cron schedule"
      day:
        type: "string"
        x-nullable: true
        description: "the day value in a job cron schedule"
      wday:
        type: "string"
        x-nullable: true
        description: "the weekday value in a job cron schedule"
      hour:
        type: "string"
        x-nullable: true
        description: "the hout value in a job cron schedule"
      minute:
        type: "string"
        x-nullable: true
        description: "the minute value in a job cron schedule"
      expiry_date:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the expiry date of the job, if any"
      last_executed:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the date-time value the job was last executed, if any"
      last_executed_job_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the last job instance ID, if any"
      manually_updated:
        type: "boolean"
        description: "flag set if the job schedule has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      created:
        type: "string"
        format: "date-time"
        description: "the date/time the job was created"
      modified:
        type: "string"
        format: "date-time"
        description: "the date/time the job was modified"
      source:
        type: "string"
        x-nullable: true
        description: "the complete path of the job source file when loaded"
      line:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the line offset of the job source code in the file"
      config_items:
        type: "array"
        items:
          $ref: "#/definitions/ConfigItemDetailInfo"
        x-nullable: true
        description: "list of config items attached directly to the job"
      fsm_triggers:
        $ref: "#/definitions/_FsmTriggerSet"
        description: "a hash keyed by finite state machine name giving triggers for each flow"
      next:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the next automatic job execution time time, if any"
      schedule:
        type: "string"
        x-nullable: true
        description: "the schedule for the job as a string"
      mappers:
        type: "array"
        items:
          $ref: "#/definitions/MapperInfo"
        x-nullable: true
        description: "list of mappers associated with the job"
      vmaps:
        type: "array"
        items:
          $ref: "#/definitions/VMapInfo"
        x-nullable: true
        description: "a list of value maps associated with the job"
      lib:
        $ref: "#/definitions/_LibraryInfo"
        description: "a hash of library information for the job"
      tags:
        $ref: "#/definitions/_UndefinedHash"
        description: "any tags for the job"
      config:
        $ref: "#/definitions/_ConfigItemSummarySetInfo"
        description: "a hash of configuration item info keyed by config item name"
      groups:
        type: "array"
        items:
          $ref: "#/definitions/GroupInfo"
        x-nullable: true
        description: "a list of interface groups that the job belongs to"
      offset:
        type: "string"
        x-nullable: true
        description: "the line offset of the job source code in the file"
      host:
        type: "string"
        x-nullable: true
        description: "the hostname of the machine where the job was loaded from"
      user:
        type: "string"
        x-nullable: true
        description: "the OS user who loaded the job"
      base_class_name:
        type: "string"
        x-nullable: true
        description: "the base class name of the job, if any"
      process:
        $ref: "#/definitions/_ProcessExecInfo"
        description: "present when remote is True"
      COMPLETE:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of job results with status COMPLETE"
      IN-PROGRESS:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of job results with status IN-PROGRESS"
      ERROR:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of job results with status ERROR"
      CRASH:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "number of job results with status CRASH"
      connections:
        type: "array"
        items:
          $ref: "#/definitions/ConnectionInfo"
        x-nullable: true
        description: "a list of connection objects that this job depends on"
      alerts:
        type: "array"
        items:
          $ref: "#/definitions/AlertInfo"
        x-nullable: true
        description: "a list of alerts raised against the job"
      db_active:
        type: "boolean"
        description: "a boolean flag indicating the active status in the database"
      active:
        type: "boolean"
        description: "the active status in the current Qorus instance"
      manual_active:
        type: "boolean"
        description: "set if the active value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      log_url:
        type: "string"
        x-nullable: true
        description: "the log URL (if any)"
      options:
        type: "array"
        items:
          $ref: "#/definitions/OptionInfoHash"
        description: "a list option information hashes"
      sched_type:
        type: "string"
        description: "the schedule type; one of \"cron\" (uses a job cron schedule), or \"recurring\" ( uses a fixed repeat delay)"
      sched_txt:
        type: "string"
        description: "a string describing the schedule (ex: \"minutes: 0, hours: 0, days: *, months: *, wdays: *\")"
      sla:
        type: "string"
        x-nullable: true
        description: "the name of the attached SLA, if any)"
      state:
        $ref: "#/definitions/_UndefinedHash"
        description: "any job state data"
      persistent-state:
        $ref: "#/definitions/_UndefinedHash"
        description: "any persistent job state data"
  ConfigItemDetailInfo:
    type: "object"
    required:
    - "name"
    - "description"
    - "config_group"
    - "type"
    - "sensitive"
    - "strictly_local"
    - "is_default_value_templated_string"
    - "is_value_templated_string"
    properties:
      name:
        type: "string"
        description: "the name of the configuration item"
      parent:
        $ref: "#/definitions/_ConfigItemParentInfo"
        description: "config item parent information"
      prefix:
        type: "string"
        x-nullable: true
        description: "the prefix of the configuration item"
      value:
        description: "the value of the configuration item"
      description:
        type: "string"
        description: "the description of the configuration item"
      config_group:
        type: "string"
        description: "the group of the configuration item"
      type:
        type: "string"
        description: "the data type of the configuration item"
      sensitive:
        type: "boolean"
        description: "if the value is sensitive or not"
      default_value:
        description: "the default value of the configuration item"
      strictly_local:
        type: "boolean"
        description: "if the configuration item is defined strictly on local level"
      allowed_values:
        type: "array"
        items:
          $ref: "#/definitions/AnyType"
        x-nullable: true
        description: "the list of allowed values for the configuration item if defined"
      is_default_value_templated_string:
        type: "boolean"
        description: "true if the default value is a templated string that can be later expanded"
      is_value_templated_string:
        type: "boolean"
        description: "true if the value is a templated string that can be later expanded"
  _ConfigItemParentInfo:
    type: "object"
    required:
    - "interface-type"
    - "interface-name"
    - "interface-version"
    properties:
      interface-type:
        type: "string"
        description: "the type of parent providing the config item"
      interface-name:
        type: "string"
        description: "the name of the parent providing the config item"
      interface-version:
        type: "string"
        description: "the version of the parent providing the config item"
    x-nullable: true
  _FsmTriggerSet:
    type: "object"
    additionalProperties:
      type: "array"
      items:
        $ref: "#/definitions/FsmTriggerInfo"
    x-nullable: true
  FsmTriggerInfo:
    type: "object"
    required:
    - "method"
    properties:
      method:
        type: "string"
        description: "the string \"run\""
  post-workflows-id_or_name-execSynchronousAsync-body:
    type: "object"
    required:
    - "staticdata"
    properties:
      external_order_instanceid:
        type: "string"
        x-nullable: true
        description: "the external order instance ID for the workflow data; either this key or staticdata is required"
      dynamicdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "the initial dynamic data for the order"
      global_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); if this key already exists for any order in the system, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
      orderkeys:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of order keys for the order"
      parent_workflow_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "a loosely-coupled workflow that will be marked as the parent of this workflow"
      priority:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the order priority (default OMQ::DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest"
      sensitive_data:
        $ref: "#/definitions/_SensitiveDataSetInfo"
        description: "a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values"
      staticdata:
        $ref: "#/definitions/UndefinedHash"
        description: "the static data for the order; either this key or external_order_instanceid is required"
      workflow_specific_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); if this key already exists for an order with the target workflowid, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
      workflow_unique_key:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); if this key already exists for a workflow order with the same name, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key"
  put-dataprovider-compareTypes-body:
    type: "object"
    required:
    - "base_type"
    - "type"
    properties:
      base_type:
        $ref: "#/definitions/QorusTypeInfo"
        description: "hash describing the input or receiving type (type of variable to accept type)"
      type:
        $ref: "#/definitions/QorusTypeInfo"
        description: "a hash describing the output or sending type (type of value to be assigned to base_type)"
  QorusTypeInfo:
    type: "object"
    required:
    - "type"
    - "name"
    properties:
      type:
        type: "string"
        description: "one of connection, datasource, factory, remote, or type"
      name:
        type: "string"
        description: "the name of the type, connection, factory, etc"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the final object"
      subtype:
        type: "string"
        x-nullable: true
        description: "the subtype for type = connection"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "create option for type = factory"
      hasApiContext:
        type: "boolean"
        x-nullable: true
        description: "True if the type is a factory with options to be handled in an API"
  QorusBooleanSetInfo:
    type: "object"
    additionalProperties:
      type: "boolean"
  DataProviderTypeInfo:
    type: "object"
    required:
    - "name"
    - "desc"
    - "base_type"
    - "mandatory"
    - "types_accepted"
    - "types_returned"
    - "can_manage_fields"
    - "or_nothing_type"
    properties:
      name:
        type: "string"
        description: "the type name"
      desc:
        type: "string"
        description: "the description of the type"
      supported_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "transformation options supported by the type"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "transformation option values"
      base_type:
        type: "string"
        description: "the Qore base type name"
      mandatory:
        type: "boolean"
        description: "can be null / missing?"
      types_accepted:
        type: "array"
        items:
          type: "string"
        description: "list of types accepted on input"
      types_returned:
        type: "array"
        items:
          type: "string"
        description: "list of types returned"
      fields:
        $ref: "#/definitions/_UndefinedHash"
        description: "fields supported by the type"
      can_manage_fields:
        type: "boolean"
        description: "true if fields can be added dynamically to the type"
      tags:
        $ref: "#/definitions/_UndefinedHash"
        description: "any tags set on the type"
      or_nothing_type:
        type: "boolean"
        description: "if true, the type will accept NOTHING"
  put-dataprovider-compareManyTypes-body:
    type: "object"
    required:
    - "types"
    properties:
      types:
        $ref: "#/definitions/QorusTypeComparisonSetInfo"
        description: "a hash of hashes keyed by a unique user-defined comparison identifier"
  QorusTypeComparisonSetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/QorusTypeComparisonInfo"
  QorusTypeComparisonInfo:
    type: "object"
    required:
    - "base_type"
    - "type"
    properties:
      base_type:
        $ref: "#/definitions/QorusTypeInfo"
        description: "hash describing the input or receiving type (type of variable to accept type)"
      type:
        $ref: "#/definitions/QorusTypeInfo"
        description: "a hash describing the output or sending type (type of value to be assigned to base_type)"
  WorkflowOrderInfo:
    type: "object"
    required:
    - "name"
    - "version"
    - "workflow_instanceid"
    - "workflowid"
    - "workflowstatus"
    - "status_sessionid"
    - "synchronous"
    - "business_error"
    - "priority"
    - "started"
    - "modified"
    - "note_count"
    - "deprecated"
    - "autostart"
    - "manual_autostart"
    - "has_sensitive_data"
    - "warning_count"
    - "error_count"
    - "retry_count"
    - "StepInstances"
    - "HierarchyInfo"
    - "LastModified"
    properties:
      name:
        type: "string"
        description: "the name of the workflow"
      version:
        type: "string"
        description: "the version of the workflow"
      author:
        type: "string"
        x-nullable: true
        description: "the author of the workflow"
      patch:
        type: "string"
        x-nullable: true
        description: "the workflow patch string (if any)"
      workflow_instanceid:
        type: "integer"
        format: "int64"
        description: "the workflow order instance ID"
      workflowid:
        type: "integer"
        format: "int64"
        description: "the ID of the workflow"
      workflowstatus:
        type: "string"
        description: "the status of the workflow order (see StatusDescriptions for possible values)"
      status_sessionid:
        type: "integer"
        format: "int64"
        description: "the ID of the Qorus application session managing the workflow order data or 0 if none"
      parent_workflow_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the workflow order instance ID of the parent order for this workflow if any"
      subworkflow:
        type: "boolean"
        x-nullable: true
        description: "indicates if the parent_workflow_instanceid is the parent workflow order in a subworkflow relationship"
      synchronous:
        type: "boolean"
        description: "indicates if the order is being executed synchronously"
      archive:
        type: "boolean"
        x-nullable: true
        description: "indicates if the order has been archived"
      business_error:
        type: "boolean"
        description: "indicates if the workflow order has an error status due to a business error"
      workflowstatus_orig:
        type: "string"
        x-nullable: true
        description: "if the order status is OMQ::StatBlocked or OMQ::StatCanceled, this value will reflect the original status of the workflow order (see StatusDescriptions for possible values)"
      custom_status:
        type: "string"
        x-nullable: true
        description: "a custom status for the order"
      scheduled:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the scheduled date"
      priority:
        type: "integer"
        format: "int64"
        description: "the priority of the workflow order"
      started:
        type: "string"
        format: "date-time"
        description: "the date/time the order was created"
      completed:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the date/time order processing completed"
      modified:
        type: "string"
        format: "date-time"
        description: "the last modified date/time for the order"
      operator_lock:
        type: "string"
        x-nullable: true
        description: "a string giving the username of the user with an operator lock on the order"
      note_count:
        type: "integer"
        format: "int64"
        description: "the number of notes stored against the order"
      deprecated:
        type: "boolean"
        description: "a boolean value indicating if the workflow is deprecated or not; deprecated workflows are hidden by default in the UI"
      autostart:
        type: "integer"
        format: "int64"
        description: "the integer autostart value for the workflow"
      manual_autostart:
        type: "boolean"
        description: "a boolean flag set if the autostart value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      max_instances:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "a value limiting the maximum number of execution instances that can run at once"
      external_order_instanceid:
        type: "string"
        x-nullable: true
        description: "a unique external key for the order"
      staticdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of workflow order static data"
      dynamicdata:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of workflow order dynamic data (if any)"
      sensitive_data:
        $ref: "#/definitions/_SensitiveDataSetInfo"
        description: "any sensitive data information for the workflow; this information is only present when retrieving the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values"
      has_sensitive_data:
        type: "boolean"
        description: "indicates if the order has sensitive data"
      stepdata:
        type: "array"
        items:
          $ref: "#/definitions/StepDataInfo"
        x-nullable: true
        description: "a list of step data information"
      keys:
        $ref: "#/definitions/_OrderKeySet"
        description: "a hash of workflow order keys and values"
      warning_count:
        type: "integer"
        format: "int64"
        description: "the number of warnings raised against the order"
      error_count:
        type: "integer"
        format: "int64"
        description: "the number of errors raised against the order"
      retry_count:
        type: "integer"
        format: "int64"
        description: "the number of times the order was subject to a RETRY status due to a technical error"
      StepInstances:
        type: "array"
        items:
          $ref: "#/definitions/StepInstanceInfo"
        description: "a list of step hashes giving information about the execution status of workflow steps"
      ErrorInstances:
        type: "array"
        items:
          $ref: "#/definitions/ErrorInstanceInfo"
        x-nullable: true
        description: "a list of hashes giving information about errors and warnings raised against the order"
      HierarchyInfo:
        $ref: "#/definitions/OrderHierarchySetInfo"
        description: "a hash of workflow order information; the keys are workflow order instance IDs for all workflow orders linked to each other through parent-child relationships in the hierarchy of the current workflow order"
      AuditEvents:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        x-nullable: true
        description: "a list of audit information hashes"
      LastModified:
        type: "string"
        format: "date-time"
        description: "the last modified date/time of the workflow order"
      staticdata_type_path:
        type: "string"
        x-nullable: true
        description: "the type path name for the workflow's static data, if any"
      actions:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "a list of possible actions on the workflow"
      notes:
        type: "array"
        items:
          $ref: "#/definitions/NoteInfo"
        x-nullable: true
        description: "a list of notes saved against the order"
  StepDataInfo:
    type: "object"
    required:
    - "name"
    - "version"
    - "stepid"
    - "steptype"
    - "arraytype"
    - "data"
    properties:
      name:
        type: "string"
        description: "the step name"
      version:
        type: "string"
        description: "the step version"
      stepid:
        type: "integer"
        format: "int64"
        description: "the step ID"
      steptype:
        type: "string"
        description: "the step type"
      arraytype:
        type: "string"
        description: "the step array type"
      data:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        description: "list of hashes of the dynamic step data per step index"
  _OrderKeySet:
    type: "object"
    additionalProperties:
      type: "array"
      items:
        type: "string"
      x-nullable: true
    x-nullable: true
  StepInstanceInfo:
    type: "object"
    required:
    - "workflow_instanceid"
    - "stepid"
    - "ind"
    - "stepname"
    - "stepversion"
    - "steptype"
    - "stepstatus"
    - "skip"
    - "started"
    - "user_interaction"
    - "business_error"
    properties:
      workflow_instanceid:
        type: "integer"
        format: "int64"
        description: "the workflow instance ID for the step"
      stepid:
        type: "integer"
        format: "int64"
        description: "the ID of the step"
      ind:
        type: "integer"
        format: "int64"
        description: "the step array index starting with 0"
      stepname:
        type: "string"
        description: "the name of the step"
      stepversion:
        type: "string"
        description: "the version of the step"
      steptype:
        type: "string"
        description: "type of the step"
      stepstatus:
        type: "string"
        description: "the current execution status of the step (see StatusDescriptions for possible values)"
      retries:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the number of retries executed on the step"
      skip:
        type: "boolean"
        description: "a boolean value indicating if the step logic was skipped"
      custom_status:
        type: "string"
        x-nullable: true
        description: "a custom status for the step"
      started:
        type: "string"
        format: "date-time"
        description: "the date/time the step was first executed"
      completed:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the date/time step processing completed"
      function_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the function ID of the primary step function"
      subworkflow_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the workflow order ID of any subworkflow order instance (for bound subworkflow steps only)"
      user_interaction:
        type: "boolean"
        description: "if the step supports user interaction"
      workflow_event_typeid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the event type ID for workflow event steps"
      eventkey:
        type: "string"
        x-nullable: true
        description: "the event key value for workflow event steps"
      queueid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the asynchronous queue ID for asynchronous steps"
      queuename:
        type: "string"
        x-nullable: true
        description: "the asynchronous queue name for asynchronous steps"
      business_error:
        type: "boolean"
        description: "a boolean flag indicating if the step has an error status due to a business error"
  ErrorInstanceInfo:
    type: "object"
    required:
    - "error_instanceid"
    - "workflow_instanceid"
    - "severity"
    - "retry"
    - "error"
    - "business_error"
    - "created"
    properties:
      error_instanceid:
        type: "integer"
        format: "int64"
        description: "a unique ID for the error"
      workflow_instanceid:
        type: "integer"
        format: "int64"
        description: "the workflow order instance ID"
      stepid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the stepid where the error was raised"
      ind:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the step array index starting with 0 where the error was raised"
      severity:
        type: "string"
        description: "the severity of the error (see ErrorSeverityCodes for possible values)"
      retry:
        type: "integer"
        format: "int64"
        description: "1 if the error caused a retry"
      error:
        type: "string"
        description: "the string error code for the error"
      description:
        type: "string"
        x-nullable: true
        description: "an optional description of the error"
      info:
        type: "string"
        x-nullable: true
        description: "an optional string providing additional information about the error"
      business_error:
        type: "boolean"
        description: "a boolean flag indicating if the error is a business error"
      created:
        type: "string"
        format: "date-time"
        description: "the date/time the error was created"
  OrderHierarchySetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/OrderHierarchyInfo"
  OrderHierarchyInfo:
    type: "object"
    required:
    - "name"
    - "version"
    - "workflow_instanceid"
    - "workflowid"
    - "workflowstatus"
    - "status_sessionid"
    - "synchronous"
    - "note_count"
    - "business_error"
    - "priority"
    - "started"
    - "modified"
    - "remote"
    - "manual_remote"
    - "open"
    - "autostart"
    - "manual_autostart"
    - "enabled"
    - "sla_threshold"
    - "has_detach"
    - "language"
    - "deprecated"
    - "created"
    - "hierarchy_level"
    - "error_count"
    - "warning_count"
    properties:
      name:
        type: "string"
        description: "the name of the workflow"
      version:
        type: "string"
        description: "the version of the workflow"
      workflow_instanceid:
        type: "integer"
        format: "int64"
        description: "the workflow order instance ID"
      workflowid:
        type: "integer"
        format: "int64"
        description: "the ID of the workflow"
      workflowstatus:
        type: "string"
        description: "the status of the workflow order (see StatusDescriptions for possible values)"
      status_sessionid:
        type: "integer"
        format: "int64"
        description: "the ID of the Qorus application session managing the workflow order data or 0 if none"
      parent_workflow_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the workflow order instance ID of the parent order for this workflow if any"
      subworkflow:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "if 1, indicates that the parent_workflow_instanceid is the parent workflow order in a subworkflow relationship"
      synchronous:
        type: "integer"
        format: "int64"
        description: "if 1, indicates that the order is being executed synchronously"
      retries:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the number of retries executed on the order"
      note_count:
        type: "integer"
        format: "int64"
        description: "the number of notes stored against the order"
      business_error:
        type: "boolean"
        description: "indicates if the workflow order has an error status due to a business error"
      workflowstatus_orig:
        type: "string"
        x-nullable: true
        description: "if the order status is OMQ::StatBlocked or OMQ::StatCanceled, this value will reflect the original status of the workflow order (see StatusDescriptions for possible values)"
      custom_status:
        type: "string"
        x-nullable: true
        description: "a custom status for the order"
      scheduled:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the scheduled date"
      priority:
        type: "integer"
        format: "int64"
        description: "the priority of the workflow order"
      started:
        type: "string"
        format: "date-time"
        description: "the date/time the order was created"
      completed:
        type: "string"
        format: "date-time"
        x-nullable: true
        description: "the date/time order processing completed"
      modified:
        type: "string"
        format: "date-time"
        description: "the last modified date/time for the order"
      operator_lock:
        type: "string"
        x-nullable: true
        description: "a string giving the username of the user with an operator lock on the order"
      patch:
        type: "string"
        x-nullable: true
        description: "the workflow patch string (if any)"
      author:
        type: "string"
        x-nullable: true
        description: "the author of the workflow"
      description:
        type: "string"
        x-nullable: true
        description: "an optional description of the workflow"
      remote:
        type: "integer"
        format: "int64"
        description: "the remote status of the workflow"
      manual_remote:
        type: "integer"
        format: "int64"
        description: "if the remote status has been manually changed"
      workflow_modules:
        type: "array"
        items:
          type: "string"
        x-nullable: true
        description: "a list of workflow modules"
      open:
        type: "boolean"
        description: "if the current workflow is open for processing now"
      autostart:
        type: "integer"
        format: "int64"
        description: "the autostart value"
      manual_autostart:
        type: "boolean"
        description: "a boolean flag set if the autostart value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oload"
      max_instances:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "a value limiting the maximum number of execution instances that can run at once"
      enabled:
        type: "boolean"
        description: "if the worklfow is currently enabled for execution"
      sla_threshold:
        type: "integer"
        format: "int64"
        description: "the nubmne of seconds that workflow orders should receive a final status"
      has_detach:
        type: "boolean"
        description: "if the workflow has detach logic"
      code:
        type: "string"
        x-nullable: true
        description: "workflow code, if any"
      language:
        type: "string"
        description: "the programming language for the workflow code"
      language_info:
        $ref: "#/definitions/_UndefinedHash"
        description: "any language-specific information for the wokflow code"
      class_name:
        type: "string"
        x-nullable: true
        description: "the workflow class's name, if any"
      staticdata_type_path:
        type: "string"
        x-nullable: true
        description: "the type path name for the workflow's static data, if any"
      errorfunction_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the error function instance ID, if any"
      attach_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the attach function instance ID, if any"
      detach_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the deatch function instance ID, if any"
      onetimeinit_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the one time init function instance ID, if any"
      errhandler_func_instanceid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the error handler function instance ID, if any"
      loggerid:
        type: "integer"
        format: "int64"
        x-nullable: true
        description: "the logger ID, if any"
      deprecated:
        type: "boolean"
        description: "the deprecated flag"
      created:
        type: "string"
        format: "date-time"
        description: "the creation date"
      custom_status_desc:
        type: "string"
        x-nullable: true
        description: "the custom status description, if any"
      hierarchy_level:
        type: "integer"
        format: "int64"
        description: "the level in the workflow order hierarchy"
      error_count:
        type: "integer"
        format: "int64"
        description: "number of errors"
      warning_count:
        type: "integer"
        format: "int64"
        description: "number of warnings"
  NoteInfo:
    type: "object"
    required:
    - "saved"
    - "username"
    - "note"
    - "created"
    - "modified"
    properties:
      saved:
        type: "boolean"
        description: "indicates if the note has already been synchronized to the database"
      username:
        type: "string"
        description: "the username of the user who created the note or \"system\" in case it was created automatically"
      note:
        type: "string"
        description: "the note text"
      created:
        type: "string"
        format: "date-time"
        description: "the creation date of the note"
      modified:
        type: "string"
        format: "date-time"
        description: "the modified date of the note"
  _put-dataprovider-factories-factory-provider-apiEndpoints-body:
    type: "object"
    properties:
      soft:
        type: "boolean"
        x-nullable: true
        description: "soft types are returned"
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor options"
    x-nullable: true
  _put-dataprovider-factories-factory-provider-Description-body:
    type: "object"
    properties:
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any options to be passed to a factory creation method when accessing this URI endpoint through a factory"
    x-nullable: true
  _put-dataprovider-browse-factory-provider-body:
    type: "object"
    properties:
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor options"
    x-nullable: true
  _put-dataprovider-browse-factory-provider-info-body:
    type: "object"
    properties:
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor options"
    x-nullable: true
  _put-dataprovider-browse-factory-provider-info-apiEndpoints-body:
    type: "object"
    properties:
      soft:
        type: "boolean"
        x-nullable: true
        description: "soft types are returned"
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor options"
    x-nullable: true
  _put-dataprovider-browse-factory-provider-info-Description-body:
    type: "object"
    properties:
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any options to be passed to a factory creation method when accessing this URI endpoint through a factory"
    x-nullable: true
  _put-dataprovider-browse-factory-provider-info-childDetails-body:
    type: "object"
    properties:
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor options"
    x-nullable: true
  DataProviderBrowseNavInfo:
    type: "object"
    required:
    - "name"
    properties:
      name:
        type: "string"
        description: "the name of the node"
  PingResultInfo:
    type: "object"
    required:
    - "ok"
    - "name"
    - "desc"
    - "url"
    - "opts"
    - "time"
    - "info"
    - "result"
    properties:
      ok:
        type: "boolean"
        description: "the status of the ping"
      name:
        type: "string"
        description: "the name of the connection"
      desc:
        type: "string"
        description: "the description of the connection"
      url:
        type: "string"
        description: "the URL for the connection"
      opts:
        $ref: "#/definitions/UndefinedHash"
        description: "a hash of options for the connection (if any)"
      time:
        type: "string"
        format: "date-time"
        description: "the elapsed time for the ping"
      info:
        type: "string"
        description: "\"OK\" if the ping was successful or an error message if not"
      result:
        type: "string"
        description: "a string representation of the time in seconds (ex: \"0.25s\")"
  _put-connections-name-body:
    type: "object"
    properties:
      desc:
        type: "string"
        x-nullable: true
        description: "a new description for the connection"
      url:
        type: "string"
        x-nullable: true
        description: "a new URL for the connection"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "new options for the connection"
      tags:
        $ref: "#/definitions/_UndefinedHash"
        description: "new tags for the connection"
    x-nullable: true
  _put-dataprovider-factories-factory-provider-search-body:
    type: "object"
    properties:
      provider_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any options to be passed to a factory creation method when accessing this URI endpoint through a factory"
      where_cond:
        $ref: "#/definitions/_UndefinedHash"
        description: "the where CreatorJobDefinitionRestClass"
      search_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any search options"
    x-nullable: true
  post-dataprovider-factories-factory-provider-providerCreate-body:
    type: "object"
    required:
    - "name"
    - "fields"
    properties:
      name:
        type: "string"
        description: "the name of the new child provider"
      fields:
        $ref: "#/definitions/QorusNewFieldSetInfo"
        description: "the set of fields making up the new record where keys are field names and values describe each field"
  QorusNewFieldSetInfo:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/QorusNewFieldInfo"
  QorusNewFieldInfo:
    type: "object"
    required:
    - "type"
    - "desc"
    properties:
      type:
        type: "string"
        description: "the type of the field"
      desc:
        type: "string"
        description: "field description"
      default_value:
        description: "the default value of the field if not present; the value must be compatible with the field's type"
      opts:
        $ref: "#/definitions/_UndefinedHash"
        description: "any options for the given type"
  post-slas-sla-success-body:
    type: "object"
    required:
    - "value"
    properties:
      value:
        type: "number"
        format: "double"
        description: "the event value"
  post-slas-sla-error-body:
    type: "object"
    required:
    - "value"
    - "err"
    - "desc"
    properties:
      value:
        type: "number"
        format: "double"
        description: "the event value"
      err:
        type: "string"
        description: "the error code"
      desc:
        type: "string"
        description: "the error description"
  put-dataprovider-type-body:
    type: "object"
    required:
    - "type"
    properties:
      soft:
        type: "boolean"
        x-nullable: true
        description: "if a \"soft\" type should be returned"
      type:
        $ref: "#/definitions/QorusTypeInfo"
        description: "hash describing the input or receiving type (type of variable to accept type)"
  post-dataprovider-callApi-body:
    type: "object"
    required:
    - "type"
    - "name"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "factory constructor options; invalid options are silently ignored"
      args:
        description: "any arguments to the API call; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve arguments"
      request_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any request options"
  post-dataprovider-callApiFromUi-body:
    type: "object"
    required:
    - "type"
    - "name"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "factory constructor options; invalid options are silently ignored"
      args:
        description: "any arguments to the API call; if this argument is a hash, then each hash key must be assigned a hash value with type and value keys, additionally, if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve arguments"
      request_options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "any request options"
  _UndefinedUiHash:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/TypeValueInfo"
    x-nullable: true
  TypeValueInfo:
    type: "object"
    required:
    - "type"
    properties:
      type:
        type: "string"
        description: "the expected type of the argument"
      value:
        description: "the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML format"
  post-dataprovider-searchRecords-body:
    type: "object"
    required:
    - "type"
    - "name"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "factory constructor options; invalid options are silently ignored"
      where:
        $ref: "#/definitions/_UndefinedHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any search options"
  post-dataprovider-searchRecordsFromUi-body:
    type: "object"
    required:
    - "type"
    - "name"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "factory constructor options; invalid options are silently ignored"
      where:
        $ref: "#/definitions/_UndefinedHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "any search options"
  post-dataprovider-searchSingleRecord-body:
    type: "object"
    required:
    - "type"
    - "name"
    - "where"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "factory constructor options; invalid options are silently ignored"
      where:
        $ref: "#/definitions/UndefinedHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any search options"
  post-dataprovider-searchSingleRecordFromUi-body:
    type: "object"
    required:
    - "type"
    - "name"
    - "where"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "factory constructor options; invalid options are silently ignored"
      where:
        $ref: "#/definitions/UndefinedUiHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "any search options"
  UndefinedUiHash:
    type: "object"
    additionalProperties:
      $ref: "#/definitions/TypeValueInfo"
  post-dataprovider-updateRecords-body:
    type: "object"
    required:
    - "type"
    - "name"
    - "set"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "factory constructor options; invalid options are silently ignored"
      set:
        $ref: "#/definitions/UndefinedHash"
        description: "keys are field names and values are field values to be updated; values will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      where:
        $ref: "#/definitions/_UndefinedHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any search options"
  post-dataprovider-updateRecordsFromUi-body:
    type: "object"
    required:
    - "type"
    - "name"
    - "set"
    - "where"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "factory constructor options; invalid options are silently ignored"
      set:
        $ref: "#/definitions/UndefinedUiHash"
        description: "keys are field names and values are field values to be updated; values will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      where:
        $ref: "#/definitions/UndefinedUiHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "any search options"
  post-dataprovider-deleteRecords-body:
    type: "object"
    required:
    - "type"
    - "name"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "factory constructor options; invalid options are silently ignored"
      where:
        $ref: "#/definitions/_UndefinedHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedHash"
        description: "any search options"
  post-dataprovider-deleteRecordsFromUi-body:
    type: "object"
    required:
    - "type"
    - "name"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "factory constructor options; invalid options are silently ignored"
      where:
        $ref: "#/definitions/_UndefinedHash"
        description: "the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
      search_options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "any search options"
  post-dataprovider-createRecords-body:
    type: "object"
    required:
    - "type"
    - "name"
    - "records"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedHash"
        description: "factory constructor options; invalid options are silently ignored"
      records:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedHash"
        description: "the list of new records; each hash in the list represents a new record and must have keys that correspond to valid field names, values are subjected to template resolution by calls to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
  post-dataprovider-createRecordsFromUi-body:
    type: "object"
    required:
    - "type"
    - "name"
    - "records"
    properties:
      type:
        type: "string"
        description: "the type of path: factory, connection, datasource, or remote"
      name:
        type: "string"
        description: "the initial segment of the data provider path"
      path:
        type: "string"
        x-nullable: true
        description: "the path to the data provider"
      options:
        $ref: "#/definitions/_UndefinedUiHash"
        description: "factory constructor options; invalid options are silently ignored"
      records:
        type: "array"
        items:
          $ref: "#/definitions/UndefinedUiHash"
        description: "the list of new records; each hash in the list represents a new record and must have keys that correspond to valid field names, values are subjected to template resolution by calls to UserApi::expandTemplatedValue() with context as the local context"
      context:
        $ref: "#/definitions/_UndefinedHash"
        description: "any context data to be used to resolve the where argument"
