Overview

This node interacts with the Workboard API to update a workstream. It allows users to modify various attributes of a workstream by specifying the workstream ID and providing additional fields to update. This is useful for managing workstreams dynamically within automation workflows, such as updating descriptions, owners, due dates, states, priorities, tags, and comments associated with a workstream.

Use Case Examples

1. Updating the description and due date of a specific workstream to reflect new project timelines.
2. Changing the owner or priority of a workstream to reassign responsibilities or adjust focus.
3. Adding tags or comments to a workstream to enhance collaboration and tracking.

Properties

Output

JSON

• success - Indicates whether the update operation was successful.
• ``
  • ``
    * workstreamProperties - The response includes the updated properties of the workstream as returned by the Workboard API.

Dependencies

• Workboard API with JWT Bearer Token authentication

Troubleshooting

• Ensure the Workstream ID is correct and exists in the Workboard system to avoid 'not found' errors.
• Verify that the JWT Bearer Token credential is valid and has the necessary permissions to update workstreams.
• Check the format of JSON fields like tags and comments to ensure they are valid JSON arrays.
• If the API returns an error, review the error message for details and adjust the input parameters accordingly.

Links

• Workboard API Documentation - Official API documentation for Workboard, useful for understanding available endpoints and data structures.