AtomicBI icon

AtomicBI

Interact with Atomic BI API
Join our community

Actions16

Overview

This node integrates with the Atomic BI API to perform operations on various resources, including Users. Specifically for the Users - Update operation, it allows updating user data by specifying filters and selecting which fields to update or retrieve. This is useful in scenarios where you need to programmatically modify user information in Atomic BI, such as changing roles, updating emails, or managing API keys.

Practical examples include:

  • Updating a user's role based on their username.
  • Modifying multiple users' details filtered by creation date.
  • Selectively retrieving updated user fields after modification.

Properties

Name Meaning
Select List of user fields to select (e.g., Id, Username, Name, Created At, Updated At, Email, Role, Api Key). Leave empty to select all fields.
Filter Filters to apply when selecting users to update. Each filter includes: Field (predefined or custom), Operator (Equals, Like, ILike, Contains), and Value.
Offset Starting offset for the list of users to return (pagination).
Limit Maximum number of users to return (up to 1000).
Order By Field by which to order the returned users (e.g., Id, Username, Name, etc.).
Order Direction Direction of ordering: Ascending or Descending.
Additional Select Advanced option to specify additional select fields as comma-separated values.

Output

The node outputs JSON objects representing user records retrieved or updated via the Atomic BI API. Each output item corresponds to a user object containing the selected fields.

If the limit is set to 1, the output is a single-item array with one JSON object; otherwise, it returns an array of JSON objects for each user.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • The node uses the Atomic BI API client internally to perform requests.
  • No other external dependencies are required.

Troubleshooting

  • Invalid operation error: If an unsupported operation or resource is specified, the node throws an error like Invalid operation: users/UPDATE. Ensure the operation and resource names are correct.
  • API authentication errors: If the API key is missing or invalid, requests will fail. Verify that the API key credential is correctly configured.
  • Filter syntax issues: Incorrect filter field names or operators may cause the API to reject requests. Use only supported fields and operators.
  • Limit and offset misuse: Setting very high limits or incorrect offsets might lead to unexpected results or performance issues.

Links and References

Discussion