kappa_sdk.Connection#

class kappa_sdk.Connection(server_address, proxies=None, headers={}, verify_ssl=True, client_id=None, client_secret=None)[source]#

Connection to the KAPPA Automate instance.

Use this class to establish a connection to the KAPPA Automate instance.

Parameters:

  • server_address (str) – URL of the KAPPA Automate instance. This is the same URL that you use to access the web interface of your KAPPA Automate instance.

  • verify_ssl (bool) – Set this to False if you need to disable SSL certificate verification (True by default).

  • proxies (Dict[Any, Any] | None)

  • headers (Dict[str, str])

  • client_id (str | None)

  • client_secret (str | None)

Attributes

Connection.data_types_catalog

Get the Global Data Types catalog object of the Field.

Connection.event_bus

Gets the event bus.

Connection.rest_api

Gets the REST API gateway.

Connection.unit_converter

Gets the unit converter API results.

Connection.well_properties_catalog

Get the Global Well Properties catalog object of the Field.

Methods

Connection.create_field(name, country, ...)

Creates a new field with the specified parameters.

Connection.get_field_by_id(field_id)

Gets a field by id.

Connection.get_fields()

Lists all fields.

Connection.migrate_user_tasks(...)

Migrate user task items using a definition to another user task definition.

Connection.run_kw_script(field_id, well_id, ...)

Runs a KW script.
On this page