Jiandaoyun icon

Jiandaoyun

Consume Jiandaoyun API

Actions16

Overview

This node interacts with the Jiandaoyun API to manage workflow instances and related data. Specifically, the Get Workflow Instance operation retrieves detailed information about a particular workflow instance identified by its instance ID. This can include metadata about the instance and optionally its associated tasks.

Common scenarios where this node is useful include:

  • Monitoring the status and details of a specific workflow instance in an automated process.
  • Fetching workflow instance data for reporting or auditing purposes.
  • Integrating workflow instance information into other systems or dashboards.

For example, you might use this node to fetch the current state of a document approval workflow instance and decide subsequent automation steps based on that data.

Properties

Name Meaning
App ID The unique identifier of the app containing the workflow.
Entry ID The unique identifier of the entry (form) within the app.
Instance ID The unique identifier of the workflow instance to retrieve (same as data_id).
Return Tasks Boolean flag indicating whether to include the workflow's current tasks in the response.

Output

The node outputs JSON data representing the requested workflow instance. The structure typically includes:

  • Metadata about the workflow instance such as IDs, status, timestamps, and related app/entry info.
  • If Return Tasks is set to true, the output also contains an array of task objects associated with the workflow instance, detailing current tasks assigned to users.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Jiandaoyun API via an API key credential configured in n8n.
  • The node uses the base URL from the configured credentials to send authenticated HTTP POST requests to Jiandaoyun endpoints.
  • No additional external dependencies are required beyond the Jiandaoyun API access.

Troubleshooting

  • Error: "Not implemented yet"
    This error indicates that the selected resource-operation combination is not supported by the node implementation. Ensure you have selected the correct Resource ("Workflow") and Operation ("Get Workflow Instance").

  • Invalid or missing Instance ID
    The instanceId property is required. Omitting it or providing an incorrect value will cause the API call to fail. Verify the instance ID corresponds to an existing workflow instance.

  • API authentication errors
    If the node fails due to authentication issues, check that the API key credential is correctly configured and has sufficient permissions.

  • Malformed JSON or invalid parameters
    Since some properties accept JSON input, ensure JSON strings are well-formed and valid according to Jiandaoyun API specifications.

Links and References

Note: The above links point to Jiandaoyun’s official API docs for further details on request parameters and response formats.

Discussion