Kobana icon

Kobana

Interact with Kobana API - Quick access to common operations
Join our community

Actions215

Overview

This node interacts with the Kobana API to manage EDI Boxes, specifically supporting the "Get Many" operation for EDI Boxes under the EDI resource. It allows users to retrieve multiple EDI Box records from the Kobana system, either returning all available results or limiting the number of results returned.

Typical use cases include:

  • Retrieving a list of EDI Boxes for reporting or monitoring purposes.
  • Fetching EDI Box data in bulk to synchronize with other systems.
  • Filtering EDI Boxes using query parameters to find specific subsets.

For example, a user might want to get all EDI Boxes created within a certain date range or only retrieve the first 50 EDI Boxes for quick inspection.

Properties

Name Meaning
Return All Whether to return all EDI Box results or limit the number of results returned.
Limit The maximum number of EDI Box results to return if "Return All" is false (1 to 100).
Additional Fields JSON object containing additional fields to include in the request (optional).
Query Parameters JSON object with query parameters to filter or modify the request when retrieving EDI Boxes.

Output

The node outputs an array of JSON objects representing the retrieved EDI Boxes. Each item corresponds to one EDI Box record as returned by the Kobana API.

  • The json output field contains the EDI Box data.
  • No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kobana API.
  • The node dynamically selects the API base URL depending on the environment (production or sandbox).
  • No other external dependencies are required.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid JSON in the "Additional Fields" or "Query Parameters" properties may result in request errors.
    • Exceeding the allowed limit (max 100) for the "Limit" property will likely cause validation errors.

  • Error Messages:

    • Authentication errors typically indicate issues with the provided API key or environment setup.
    • JSON parsing errors occur if the input JSON strings are malformed; ensure valid JSON syntax.
    • API response errors may include rate limits or invalid parameter messages; verify query parameters and usage limits.

Links and References

Discussion