Associate Dataset

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/securable

API call form

Examples

List of examples

Share dataset with user with modify rights.
Share dataset with user with filters applied
Share dataset with group
Add dataset to Collection
Add (static) embedFilter to dataset
Add (parameter) embedFilter to dataset

Description

Add an embedFilter to a dataset which is based on a parameter.

Add a parameter filter by specifying the dataset id, column id, expression, parameter name and default value.

expression : Filter expression to apply. Possible values are:
- For numeric columns: ? is null , ? is not null , ? in ? , ? not in ? , ? = ? , ? != ? , ? < ? , ? <= ? , ? > ? , ? >= ?
- For hierarchy columns: ? is null , ? is not null , ? in ? , ? not in ? , ? = ? , ? != ? , ? like ? , ? not like ? , ? starts with ? , ? not starts with ? , ? ends with ? , ? not ends with ?
- For datetime columns: ? is null , ? is not null , ? < ? , ? <= ? , ? > ? , ? >= ? , last_now , last_available , next_now , last_completed , to_date , next_full
value : Value(s) to compare. This field should be omitted for ? is null and ? is not null expressions.
- Value should be an (array of string), numeric or datetime (in RFC 3339 format, like 2018-05-05T12:23:45.000Z ) values, depending on the type of the column.
- For last_now , last_available , next_now , last_completed , to_date , next_full expressions the value should be an object with the unit (year, quarter, month, ...) and quantity (number of units).

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});

const response = await client.associate('securable',
  '<your dataset id>',
  { role: 'EmbedFilterGroups', id: '<the embed filter group id>' },
  {
    filters: [
      {
        clause: "where",
        origin: "global",
        securable_id: "< dataset id >",
        column_id: "< column id of a column used in the dataset >",
        expression: "? in ?",
        value: {
          parameter: "metadata.< parameter_name >",
          type: "array[numeric]"
        }
      }
    ]
  }
);