ScaleFluidly icon

ScaleFluidly

Consume ScaleFluidly API

Actions224

Overview

This node integrates with the ScaleFluidly API to perform various operations related to quotes, configuration, pricing, administration, and more. Specifically, for the Quote resource and the Get Documents By Room operation, it retrieves documents associated with a particular room within the ScaleFluidly system.

Typical use cases include:

  • Fetching all documents linked to a specific room in a quote management workflow.
  • Automating document retrieval for review or processing in sales or contract management.
  • Integrating document data into other workflows or systems for further analysis or storage.

For example, a user might want to automatically pull all documents related to a project room to generate reports or send them to stakeholders.

Properties

Name Meaning
Environment The target environment of the ScaleFluidly API. Options: Dev (development), QA (quality assurance), Local (local server).
Request JSON object containing the request body parameters required by the API for the selected operation. This is where you specify details such as the room ID or filters for retrieving documents.

Output

The node outputs an array of JSON objects representing the response from the ScaleFluidly API for the requested operation. For the "Get Documents By Room" operation, the output JSON typically contains metadata and details about each document associated with the specified room.

The exact structure depends on the API response but generally includes fields like document IDs, names, types, URLs, timestamps, and possibly status or version information.

If the API returns binary data (e.g., actual document files), the node would handle this accordingly, but based on the static code, the output is primarily JSON metadata.

Dependencies

  • Requires access to the ScaleFluidly API endpoint corresponding to the chosen environment.
  • May require an API authentication token (bearer token) provided via HTTP headers; the node expects this token to be present in the input data's headers.authorization field on the first item or uses configured credentials.
  • No explicit internal credential type names are exposed; users must provide valid authorization tokens or configure API authentication appropriately.
  • The node uses standard HTTP requests to communicate with the ScaleFluidly API.

Troubleshooting

  • Bearer token not found error: If the authorization token is missing from the input data or credentials, the node will throw an error. Ensure that the first input item contains an authorization header with a valid bearer token or that credentials are properly set up.
  • Operation not found error: If the operation name does not map to a known API endpoint, the node throws an error indicating the operation is invalid. Verify the operation parameter matches supported operations.
  • API request failures: Network issues, incorrect environment URLs, or invalid request bodies can cause request errors. Check the environment URL, request JSON format, and API permissions.
  • Empty or unexpected responses: Confirm that the request body includes all required parameters for the "Get Documents By Room" operation, such as the correct room identifier.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution or external API inspection.

Discussion