XPlanner icon

XPlanner

Interactie met XPlanner API

Actions2

Custom API Call → POST

AI-generated

Overview

This node interacts with the XPlanner API, specifically allowing users to make custom API calls. It supports GET and POST operations to any specified API endpoint under the base URL of the XPlanner service. The node is useful for scenarios where users need to perform flexible API requests beyond predefined operations, such as fetching data or sending JSON payloads to custom endpoints within XPlanner.

Use Case Examples

  1. Perform a GET request to retrieve user data from '/api/v1/users'.
  2. Send a POST request with a JSON body to create or update resources at a custom endpoint.

Properties

Name Meaning
API Endpoint The path appended to the base URL to specify the API endpoint for the request.
JSON Body The JSON data to send in the body of a POST request.

Output

JSON

  • json - The JSON response returned from the XPlanner API for the custom request.

Dependencies

  • Requires an API key credential for XPlanner API authentication.

Troubleshooting

  • Common issues include authentication failures if the API key is invalid or expired, resulting in errors when fetching the access token.
  • Errors in the API endpoint path or malformed JSON body can cause request failures.
  • If the node is set to continue on fail, errors are returned in the output JSON with an 'error' property describing the issue.

Links

Discussion