REST API
Workflow API
POST /rest/workflow/{workflowName}/{workflowMethod}
Execute a workflow method, json body required.
Parameters
| Name | Where | Required Value | Description | Schema |
|---|---|---|---|---|
| workflowName | url | The name workflow to run. | string | |
| workflowMethod | url | The name of the workflow method to run. | string | |
| Content-Type | headers | application/json | The content-type. |
Payload
JS
{
"argument1": "value",
"argument2": 10,
"argument3": "2012-01-01T11:00:00"
"argument4": 12.2
}
Responses
The operation was successful.
JAVA
{
"responseArg1": "value",
"responseArg2": 11
}
There was an error deserializing the JSON message.
JS
{
"detail": "error detail"
}
The operation is not authorized.
Check if the authentication cookie is set or valid or a valid username and password are set in the URL.
All errors except for JSON message deserialization errors.
JS
{
"detail": "error detail"
}
Example
Given the following workflow code:
ONE Workflow
workflow DemoWf;
function hello(name as string, `type` as string) as string {
// Throws a 400 Bad Request response
system->errorIf(`type` == "error", "This is a system error!");
// Throws a 424 Failed Dependency response
validation->failIf(`type` == "fail", "This is a validation failure!");
// Rejects a specific property with a 424 Failed Dependency response
validation->rejectIf(`type` == "reject", "entityName", "propertyName", "This property value is rejected!");
// Rejects a collection item property with a 424 Failed Dependency response
validation->rejectItemIf(`type` == "rejectItem", "entityName", "propertyName", 0, "This item property value is rejected!");
// Returns success string (returns default value "world" if name is null)
return "Hello " + string->coalesce(name, "world");
}
POST
/rest/workflow/DemoWf/helloInitializing connection...