Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions26

Overview

This node interacts with the Pulse API to manage and retrieve data related to project work units within a project management context. Specifically, the "List Project Work Units" operation fetches a paginated list of work units associated with projects, allowing users to filter, sort, and specify which fields to include in the response.

Common scenarios where this node is beneficial include:

  • Retrieving an overview of all work units for reporting or dashboard purposes.
  • Filtering work units by specific criteria such as status or assigned user.
  • Paginating through large sets of work units to process them in batches.
  • Customizing the output by selecting only relevant fields to optimize data handling.

Practical example:

  • A project manager wants to generate a report of all active work units sorted by creation date descending, showing only the work unit ID, name, and status. This node can be configured to perform that query efficiently.

Properties

Name Meaning
Additional Fields Collection of optional parameters to customize the listing of project work units:
- Sort Sort order of results, e.g., "created_at" for ascending or "-created_at" for descending order.
- Page Number The page number to retrieve for pagination (default is 1).
- Page Size Number of results per page (default is 20).
- Filters One or more filters to narrow down results. Each filter consists of a key (field name) and comma-separated values to match.
- Fields Specify which fields to include in the response for particular resource types. Each entry includes a resource type and a comma-separated list of fields to return.

Output

The node outputs JSON data representing the list of project work units retrieved from the Pulse API. The structure typically includes an array of work unit objects, each containing properties such as IDs, names, statuses, timestamps, and any other requested fields.

If binary data were involved (not indicated here), it would represent file contents or attachments related to work units, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the Pulse API.
  • The node depends on the Pulse API service being accessible and properly configured.
  • No additional external dependencies are required beyond the API access.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect filter keys or values may result in empty responses or errors.
    • Requesting unsupported fields in the "Fields" property might lead to API errors.
    • Pagination parameters out of range could return no results.

  • Error messages:

    • "The operation "getProjectWorkUnitList" is not supported for resource "projectWorkUnits"!" indicates a misconfiguration of the operation or resource.
    • Network or API errors will surface as error messages in the output if "Continue On Fail" is enabled.

  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check filter keys and field names against Pulse API documentation.
    • Adjust pagination parameters to valid ranges.
    • Enable "Continue On Fail" to handle partial failures gracefully during batch processing.

Links and References

Discussion