Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Activity → Update

AI-generated

Overview

This node interacts with the Workboard API to update an existing activity. It allows users to modify various details of an activity such as description, notes, owner, workstream, team, due date, state, priority, rating, effort, tags, and comments. This is useful for keeping activity records current and accurate within the Workboard platform, supporting project management and team collaboration workflows.

Use Case Examples

  1. Updating the description and due date of a specific activity to reflect new project requirements.
  2. Changing the state of an activity to 'completed' after finishing the task.
  3. Adding tags and comments to an activity to provide additional context and categorization.

Properties

Name Meaning
Activity ID The unique identifier of the activity to update, required to specify which activity to modify.
Additional Fields A collection of optional fields to update on the activity, including description, note, text format, owner, workstream, team, due date, state, priority, rating, effort, tags, and comments.

Output

JSON

  • success - Indicates if the update operation was successful.
  • ai_description - Updated description of the activity.
  • ai_note - Updated notes for the activity.
  • ai_owner - Updated owner of the activity.
  • ai_workstream - Updated workstream associated with the activity.
  • ai_team - Updated team associated with the activity.
  • ai_due_date - Updated due date of the activity.
  • ai_state - Updated state of the activity.
  • ai_priority - Updated priority of the activity.
  • ai_rating - Updated rating of the activity.
  • ai_effort - Updated effort estimation of the activity.
  • ai_tags - Updated tags array for the activity.
  • ai_comments - Updated comments array for the activity.

Dependencies

  • Workboard API

Troubleshooting

  • Ensure the Activity ID is correct and exists in the Workboard system to avoid 'not found' errors.
  • Verify that the API authentication token (bearer token) is valid and has the necessary permissions to update activities.
  • Check the format of JSON fields like tags and comments to ensure they are valid JSON arrays.
  • If the update fails, review the error message returned by the API for specific details and adjust the input accordingly.

Links

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

Discussion