Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions26

Overview

This node interacts with a project management API to perform various workflow actions related to projects and their associated resources. Specifically, for the Project Document resource with the List Project Documents operation, it retrieves a list of documents associated with projects. This is useful in scenarios where you want to automate document retrieval, filtering, and processing within your workflows.

Practical examples include:

  • Automatically fetching all documents related to a specific project for reporting or archival.
  • Filtering project documents by certain criteria such as creation date or document type.
  • Paginating through large sets of project documents to process them in batches.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the list request:
- 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 results per page (default is 20).
- Filters One or more filters to narrow down results by specific fields. Each filter includes:
    Key The field name to filter on.
    Values Comma-separated list of values to match for the given key.
- Fields Specify which fields to include in the response, grouped by resource type. Each entry includes:
    Resource Type The resource type to specify fields for (e.g., "projectDocuments").
    Fields Comma-separated list of fields to include in the response for that resource.

Output

The node outputs JSON data containing the list of project documents retrieved from the API. The structure typically includes an array of document objects, each representing a project document with its properties such as ID, name, creation date, and other metadata depending on the requested fields.

If binary data is involved (not typical for listing documents), it would represent file contents or downloadable document data, but this operation focuses on listing metadata only.

Dependencies

  • Requires an API key credential for authenticating with the Pulse API service.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Common Issues:

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

  • Error Messages:

    • "The operation "getProjectDocumentList" is not supported for resource "projectDocuments"!" — indicates a mismatch between selected resource and operation.
    • API errors related to invalid parameters will be returned in the error message; verify filter keys and values.
    • Network or connectivity issues will manifest as request failures; ensure network access to the API endpoint.

  • Resolutions:

    • Verify and configure the correct API authentication token.
    • Double-check property values for filters, sorting, and pagination.
    • Use the continue-on-fail option to handle partial failures gracefully.

Links and References

Discussion