Actions

The core API defines actions that can be called on the resources. The api call of a specific action is standardized which means that you access each resource in a similar way. In total, 6 types of actions are defined:

Not every action is supported on every resource (e.g. you can not delete a Dataprovider). The rest of this documentation will provide information on the call signature for each action and will then go into details with concrete examples for each combination of resource and action.

Create

Create a new instance of the requested resource type, for example: create a new User within an Organization, create a new access group, create new data rows, …

Create general Signature

client.create(
  '<resource name>',
  {
    'attribute name': '<attribute value>'
  },
  [
    {
      role: '<resource to link name>',
      id: '<resource entity id>'
    },
    {
      role: '<resource to link name>',
      id: '<resource entity id>'
    }
  ]
)
.then(function(<resource name>) {
  console.log('Success!', <resource name>);
});

Update

Update the properties of a single specific entity, eg. update a column name or user password.

Update general Signature

client.update(
  '<resource name>',
  '<your <resource name> id>',
  {
    'attribute name': '<attribute value>'
  }
)
.then(function(data) {
  console.log('Success!', data);
});

Delete

Delete a resource, eg. delete a dataset or group.

Delete general Signature

const promise = client.delete('<resource name>', '<your <resource name> id>');

Get and List

Get and List are the same call. The reason why we differentiate between a Get and a List action is that different security rules apply. A user who can get a resource can't necessarily list the same resource. Get and List have a different structure than the other calls since it allows for complex queries. A call is considered to be a get action if you fetch an entity using a specific id in the where clause, else it is considered to be a list action. The query syntax is very close to SQL, it consists of the following attributes:

Get general Signature

client.get(
  '<resource name>',
  {
    where: {
      'attribute name': '<attribute value>'
    },
    include: [
      {
        model: '<resource name>'
      }
    ],
    attributes: [
      '<attribute name>',
      '<attribute name>'
    ],
    order: [
      [
        '<attribute name>',
        'asc'
      ],
      [
        {
          model: '<resource name>'
        },
        '<attribute name>',
        'asc'
      ]
    ]
  }
)
.then(function(data) {
  console.log('Success!', data);
});

Associate

Associate two entities to each other, eg. link a Column to a Dataset. Associations can be set in both directions. Many associations are automatically set on creation as well, for example a dashboard is automatically associated with the user that created the dashboard. To know which resources can be associated please refer to the schema at the beginning of this chapter Schema .

Associate general Signature

const promise = client.associate(
  '<resource name>',
  '<your <resource name> id>',
  {
    role: '<resource to link name>',
    id: '<resource entity id>'
  },
  {
    'property name': '<property value>'
  }
);

Dissociate

Remove an association between 2 entities. To know which resources can be disassociated please refer to the schema at the beginning of this chapter Schema .

Dissociate general Signature

const promise = client.dissociate(
  '<resource name>',
  '<your <resource name> id>',
  {
    role: '<resource to link name>',
    id: '<resource entity id>'
  }
);