Manual

The following methods will be further elaborated:

  • Get data
  • Import data
  • Using the Relatics API

Installation

Install via pip:

pip install pyrelatics

Prime connection

In order to prime a connection to the Relatics DB. First instantiate the relatics api class.

class pyrelatics.RelaticsAPI(company_name, environment_id, workspace_id)

This class simulates the Relatics API

Parameters:
  • company_name (str) – Name of the company
  • environment_id (str) – Environment ID
  • workspace_id (str) – Workspace ID
 
from pyrelatics import RelaticsAPI

# Create a RelaticeAPI instance (prime connection)
relaticsapi = RelaticsAPI('company_name','environment_id', 'workspace_id')

Get data

The following method can be used to read data from Relatics

RelaticsAPI.GetResult(operation_name, entry_code, parameters='None', retxml=False)

Retrieving data from Relatics

Parameters:
  • operation_name (str) – The operation name of the webservice
  • entry_code (str) – The entry-code of the webservice
  • parameters (tuple) – Provide a list of tuples if there are more parameters
  • retxml (bool) – If True return xml, otherwise return Object, default: False
Return type:

object
Returns:

Object

 
from pyrelatics import RelaticsAPI

# Create a RelaticeAPI instance (prime connection)
relaticsapi = RelaticsAPI('company_name','environment_id', 'workspace_id')

# Prepare (optional) parameters
parameters=('dummy_parameter_name','dummy_parameter_value')

# Get data (if there are no parameters don't pass it to the function)
relaticsapi.GetResult('dummy_operation_name', 'dummy_entry_code', parameters=parameters)

Import data

The following method can be used to import data to Relatics

RelaticsAPI.Import(operation_name, entry_code, data, retxml=False)

Import data into Relatics

Parameters:
  • operation_name (str) – The operation name of the webservice
  • entry_code (str) – The entry-code of the webservice
  • data (dict) – Dictionary of imported data
  • retxml (bool) – If True return xml, otherwise return Object, default: False
Return type:

object
Returns:

Object

 
from pyrelatics import RelaticsAPI

# Create a RelaticeAPI instance (prime connection)
relaticsapi = RelaticsAPI('company_name','environment_id', 'workspace_id')

# Prepare data
data= [{'name': 'test', 'description':'descrtest'},{'name': 'test2', 'description':'descrtest2'}]

# Import data
relaticsapi.Import('dummy_operation_name', 'dummy_entry_code', data=data)

Relatics API Operations

The following example shows how one can use an arbitrarily method from the relaticsapi:

from pyrelatics import RelaticsAPI

# Create a RelaticeAPI instance (prime connection)
relaticsapi = RelaticsAPI('company_name', 'environment_id', 'workspace_id')

# Login to your environment
relaticsapi.login('username', 'password')

# Create element and update it's name
cor_element = 'dummy_element_ID'
result = relaticsapi.CreateInstanceElement(cor_element).Element.ID
relaticsapi.UpdateInstanceElement((result,'name', 'nameOfResult'))

R1=result
R2='dummy_R2'
Relation ='dummy_relation'
relaticsapi.CreateInstanceRelation((R1, R2, Relation))