Pulse Office Action icon

Pulse Office Action

Office actions from Pulse API

Actions17

Overview

The node interacts with the Pulse API to manage and retrieve office-related data. Specifically, for the Planning resource with the Get Planning List operation, it fetches a list of planning entries from the Pulse system. This is useful in scenarios where you want to automate or integrate planning data retrieval into workflows, such as generating reports, syncing planning schedules with other systems, or filtering planning data based on specific criteria.

Practical examples include:

  • Retrieving all planning entries for a given period or organization.
  • Including related employee information alongside planning data.
  • Applying filters and pagination to handle large datasets efficiently.

Properties

Name Meaning
Include Related Resources (included) Specifies related resources to include in the response. Currently supports including "Employees" related to the planning entries.
Additional Fields (additionalFields) A collection of optional parameters to customize the request:
- Sort: Defines the sort order of the returned planning list.
- Page Number: The page number for paginated results (default 1).
- Page Size: Number of items per page (default 10).
- Filters: Allows specifying multiple filter key-value pairs to narrow down the planning entries (e.g., by organization ID).
- Fields: Specify which fields to include in the response for more precise data retrieval.

Output

The output is a JSON object containing the list of planning entries retrieved from the Pulse API. Each entry represents a planning record with its associated data fields. If the included property is used to include related resources like employees, those related objects will be embedded within the response accordingly.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Pulse API.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase to perform API requests.
  • Proper configuration of the API credential in n8n is necessary for successful execution.

Troubleshooting

  • Common Issues:

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

  • Error Messages:

    • "Unknown operation: "getPlanningList" is not supported for resource "planning"!" — indicates a misconfiguration of the operation or resource; ensure both are correctly set.
    • API errors related to permissions or rate limits should be resolved by verifying API key scopes and usage limits.

  • Resolution Tips:

    • Double-check the API key and its permissions.
    • Validate filter keys and values against the Pulse API documentation.
    • Use pagination properties to navigate through large datasets properly.

Links and References

Discussion