iTwin Component Center

Overview

This node integrates with the iTwin Component Center API to manage component documents. Specifically, the "Delete Component Document" operation allows users to delete a document associated with a particular component by specifying both the component ID and the document ID. This is useful in scenarios where outdated or incorrect documents need to be removed from a component's record in the Component Center.

Practical examples include:

• Removing deprecated design documents linked to a component.
• Cleaning up test or temporary documents after validation.
• Managing document lifecycle by deleting obsolete files programmatically.

Properties

Output

The output JSON contains the result of the delete operation. Typically, this will be an object indicating success or failure of the deletion. If the operation returns multiple results (unlikely for a delete), each will be output as separate JSON items.

No binary data output is expected from this operation.

Example output structure:

{
  "result": <operation result>
}

If an error occurs and "Continue On Fail" is enabled, the output will contain an error message like:

{
  "error": "<error message>",
  "nodeInfo": "iTwin ComponentCenter execution failed"
}

Dependencies

• Requires an API key credential for authenticating with the iTwin Component Center API.
• The node depends on the ComponentCenterOpenApiInterpreter module internally to map and execute API operations.
• Proper configuration of OAuth2 credentials or API tokens is necessary to authorize requests.

Troubleshooting

• Common issues:

  • Invalid or missing Component ID or Document ID parameters will cause the operation to fail.
  • Authentication errors if the API key or OAuth token is not configured correctly.
  • Network or API endpoint issues may cause timeouts or connection failures.

• Error messages:

  • "Unknown operation: delete-component-document" indicates the operation name was not recognized; ensure the correct operation is selected.
  • Errors returned from the API will be surfaced in the error message field; check that the IDs are valid and the user has permission to delete the document.

• Resolution tips:

  • Verify that the Component ID and Document ID exist and are correct.
  • Confirm that the API credentials have sufficient permissions.
  • Enable "Continue On Fail" to handle errors gracefully during batch executions.

Links and References

• iTwin Developer Documentation
• Refer to the official iTwin Component Center API docs for detailed information on document management endpoints.