Connectors Reference

Robolytix

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.

 

Status: Preview

Tier: Premium

Version: 1.0.1

 

Actions:

Name

Summary

Account ()

Account details

Listprocesses ()

List processes

Listtypes ()

List types

Sonar ([internal]string Content-Type, Message body)

Sonar

Ping ()

Ping

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AccountResponse

 

ListtypesResponse

 

Message

 

PingResponse

 

Process

 

SonarResponse

 

Type

 

 

Actions:

Account

Summary: Account details

Description: The Account resource is used for validating account credentials.

 

Syntax:

Robolytix.Account ()

 

Returns:

          Type:AccountResponse

 

Listprocesses

Summary: List processes

Description: Get list of processes associated with current account.

 

Syntax:

Robolytix.Listprocesses ()

 

Returns:

          Type:array of (Process)

 

Listtypes

Summary: List types

Description: Get list of Sonar types.

 

Syntax:

Robolytix.Listtypes ()

 

Returns:

          Type:ListtypesResponse

 

Sonar

Summary: Sonar

Description: Monitors and views this process in Robolytix.

 

Syntax:

Robolytix.Sonar ([internal]string Content-Type, Message body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

Content-Type

True

body

Message

 

Sonar message

True

 

Returns:

          Type:SonarResponse

 

Ping

Summary: Ping

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.

 

Syntax:

Robolytix.Ping ()

 

Returns:

          Type:PingResponse

 


 

AccountResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

Name of current account.


 

ListtypesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

types

array of (Type)

 

types


 

Message

Summary:

Description: Sonar message

 

          Properties:

Name

Type

Summary

name

string

 

Name of the current sonar should be unique in the whole process.

processid

string

 

List of processes in the selected account. For creating a new process go to [Robolytix settings](https://app.robolytix.com/en/admin/).

runid

string

 

Unique identification of one process run. Such as timestamp of first action or return value 'Run identification' from start Sonar.

service

string

 

service

sonarid

string

 

sonarid

type

string

 

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.


 

PingResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Process

Summary:

Description: Process representation

 

          Properties:

Name

Type

Summary

description

string

 

description

guid

string

 

guid

name

string

 

name


 

SonarResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

runid

string

 

Unique identification of one process run.

 


 

Type

Summary:

Description: Type of Sonar

 

          Properties:

Name

Type

Summary

description

string

 

description

name

string

 

name