![]() |
T4EA
AIG_19.2 C8891 A24697
Teamcenter Gateway for Enterprise Applications API Reference
|
Public Member Functions | |
addStep name description command args | |
This method adds a step binding a TCL command. More... | |
CheckCommand cmd | |
This method checks if the target TCL command exists. More... | |
defineRestEndpoint name method ?inputDataFormat? ?outputDataFormat? ?modeAsync? | |
This method defines a pipeline specific rest endpoint. More... | |
enableMonitor | |
enableTransactionLogger | |
getEndpoints | |
This method returns information of all created pipeline specific endpoints. More... | |
getName | |
This method returns the pipeline name. More... | |
getSteps | |
This method returns information of all steps. More... | |
getSummary | |
NormalizeResult input | |
This method normalizes a step engine result. More... | |
ResponseError errMsg expectedOutputDataFormat | |
run input | |
This method triggers the pipeline with given input data (script way) More... | |
runAsync input | |
trigger name args | |
This method triggers a pipeline (webservice way) More... | |
triggerAsync name args | |
addStep | name description command args | ||
This method adds a step binding a TCL command.
name | Step name |
description | Step description |
command | Target TCL command |
args | (Optional) Additional properties |
CheckCommand | cmd | ||
This method checks if the target TCL command exists.
defineRestEndpoint | name method ?inputDataFormat? ?outputDataFormat? ?modeAsync? | ||
This method defines a pipeline specific rest endpoint.
name | identifier of the rest endpoint <host>:<port>/pxml/<name> |
method | Expected HTTP method |
inputDataFormat | (Optional) The HTTP payload format. Default value := JSON |
outputDataFormat | (Optional) The HTTP response format. Default value := JSON |
enableMonitor |
enableTransactionLogger |
getEndpoints |
This method returns information of all created pipeline specific endpoints.
getName |
This method returns the pipeline name.
getSteps |
This method returns information of all steps.
getSummary |
NormalizeResult | input | ||
This method normalizes a step engine result.
input | Step engine result: Ok|Error ... |
ResponseError | errMsg expectedOutputDataFormat | ||
run | input | ||
This method triggers the pipeline with given input data (script way)
input | Input data (can be empty string) |
runAsync | input | ||
trigger | name args | ||
This method triggers a pipeline (webservice way)
name | Pipeline name |
args | Payload from rest endpoint call |
triggerAsync | name args | ||