Bookla icon

Bookla

Get data from Bookla's API
Join our community

Actions12

Overview

This node integrates with the Bookla API to manage resources within a company. Specifically, the Resource - Update operation allows users to update details of an existing resource such as its name, color, and metadata. This is useful in scenarios where resource information changes over time and needs to be kept current in the Bookla system.

Practical examples include:

  • Renaming a resource after rebranding or restructuring.
  • Changing the color code associated with a resource for better visual identification.
  • Updating metadata fields to reflect new attributes or configurations related to the resource.

Properties

Name Meaning
Server Select which Bookla server to connect to: US Server, EU Server
Company ID The unique identifier of the company owning the resource (required)
Resource ID The unique identifier of the resource to update (required)
Name New name for the resource (optional)
Color New color value for the resource, represented as a color code (optional)
Meta Data Object to update metadata fields with the following sub-properties:
   Expected Version Number indicating the expected version of the metadata for concurrency control (default 0)
   Path String path specifying the location within the metadata object to update
   Value JSON value to set at the specified path in the metadata

Output

The node outputs the JSON response from the Bookla API corresponding to the updated resource object. This typically includes the updated resource details such as its ID, name, color, metadata, and other relevant properties as returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Bookla API.
  • The node dynamically constructs the base URL based on the selected server (us or eu).
  • Proper configuration of the "Company ID" and "Resource ID" is necessary to target the correct resource.

Troubleshooting

  • Invalid Company ID or Resource ID: If these identifiers are incorrect or missing, the API will return errors indicating that the resource was not found. Verify these IDs before running the node.
  • Metadata JSON Parsing Errors: The metadata value field accepts JSON input. Invalid JSON syntax will cause parsing errors. Ensure the JSON is well-formed.
  • Version Conflicts: The expectedVersion property helps prevent concurrent update conflicts. If the version does not match the current metadata version on the server, the update may fail. Make sure to use the correct version number.
  • Authentication Failures: Missing or invalid API credentials will result in authentication errors. Confirm that the API key credential is correctly configured in n8n.
  • Server Selection: Selecting the wrong server (US vs EU) can lead to connection issues or unexpected data. Choose the server matching your Bookla account region.

Links and References

Discussion