Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Actions45

Activity → Get All

AI-generated

Overview

This node interacts with the Workboard API to perform various operations on different resources. Specifically, for the Activity resource with the Get All operation, it retrieves a list of activities from the Workboard platform. This is useful for scenarios where users want to fetch multiple activity records, possibly with filters, sorting, and pagination. For example, a user might want to get all activities assigned to a team or user, sorted by due date, and limited to a certain number of results.

Use Case Examples

  1. Fetching all activities with a limit of 50 and sorted by creation date ascending.
  2. Retrieving activities with a filter to only show those in progress.

Properties

Name Meaning
Query Parameters Parameters to control the retrieval of activities, including pagination, sorting, and filtering.

Output

JSON

  • id - Unique identifier of the activity
  • ai_description - Description of the activity, formatted according to the specified text format
  • ai_note - Additional notes for the activity
  • ai_owner - Owner of the activity
  • ai_workstream - Workstream associated with the activity
  • ai_team - Team associated with the activity
  • ai_due_date - Due date of the activity
  • ai_state - Current state of the activity (e.g., open, in progress, completed)
  • ai_priority - Priority level of the activity (e.g., low, medium, high)
  • ai_rating - Rating of the activity
  • ai_effort - Effort estimation for the activity
  • ai_tags - Array of tags associated with the activity
  • ai_comments - Array of comments related to the activity

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure the Workboard API credentials (bearer token and base URL) are correctly configured to avoid authentication errors.
  • Check the query parameters for valid values to prevent API request errors.
  • If the API returns an error, verify the resource and operation parameters are correctly set.
  • Handle JSON parsing errors for tags and comments fields if they are provided as strings instead of JSON objects.

Links

Discussion