Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Activity → Get

AI-generated

Overview

This node interacts with the Workboard API to perform various operations on different resources such as Activity, User, Goal, Team, Metric, Workstream, Tag, Datastream, and Webhook. Specifically, for the Activity resource with the Get operation, it retrieves a specific activity by its ID. This is useful for workflows that need to fetch detailed information about a particular activity within the Workboard system, such as tracking progress or displaying activity details.

Use Case Examples

  1. Retrieve details of a specific activity by providing its Activity ID to monitor its status or update related workflows.
  2. Fetch an activity's information to integrate with other project management or reporting tools.

Properties

Name Meaning
Activity ID The unique identifier of the activity to retrieve. This is a required string input for the Get operation on the Activity resource.

Output

JSON

  • id - The unique identifier of the activity.
  • ai_description - The description of the activity, potentially formatted in HTML, Markdown, or plain text.
  • ai_note - Additional notes related to the activity.
  • ai_owner - The owner or responsible person for the activity.
  • ai_workstream - The workstream associated with the activity.
  • ai_team - The team associated with the activity.
  • ai_due_date - The due date of the activity.
  • ai_state - The current state of the activity (e.g., open, in progress, completed).
  • ai_priority - The priority level of the activity (e.g., low, medium, high).
  • ai_rating - A rating or score associated with the activity.
  • ai_effort - The effort estimate or measure for the activity.
  • ai_tags - An array of tags associated with the activity.
  • ai_comments - An array of comments related to the activity.

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure the Activity ID is correctly provided and exists in the Workboard system to avoid 'not found' errors.
  • Verify that the Workboard API credentials (JWT Bearer Token) are valid and have the necessary permissions to access activity data.
  • Check network connectivity and the base URL configuration if the API requests fail.
  • Handle API rate limits or quota restrictions imposed by the Workboard API.

Links

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

Discussion