Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Datastream → Get All

AI-generated

Overview

This node interacts with the Workboard API to perform various operations on different resources. Specifically, for the Datastream resource with the Get All operation, it retrieves a list of datastreams from the Workboard platform. This is useful for scenarios where users need to fetch and analyze multiple datastreams, such as monitoring data streams or integrating datastream data into workflows.

Use Case Examples

  1. Fetching all datastreams with pagination and sorting to display in a dashboard.
  2. Retrieving filtered datastreams based on specific criteria for reporting purposes.

Properties

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

Output

JSON

  • ``
    • id - Unique identifier of the datastream
    • name - Name of the datastream
    • description - Description of the datastream
    • created_at - Timestamp when the datastream was created
    • updated_at - Timestamp when the datastream was last updated
    • otherProperties - Other properties returned by the Workboard API for each datastream

Dependencies

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

Troubleshooting

  • Common issues include authentication failures due to invalid or expired API tokens. Ensure the API key credential is correctly configured.
  • Incorrect query parameters may result in empty or unexpected results. Verify the parameters such as limit, offset, sort_by, and filter are correctly set.
  • API rate limits or network issues may cause request failures. Check network connectivity and API usage limits.
  • Error messages from the API are propagated as node errors; enabling 'Continue On Fail' allows processing of subsequent items despite errors.

Links

Discussion