PowerPlatformConnectors/certified-connectors/Robolytix/apiDefinition.swagger.json

{
  "basePath": "/v1",
  "consumes": [],
  "definitions": {
    "Message": {
      "default": {
        "name": "",
        "processid": "PROCESS_ID",
        "runid": "",
        "service": "Microsoft Power Automate",
        "sonarid": "",
        "type": "common"
      },
      "description": "Sonar message",
      "properties": {
        "name": {
          "description": "Name of the current sonar should be unique in the whole process.",
          "title": "Name",
          "type": "string",
          "x-ms-visibility": "important"
        },
        "processid": {
          "description": "List of processes in the selected account. For creating a new process go to [Robolytix settings](https://app.robolytix.com/en/admin/).",
          "title": "Process",
          "type": "string",
          "x-ms-dynamic-values": {
            "operationId": "Listprocesses",
            "value-path": "guid",
            "value-title": "name"
          },
          "x-ms-visibility": "important"
        },
        "runid": {
          "description": "Unique identification of one process run. Such as timestamp of first action or return value 'Run identification' from start Sonar.",
          "title": "Run identification",
          "type": "string",
          "x-ms-visibility": "important"
        },
        "service": {
          "description": "service",
          "title": "",
          "type": "string",
          "x-ms-visibility": "internal"
        },
        "sonarid": {
          "description": "sonarid",
          "title": "",
          "type": "string",
          "x-ms-visibility": "internal"
        },
        "type": {
          "description": "Every process should start at sonars type Start and end at sonars type End. The number of Continuous sonars is unlimited. Use Error sonars for handling errors.",
          "title": "Type",
          "type": "string",
          "x-ms-dynamic-values": {
            "operationId": "Listtypes",
            "value-collection": "types",
            "value-path": "name",
            "value-title": "description"
          },
          "x-ms-visibility": "important"
        }
      },
      "required": [
        "name",
        "type",
        "processid"
      ],
      "type": "object"
    },
    "Process": {
      "description": "Process representation",
      "properties": {
        "description": {
          "description": "description",
          "type": "string"
        },
        "guid": {
          "description": "guid",
          "type": "string"
        },
        "name": {
          "description": "name",
          "type": "string"
        }
      },
      "type": "object"
    },
    "Type": {
      "description": "Type of Sonar",
      "properties": {
        "description": {
          "description": "description",
          "title": "Description",
          "type": "string"
        },
        "name": {
          "description": "name",
          "title": "Name",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "externalDocs": {
    "description": "Find out more about Robolytix and process monitoring",
    "url": "http://robolytix.com"
  },
  "host": "api.robolytix.com",
  "info": {
    "contact": {
      "name": "Support Forum",
      "url": "http://support.robolytix.com/"
    },
    "description": "Robolytix is the key online analytic and monitoring tool for Robotic Process Automation using Sonar technology to evaluate, audit, monitor and improve performance of robots operating in any application, RPA platform or custom solution. Manage your RPA projects effectively with exact KPIs. Visualise your whole process at one place.",
    "termsOfService": "http://www.robolytix.com/terms-of-service/",
    "title": "Robolytix",
    "version": "1.0.1",
    "x-ms-api-annotation": {
      "status": "Preview"
    }
  },
  "parameters": {},
  "paths": {
    "/account": {
      "get": {
        "description": "The Account resource is used for validating account credentials.",
        "operationId": "Account",
        "parameters": [],
        "responses": {
          "default": {
            "description": "default",
            "schema": {
              "properties": {
                "name": {
                  "description": "Name of current account.",
                  "title": "Account name",
                  "type": "string"
                }
              },
              "type": "object"
            }
          }
        },
        "summary": "Account details",
        "tags": [
          "common"
        ],
        "x-ms-visibility": "internal"
      }
    },
    "/listprocesses": {
      "get": {
        "description": "Get list of processes associated with current account.",
        "operationId": "Listprocesses",
        "parameters": [],
        "responses": {
          "default": {
            "description": "default",
            "schema": {
              "items": {
                "$ref": "#/definitions/Process"
              },
              "type": "array"
            }
          }
        },
        "summary": "List processes",
        "x-ms-visibility": "internal"
      }
    },
    "/listtypes": {
      "get": {
        "description": "Get list of Sonar types.",
        "operationId": "Listtypes",
        "parameters": [],
        "responses": {
          "default": {
            "description": "List of Sonar types.",
            "schema": {
              "properties": {
                "types": {
                  "description": "types",
                  "items": {
                    "$ref": "#/definitions/Type"
                  },
                  "type": "array"
                }
              },
              "type": "object"
            }
          }
        },
        "summary": "List types",
        "x-ms-visibility": "internal"
      }
    },
    "/messages": {
      "post": {
        "description": "Monitors and views this process in Robolytix.",
        "operationId": "Sonar",
        "parameters": [
          {
            "default": "application/json",
            "description": "Content-Type",
            "in": "header",
            "name": "Content-Type",
            "required": true,
            "type": "string",
            "x-ms-visibility": "internal"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Message"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "Response about the processing of the message with run identification.",
            "schema": {
              "properties": {
                "data": {
                  "description": "data",
                  "properties": {
                    "runid": {
                      "description": "Unique identification of one process run.",
                      "title": "Run identification",
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            }
          }
        },
        "summary": "Sonar",
        "x-ms-visibility": "important"
      }
    },
    "/ping": {
      "get": {
        "description": "The Ping resource is used to check the status of the Robolytix API. No credentials are required for this resource to validate the API.",
        "operationId": "Ping",
        "parameters": [],
        "responses": {
          "default": {
            "description": "default",
            "schema": {}
          }
        },
        "summary": "Ping",
        "tags": [
          "common"
        ],
        "x-ms-visibility": "internal"
      }
    }
  },
  "produces": [
    "application/json"
  ],
  "responses": {},
  "schemes": [
    "https"
  ],
  "security": [
    {
      "api_key": []
    }
  ],
  "securityDefinitions": {
    "api_key": {
      "in": "header",
      "name": "Authorization",
      "type": "apiKey",
      "description": "API key issued by Robolytix.com."
    }
  },
  "swagger": "2.0",
  "tags": []
}