DTO Models
BulkStartRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
configIdentifier |
X |
string |
Identifier of the OMN WorkflowConfig Plugin that should be used for the given StartRequests |
F.WorkflowConfig.DAM |
processStartRequests |
X |
array (of ProcessStartRequest) |
Array of start request objects for each workflow instance that should be started |
ProcessStartRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
linkedObjects |
array (of LinkedObject) |
Array of OMN objects that should be linked to the workflow instance |
see LinkedObject |
|
parameters |
array (of Parameter) |
Array of workflow parameters that should be set to the started workflow. Only parameters that are configured in the corresponding WorkflowConfig can be set here. |
see Parameter |
LinkedObject
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
tid |
X (or id) |
string |
OMN tid (technical identifier) of the object that should be linked to the workflow instance only one of [id, tid] should be used at the same time |
3b6d12b1-43a3-4541-921e-b9512570863a |
id |
X (or tid) |
integer |
OMN (internal) id of the object that should be linked to the workflow instance only one of [id, tid] should be used at the same time |
12345 |
type |
X |
string (enum) file | product | peo | project | glossary |
type of the linked object |
file |
Parameter
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
key |
X |
string |
key of the parameter like it is defined in the WorkflowConfig |
ext.ai-translation.glossaryName |
type |
X |
string (enum) string | double | integer | long | boolean | date[1] | language |
value-type of the parameter |
string |
values |
X |
array (of object) |
array of parameter value(s) Since a parameter can hold multiple values it must always be enclosed in an array, even if it is a single value |
ExampleGlossaryName |
Response
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
tid |
X |
string |
OMN tid (technical identifier) of the created workflow instance |
3b2d55b1-4313-4551-971e-b9512570863a |
status |
X |
string (enum) success | error |
status of the created workflow instance |
success |
dataType |
string (enum) product | asset | channel | message | workflow | asset |
datatype of the created instance. Should always be workflow for this endpoint. |
workflow |
|
supportId |
string |
For support purposes a generated id might be returned to assist in case of errors |
af2d55b0-4f13-4551-971e-b9512570863a |
|
issues |
array (of Issue) |
if there were issues with any start requests, details are returned here |
see Issue |
Issue
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
code |
integer |
technical error code |
500 |
|
description |
string |
human-readable description of the issue that happened |
Internal server error |
|
details |
object |
object containing an arbitrary set of properties that may help in solving the specific issue |
{ tid: '3b2d55b1-4313-4551-971e-b9512570863a' } |