Steuerboard icon

Steuerboard

Consume the Steuerboard API

Actions31

Overview

The node integrates with the Steuerboard API to manage files within a client context. Specifically, the "File" resource's "Update" operation allows users to modify existing file metadata such as the file's name, associated labels, folder location, and linked task. This operation is useful in scenarios where file organization or metadata needs to be updated dynamically, for example, renaming a file after review, reassigning it to a different folder, or tagging it with new labels for categorization.

Practical examples:

  • Renaming a project document after final edits.
  • Moving a file to a different folder to reflect a change in project phase.
  • Adding or updating label tags to improve searchability.
  • Associating a file with a specific task to track its relevance.

Properties

Name Meaning
Client ID The unique identifier of the client owning the file.
File ID The unique identifier of the file to update.
Update Fields A collection of fields to update on the file. Possible fields include:
- Name: New name for the file.
- Label IDs: JSON array string of label IDs to assign to the file (e.g., ["id1","id2"]).
- Folder ID: Identifier of the folder to move the file into.
- Task ID: Identifier of the task to associate the file with.

Output

The node outputs JSON data representing the updated file object as returned by the Steuerboard API. This typically includes the updated metadata fields such as the file's new name, labels, folder association, and linked task information.

If the node supports binary data output (not indicated here), it would represent the actual file content or attachments; however, this operation focuses on metadata updates only.

Dependencies

  • Requires an active connection to the Steuerboard API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the API is set via credentials and used as the request base URL.
  • The node sends requests with Accept and Content-Type headers set to application/json.

Troubleshooting

  • Missing Required Fields: Ensure that both "Client ID" and "File ID" are provided; otherwise, the API will reject the request.
  • Invalid JSON in Label IDs: The "Label IDs" field expects a valid JSON array string. Malformed JSON will cause errors.
  • Permission Issues: The API token must have sufficient permissions to update files for the specified client.
  • API Endpoint Errors: Network issues or incorrect base URL configuration can cause connection failures.
  • Empty Update Fields: If no update fields are provided, the operation may result in no changes or an error depending on API behavior.

Links and References

Discussion