Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Actions45

Metric → Update

AI-generated

Overview

This node interacts with the Workboard API to update a metric resource. It allows users to modify various fields of a specific metric by providing the metric ID and additional fields to update. This is useful for managing and maintaining metric data within the Workboard platform, such as updating descriptions, notes, ownership, state, priority, tags, and comments associated with a metric.

Use Case Examples

  1. Updating the description and priority of a metric identified by its Metric ID.
  2. Changing the owner and due date of a metric to reflect new responsibilities and deadlines.

Properties

Name Meaning
Metric ID The unique identifier of the metric to be updated, required to specify which metric to modify.
Additional Fields A collection of optional fields that can be updated for the metric, including description, note, text format, owner, workstream, team, due date, state, priority, rating, effort, tags, and comments.

Output

JSON

  • success - Indicates whether the update operation was successful.
  • metricId - The ID of the metric that was updated.
  • updatedFields - The fields that were updated in the metric with their new values.

Dependencies

  • Requires an API key credential for Workboard API authentication (bearer token).

Troubleshooting

  • Ensure the Metric ID provided is correct and exists in the Workboard system to avoid 'not found' errors.
  • Verify that the API key credential is valid and has the necessary permissions to update metrics.
  • Check the format of JSON fields like tags and comments to ensure they are correctly structured arrays.
  • If the node fails, enable 'Continue On Fail' to handle errors gracefully and inspect error messages for troubleshooting.

Links

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

Discussion