Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions23

Overview

This node interacts with the Pulse API to perform various workflow actions related to projects and their associated entities. Specifically, for the List Projects operation under the Project resource, it retrieves a list of projects from the Pulse system. This is useful in scenarios where you want to automate project management workflows, synchronize project data with other systems, or generate reports based on project information.

Practical examples include:

  • Fetching all active projects to display in a dashboard.
  • Retrieving projects filtered by certain criteria (e.g., creation date or status).
  • Paginating through large sets of projects to process them in batches.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the project list retrieval:
- Sort Sort order of the results, e.g., "created_at" for ascending or "-created_at" for descending order.
- Page Number The page number to retrieve for paginated results (default is 1).
- Page Size Number of projects to return per page (default is 20).
- Filters One or more filters to narrow down the results. Each filter consists of a key (field name) and comma-separated values to match. For example, filtering projects by status or owner.
- Fields Specify which fields to include in the response for particular resource types. You can define multiple field groups by resource type, each with a comma-separated list of fields to include.

Output

The node outputs an array of JSON objects representing projects retrieved from the Pulse API. Each object corresponds to a single project and contains fields as returned by the API, potentially filtered or limited according to the specified input properties.

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

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 environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported sort keys or filter keys may result in errors or empty results.
    • Requesting pages beyond the available range will return empty lists.

  • Error Messages:

    • "The operation "getProjectList" is not supported for resource "projects"!" — indicates a mismatch between selected resource and operation; ensure correct selections.
    • Network or API errors will typically propagate error messages from the Pulse API; verify network connectivity and API status.

  • Resolutions:

    • Double-check API credentials and permissions.
    • Validate filter keys and values against the Pulse API documentation.
    • Adjust pagination parameters to valid ranges.

Links and References

Discussion