Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Actions45

Datastream → Update

AI-generated

Overview

This node interacts with the Workboard API to update datastream values. It allows users to modify existing datastream entries by specifying the datastream ID and providing additional fields to update. This is useful for workflows that need to programmatically adjust datastream data within the Workboard platform, such as updating metrics or statuses in real-time.

Use Case Examples

  1. Updating a datastream's values based on new input data from another system.
  2. Automating the modification of datastream attributes like tags or comments as part of a larger workflow.

Properties

Name Meaning
Stream ID The ID of the datastream to update, used to identify which datastream entry to modify.
Additional Fields A collection of optional fields that can be updated on the datastream, such as activity description, notes, text format, owner, workstream, team, due date, state, priority, rating, effort, tags, and comments.

Output

JSON

  • success - Indicates whether the update operation was successful.
  • ``
    • *
      * `` - Additional properties returned by the Workboard API representing the updated datastream object.

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure the provided Stream 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 datastreams.
  • 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.

Discussion