Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Overview

This node interacts with the Pulse API to perform various workflow actions related to project management. Specifically, for the Project Work Unit resource and the List Project Work Units operation, it retrieves a list of work units associated with projects. This is useful for scenarios where you need to monitor, report on, or automate workflows involving project tasks or work units.

Practical examples include:

  • Fetching all work units assigned to a project to generate progress reports.
  • Automating task tracking by listing work units and triggering further actions based on their status.
  • Integrating project work unit data into dashboards or other systems for real-time updates.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the list request:
- Sort Sort order of results, e.g., "created_at" for ascending or "-created_at" for descending order.
- Page Number The page number to retrieve in paginated results (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. You provide the resource type and a comma-separated list of fields to return.

These properties allow fine-tuning of the query to the Pulse API, enabling efficient retrieval of relevant project work units.

Output

The node outputs an array of JSON objects representing project work units. Each object corresponds to a single work unit and contains fields as returned by the Pulse API, potentially filtered by the specified "Fields" property.

If binary data were involved (not indicated here), it would be included in a separate binary property, but this operation returns only JSON data describing work units.

Dependencies

  • Requires connection to the Pulse API via an API key credential configured in n8n.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase to handle authentication and API requests.
  • Proper network access to the Pulse API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported operations or resources will throw errors indicating the operation/resource is not supported.
    • Pagination parameters out of range may result in empty responses.
    • Improperly formatted filters or fields may cause the API to reject the request.
  • Error messages:

    • "The operation \"getProjectWorkUnitList\" is not supported for resource \"projectWorkUnits\"!" indicates a mismatch between selected operation and resource.
    • Network or authentication errors typically surface as standard HTTP error messages; ensure API keys are valid and network connectivity is stable.
  • Resolution tips:

    • Verify API credentials and permissions.
    • Double-check property values for correctness.
    • Use smaller page sizes if large responses time out.
    • Consult Pulse API documentation for valid filter keys and field names.

Links and References


This summary focuses on the "Project Work Unit" resource and its "List Project Work Units" operation as requested.

Discussion