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, … The SDKs optionally allow you to immediately associate the created resource with one or more other resources in the same call.

Response format

For all resources, the full response schema (property names, types, and descriptions) is documented on each resource’s Create page. See the API Overview for the list of resources and links to their action-specific documentation.

Create general Signature

const response = await client.create(
  '<resource name>',
  {
    'attribute_name': '<attribute value>',
    'other_attribute_name': '<other attribute value>',
  },
  [
    {
      role: '<resource name to link>',
      id: '<resource id to link>'
    },
    {
      role: '<resource name to link>',
      id: '<resource id to link>'
    }
  ]
);

console.log('Create success!', response);

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:

Response format

For all resources, the full response schema (including entity fields in rows ) is documented on each resource’s Search/Get page. See the API Overview for the list of resources and links to their action-specific documentation.

Get general Signature

const response = await 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'
      ]
    ]
  }
);

console.log('Get success!', response);

Update

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

Response format

For all resources, the full response schema is documented on each resource’s Update page. See the API Overview for the list of resources and links to their action-specific documentation.

Update general Signature

const response = await client.update(
  '<resource name>',
  '<resource id>',
  {
    'attribute_name': '<attribute value>'
  }
);

console.log('Update success!', response);

Delete

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

Response format

For all resources, the full response schema is documented on each resource’s Delete page. See the API Overview for the list of resources and links to their action-specific documentation.

Delete general Signature

const response = await client.delete('<resource name>', '<resource id>');

console.log('Delete success!', response);

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 .

Response format

For all resources, the full response schema is documented on each resource’s Associate page. See the API Overview for the list of resources and links to their action-specific documentation.

Associate general Signature

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

console.log('Associate success!', response);

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 .

Response format

For all resources, the full response schema is documented on each resource’s Dissociate page. See the API Overview for the list of resources and links to their action-specific documentation.

Dissociate general Signature

const response = await client.dissociate(
  '<resource name>',
  '<resource id>',
  {
    role: '<resource name to unlink>',
    id: '<resource id to unlink>'
  }
);

console.log('Dissociate success!', response);