@datafire/cenit

Client library for Cenit IO - REST API Specification

Installation and Usage

npm install --save @datafire/cenit

let cenit = require('@datafire/cenit').create({
  "X-User-Access-Key": "",
  "X-User-Access-Token": ""
});

.then(data => {
  console.log(data);
});

Description

Cenit IO is an Open Platform for Data and Business Integration (iPaaS)

Actions

setup.connection.get

Returns a list of connections you've previously created. The connections are returned in sorted order, with the most recent connection appearing first.

cenit.setup.connection.get(null, context)

Input

This action has no parameters

Output

output array
- items connection

setup.connection.post

Creates or updates the specified connection by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

cenit.setup.connection.post(null, context)

Input

This action has no parameters

Output

output connection

setup.connection.id.delete

Permanently deletes a connection. It cannot be undone.

cenit.setup.connection.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Connection ID

Output

Output schema unknown

setup.connection.id.get

Retrieves the details of an existing connection. You need only supply the unique connection identifier that was returned upon connection creation.

cenit.setup.connection.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Connection ID

Output

output connection

setup.connection_role.get

Returns a list of connection roles you've previously created. The connection roles are returned in sorted order, with the most recent connection role appearing first.

cenit.setup.connection_role.get(null, context)

Input

This action has no parameters

Output

output array
- items connection_role

setup.connection_role.post

Creates or updates the specified connection role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

cenit.setup.connection_role.post(null, context)

Input

This action has no parameters

Output

output connection_role

setup.connection_role.id.delete

Deletes the specified connection role.

cenit.setup.connection_role.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Connection role ID

Output

Output schema unknown

setup.connection_role.id.get

Returns a connection role

cenit.setup.connection_role.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Connection role ID

Output

output connection_role

setup.data_type.get

Returns a list of data types you've previously created. The data types are returned in sorted order, with the most recent DataType appearing first.

cenit.setup.data_type.get(null, context)

Input

This action has no parameters

Output

output array
- items data_type

setup.data_type.post

Creates or updates the specified data type by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

cenit.setup.data_type.post(null, context)

Input

This action has no parameters

Output

output data_type

setup.data_type.id.delete

Deletes the specified data type.

cenit.setup.data_type.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: data type ID

Output

Output schema unknown

setup.data_type.id.get

Retrieves the details of an existing data type. You need only supply the unique data type identifier that was returned upon DataType creation.

cenit.setup.data_type.id.get({
  "id": ""
}, context)

Input

input object
- id required string: data type ID

Output

output data_type

setup.flow.get

Returns a list of flows you've previously created. The flows are returned in sorted order, with the most recent flow appearing first.

cenit.setup.flow.get(null, context)

Input

This action has no parameters

Output

output array
- items flow

setup.flow.post

Creates or updates the specified flow. Any parameters not provided will be left unchanged.

cenit.setup.flow.post(null, context)

Input

This action has no parameters

Output

output flow

setup.flow.id.delete

Deletes the specified flow.

cenit.setup.flow.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Flow ID

Output

Output schema unknown

setup.flow.id.get

Retrieves the details of an existing flow. You need only supply the unique flow identifier that was returned upon flow creation.

cenit.setup.flow.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Flow ID

Output

output flow

setup.namespace.get

Returns a list of namespaces you've previously created. The namespaces are returned in sorted order, with the most recent namespace appearing first.

cenit.setup.namespace.get(null, context)

Input

This action has no parameters

Output

output array
- items namespace

setup.namespace.post

Creates or updates the specified namespace. Any parameters not provided will be left unchanged.

cenit.setup.namespace.post(null, context)

Input

This action has no parameters

Output

output namespace

setup.namespace.id.delete

Deletes the specified namespace.

cenit.setup.namespace.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Namespace ID.

Output

Output schema unknown

setup.namespace.id.get

Retrieves the details of an existing namespace. You need only supply the unique webhook namespace that was returned upon namespace creation.

cenit.setup.namespace.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Namespace ID.

Output

output namespace

setup.observer.get

Returns a list of events you've previously created. The events are returned in sorted order, with the most recent event appearing first.

cenit.setup.observer.get(null, context)

Input

This action has no parameters

Output

output array
- items observer

setup.observer.post

Creates or updates the specified event observer. Any parameters not provided will be left unchanged.

cenit.setup.observer.post(null, context)

Input

This action has no parameters

Output

output observer

setup.observer.id.delete

Deletes the specified event observer.

cenit.setup.observer.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Observer ID

Output

Output schema unknown

setup.observer.id.get

Retrieves the details of an existing event. You need only supply the unique event identifier that was returned upon event creation.

cenit.setup.observer.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Observer ID

Output

output observer

setup.scheduler.get

Returns a list of schedulers you've previously created. The schedulers are returned in sorted order, with the most recent scheduler appearing first.

cenit.setup.scheduler.get(null, context)

Input

This action has no parameters

Output

output array
- items scheduler

setup.scheduler.post

Creates or updates the specified scheduler. Any parameters not provided will be left unchanged.

cenit.setup.scheduler.post(null, context)

Input

This action has no parameters

Output

output scheduler

setup.scheduler.id.delete

Deletes the specified scheduler.

cenit.setup.scheduler.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Scheduler ID

Output

Output schema unknown

setup.scheduler.id.get

Retrieves the details of an existing scheduler. You need only supply the unique scheduler identifier that was returned upon scheduler creation.

cenit.setup.scheduler.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Scheduler ID

Output

output scheduler

setup.schema.get

Returns a list of schemas you've previously created. The schemas are returned in sorted order, with the most recent schema appearing first.

cenit.setup.schema.get(null, context)

Input

This action has no parameters

Output

output array
- items schema

setup.schema.post

Creates or updates the specified schema. Any parameters not provided will be left unchanged.

cenit.setup.schema.post(null, context)

Input

This action has no parameters

Output

output schema

setup.schema.id.delete

Deletes the specified schema.

cenit.setup.schema.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Schema ID

Output

Output schema unknown

setup.schema.id.get

Retrieves the details of an existing schema. You need only supply the unique schema identifier that was returned upon schema creation.

cenit.setup.schema.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Schema ID

Output

output schema

setup.translator.get

Returns a list of translators you've previously created. The translators are returned in sorted order, with the most recent translator appearing first.

cenit.setup.translator.get(null, context)

Input

This action has no parameters

Output

output array
- items translator

setup.translator.post

Creates or updates the specified translator. Any parameters not provided will be left unchanged.

cenit.setup.translator.post(null, context)

Input

This action has no parameters

Output

output translator

setup.translator.id.delete

Deletes the specified translator.

cenit.setup.translator.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Translator ID.

Output

Output schema unknown

setup.translator.id.get

Retrieves the details of an existing translator. You need only supply the unique translator identifier that was returned upon translator creation.

cenit.setup.translator.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Translator ID.

Output

output translator

setup.webhook.get

Returns a list of webhooks you've previously created. The webhooks are returned in sorted order, with the most recent webhook appearing first.

cenit.setup.webhook.get(null, context)

Input

This action has no parameters

Output

output array
- items webhook

setup.webhook.post

Creates or updates the specified webhook. Any parameters not provided will be left unchanged.

cenit.setup.webhook.post(null, context)

Input

This action has no parameters

Output

output webhook

setup.webhook.id.delete

Deletes the specified webhook.

cenit.setup.webhook.id.delete({
  "id": ""
}, context)

Input

input object
- id required string: Webhook ID.

Output

Output schema unknown

setup.webhook.id.get

Retrieves the details of an existing webhook. You need only supply the unique webhook identifier that was returned upon webhook creation.

cenit.setup.webhook.id.get({
  "id": ""
}, context)

Input

input object
- id required string: Webhook ID.

Output

output webhook

Definitions

connection

connection object
- headers array
  - items object
    - key string
    - value string
- id string
- key string
- name string
- namespace namespace
- parameters array
  - items object
    - key string
    - value string
- token string
- url string

connection_role

connection_role object
- connection array
  - items connection
- id string
- name string
- namespace namespace
- webhook array
  - items webhook

data_type

data_type object
- id string
- model_schema string
- name string
- namespace namespace
- show_navigation_link string
- slug string
- title string
- type object

flow

flow object
- active boolean
- connection_role connection_role
- custom_data_type data_type
- event object
- id string
- name string
- namespace namespace
- notify_request boolean
- notify_response boolean
- response_translator translator
- translator translator
- webhook webhook

namespace

namespace object
- id string
- name string
- slug string

observer

observer object
- data_type data_type
- id string
- name string
- namespace namespace
- triggers string
- type object

scheduler

scheduler object
- activated boolean
- expression string
- id string
- name string
- namespace namespace

schema

schema object
- id string
- namespace namespace
- schema string
- uri string

translator

translator object
- custom_data_type data_type
- id string
- name string
- namespace namespace
- source_data_type data_type
- style string (values: Ruby, Liquid, xslt)
- target_data_type data_type
- transformation string
- type string (values: Import, Export, Convert, Update)

webhook

webhook object
- headers array
  - items object
    - key string
    - value string
- id string
- name string
- namespace namespace
- parameters array
  - items object
    - key string
    - value string
- path string