Actions37
- Groups Actions
- Members Actions
- Roles Actions
- Permissions Actions
- Jobs Actions
- Shares Actions
- Actions Actions
- Users Actions
Overview
This node operation creates a new iTwin job by sending a request to the iTwin platform's Jobs API. It is useful for automating workflows that require initiating jobs within the iTwin ecosystem, such as starting data processing tasks, triggering synchronization jobs, or managing project-related operations programmatically.
Typical use cases include:
- Automatically creating jobs in response to events in other systems.
- Integrating iTwin job creation into larger automation pipelines.
- Customizing job creation requests with specific actions and options.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier for the iTwin job to be created. |
| Actions | A JSON object defining the actions or parameters associated with the job. |
| Options | Additional optional settings for the job creation request, including: |
| Custom Payload | Allows overriding the entire request body with a custom JSON payload if enabled. |
Details on Options > Custom Payload
- Use Custom Payload (boolean): When true, the node sends the provided JSON payload directly as the request body instead of the standard constructed body.
- JSON Payload (JSON): The raw JSON content to send as the request body when custom payload usage is enabled.
Output
The node outputs an array of items where each item contains a json property representing the response from the iTwin API after creating the job. The structure of this JSON depends on the API response but generally includes details about the created job such as its status, identifiers, and any metadata returned by the service.
No binary data output is indicated.
Dependencies
- Requires an API authentication credential for the iTwin platform (e.g., OAuth2 token).
- The node internally uses an interpreter module (
UsersOpenApiInterpreter) to map and execute the API operation. - Network access to the iTwin API endpoint is necessary.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or not supported, the node throws an "Unknown operation" error. Ensure the operation is set exactly to "create-itwin-job".
- Invalid JSON in Actions or Custom Payload: Since these fields expect valid JSON, malformed JSON will cause parsing errors. Validate JSON syntax before running the node.
- API authentication failures: Missing or invalid credentials will result in authorization errors. Verify that the API key or OAuth token is correctly configured.
- Continue on Fail: If enabled, the node will catch errors and output them as JSON objects instead of stopping execution, which can help in debugging batch executions.
Links and References
- iTwin Developer Documentation
- Refer to the official iTwin Jobs API documentation for detailed schema and examples of job creation requests and responses.