Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Workstream → Get Activities

AI-generated

Overview

This node interacts with the Workboard API to perform various operations on different resources such as users, goals, teams, metrics, activities, workstreams, tags, datastreams, and webhooks. Specifically, for the 'Workstream' resource with the 'Get Activities' operation, it retrieves all activities associated with a specified workstream by making a GET request to the Workboard API endpoint for workstream activities. This is useful for scenarios where you want to monitor or analyze the activities within a particular workstream, such as tracking progress or generating reports.

Use Case Examples

  1. Retrieve all activities for a specific workstream to monitor ongoing tasks and their statuses.
  2. Fetch activities to analyze team performance and workload within a workstream.

Properties

Name Meaning
Workstream ID The unique identifier of the workstream for which to retrieve activities. This is a required string input.

Output

JSON

  • ``
    • id - The unique identifier of each activity retrieved.
    • name - The name or title of each activity.
    • description - Detailed description of each activity.
    • status - Current status of each activity (e.g., open, in progress, completed).
    • due_date - Due date for each activity, if applicable.
    • owner - Owner or responsible person for each activity.
    • tags - Tags associated with each activity for categorization.

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure the Workstream ID provided is correct and exists in the Workboard system to avoid 404 errors.
  • Verify that the API credentials (JWT Bearer Token) are valid and have the necessary permissions to access workstream activities.
  • Check network connectivity and the base URL configuration if requests fail to reach the Workboard API.
  • Handle API rate limits or quota restrictions that might cause request failures.

Links

  • Workboard API Documentation - Official API documentation for Workboard, useful for understanding endpoints and request/response formats.

Discussion