BotCity icon

BotCity

BotCity orchestrator API

Overview

This node integrates with the BotCity orchestrator API, allowing users to manage and interact with execution workflows. Specifically, the "Get" operation under the "Execution Orchestrator" resource retrieves details about a specific execution by its ID. This is useful for monitoring the status, results, or metadata of an execution instance within BotCity's automation platform.

Practical examples include:

  • Fetching the current state or output of a particular automated process.
  • Auditing execution history for troubleshooting or reporting.
  • Integrating execution data into other workflows or dashboards.

Properties

Name Meaning
Execution ID ID of the execution to retrieve

The "Execution ID" property is required and expects a string representing the unique identifier of the execution you want to get information about.

Output

The node outputs JSON data containing the details of the specified execution. This typically includes execution status, timestamps, results, and any relevant metadata returned by the BotCity orchestrator API.

If the node supports binary data (not evident from the provided code), it would represent files or artifacts related to the execution, but this is not indicated here.

Dependencies

  • Requires an API key credential for authenticating with the BotCity orchestrator API.
  • The base URL for the API is configured via credentials and must be correctly set without trailing slashes.
  • Network access to the BotCity orchestrator endpoint is necessary.

Troubleshooting

  • Invalid Execution ID: If the provided execution ID does not exist or is malformed, the API will likely return an error. Verify the ID before making the request.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions.
  • Network Issues: Confirm connectivity to the BotCity API endpoint and that the base URL is correctly configured.
  • Unexpected Response Format: If the API changes or returns unexpected data, the node might fail to parse the response properly.

Links and References

  • BotCity Official Documentation (general reference for BotCity platform)
  • BotCity orchestrator API documentation (specific URL not provided in source)

Discussion