Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Schedule → Get One Schedule

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve detailed information about a specific schedule. It is designed to fetch one schedule by its unique identifier, optionally including additional details about that schedule.

Common scenarios for this node include:

  • Automating retrieval of scheduled tasks or events from Halo PSA for reporting or synchronization.
  • Integrating schedule data into workflows where decisions depend on specific schedule attributes.
  • Fetching schedule details to trigger subsequent actions based on timing or status.

For example, you might use this node to get the details of a maintenance schedule by its ID and then use that data to notify a team or update another system.

Properties

Name Meaning
Id The unique numeric identifier of the schedule to retrieve.
Includedetails Optional flag to specify whether to include detailed information in the response.

Output

The node outputs JSON data representing the schedule retrieved from the Halo PSA API. This includes all standard fields of the schedule object as returned by the API, such as schedule name, time, assigned resources, status, and any other relevant metadata.

If the Includedetails property is set, the output will contain extended information related to the schedule.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node configuration must include the base URL of the Halo PSA instance, tenant identifier, client ID, and client secret.
  • Network access to the Halo PSA API endpoint is necessary.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error indicating "No credentials returned!". Ensure that valid API authentication details are configured.
  • Resource or Operation Not Found: Errors like "Resource Schedule not found" or "Operation Get One Schedule not found for resource Schedule" indicate misconfiguration of the resource or operation parameters.
  • Invalid Schedule ID: Providing an incorrect or non-existent schedule ID may result in API errors or empty responses.
  • API Request Failures: Network issues or incorrect API permissions can cause request failures. Check connectivity and API user permissions.
  • JSON Parsing Issues: If additional query parameters or request bodies are malformed JSON, parsing errors may occur.

To resolve these issues, verify credentials, input parameters, and network connectivity. Use the node's "Continue On Fail" option to handle errors gracefully within workflows.

Links and References

Discussion