AtomicBI icon

AtomicBI

Interact with Atomic BI API
Join our community

Actions16

Overview

This node integrates with the Atomic BI API to interact with Playbooks data. Specifically, for the "Playbooks" resource and the "Update" operation, it allows users to update existing Playbooks by specifying which fields to select, filter criteria to identify the Playbooks to update, pagination options (offset and limit), and ordering preferences.

Common scenarios include:

  • Updating specific Playbooks based on complex filters.
  • Selecting only certain fields to update or retrieve.
  • Controlling the number of Playbooks affected and their order.

Practical example:

  • A user wants to update the "Instructions" and "Rules" fields of Playbooks created after a certain date, limiting the update to 10 Playbooks ordered by creation date descending.

Properties

Name Meaning
Select List of fields to select from Playbooks. If empty, all fields are selected. Options include Id, User Id, Space Id, Name, Instructions, Rules, Created At, Updated At, Mail, Chat, Browser, Linkedin, Objective, Bypass Agent.
Filter Filters to narrow down which Playbooks to include. Each filter consists of: Field (predefined or custom), Operator (Equals, Like, ILike, Contains), and Value. Multiple filters can be combined.
Offset Starting offset for the Playbooks to return or update. Useful for pagination.
Limit Maximum number of Playbooks to return or update. Maximum allowed is 1000.
Order By Field by which to order the returned Playbooks. Same field options as Select.
Order Direction Direction of ordering: Ascending or Descending.
Additional Select Advanced option to specify additional select fields as a comma-separated string.

Output

The node outputs JSON objects representing the Playbooks that were retrieved or updated. Each output item corresponds to one Playbook, containing the fields requested via the Select and Additional Select properties.

If the limit is set to 1, the output is a single JSON object wrapped in an array; otherwise, multiple Playbooks are output as an array of JSON objects.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • The base URL for the Atomic BI API must be configured in the credentials.
  • No other external dependencies are required.

Troubleshooting

  • Invalid operation error: If an unsupported operation is specified, the node throws Invalid operation: <resource>/<operation>. Ensure the operation is correctly set to supported values like "GET" or "PUT".
  • API authentication errors: If the API key or base URL is incorrect or missing, requests will fail. Verify credentials are properly configured.
  • Filter syntax issues: Incorrect filter field names or operators may cause the API to reject the request. Use only supported fields and operators.
  • Limit and offset misuse: Setting limit too high or offset beyond available data may result in empty responses.
  • Empty select fields: Leaving the Select property empty selects all fields, but specifying invalid field names may cause errors.

Links and References

Discussion