# Workflows
GET /workflows Get all workflows in the system
[
{
"Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
"Alias": "Workflow1",
"Label": "Workflow 1",
"DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"States": [
{
"Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"Alias": "State1",
"Label": "State 1",
"Transitions": [
{
"Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
"TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
"Label": "To state 2",
"Description": "Transition to state 2",
"RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
}
],
"Color": "bg-gray-5 text-white"
},
{
"Uid": "2974bab2-613d-429a-841d-98ab091249c8",
"Alias": "State2",
"Label": "State 2",
"Transitions": [],
"Color": "bg-yellow-l1 text-white"
}
],
"ProductAssignmentProductStructureUids": [
"333be26b-af23-446b-973c-d190e9df676b"
],
"VariantAssignmentProductStructureUids": [],
"CatalogueAssignmentCatalogueUids": [],
"VariantGroupAssignmentProductStructureUids": []
},
{
"Uid": "c534744f-955c-4021-b1d0-4265212d3962",
"Alias": "Workflow2",
"Label": "Workflow 2",
"DefaultStateUid": "fdf1dd9c-f80d-4f4b-a2ff-f65f25f59d54",
"States": [
{
"Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"Alias": "State1",
"Label": "State 1",
"Transitions": [],
"Color": "bg-gray-5 text-white"
}
],
"ProductAssignmentProductStructureUids": [],
"VariantAssignmentProductStructureUids": [],
"CatalogueAssignmentCatalogueUids": [],
"VariantGroupAssignmentProductStructureUids": []
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow |
| Alias | string |
Alias of the workflow |
| Label | string |
Label of the workflow |
| DefaultStateUid | string |
The default state of the workflow |
| States | array : WorkflowStateModel |
The states of the workflow |
| ProductAssignmentProductStructureUids | array |
Assignment of the workflow to products using the product structures |
| VariantAssignmentProductStructureUids | array |
Assignment of the workflow to variants using the product structures |
| CatalogueAssignmentCatalogueUids | array |
Assignment of the workflow to categories in the catalogues |
| VariantGroupAssignmentProductStructureUids | array |
Assignment of the workflow to variant groups using the product structures |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow state |
| Alias | string |
Alias of the workflow state |
| Label | string |
Label of the workflow state |
| Transitions | array : WorkflowTransitionModel |
The transitions of the workflow |
| Color | string |
The color of the state in the UI |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow transition |
| TransitionToStateUid | string |
The state it can transition to |
| Label | string |
Label of the workflow transition |
| Description | string |
Description of the workflow transition |
| RequiredPermission | string |
The required permission to use the transition |
PUT /workflows Update a workflow
{
"MoveEntitiesFromStateUidToStateUid": {
"a5aba802-9260-4851-861b-bdacb9d40db1": "7d000a12-849f-405a-8ea7-0f3a0cf92048"
},
"Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
"Alias": "Workflow1",
"Label": "Workflow 1",
"DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"States": [
{
"Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"Alias": "State1",
"Label": "State 1",
"Transitions": [
{
"Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
"TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
"Label": "To state 2",
"Description": "Transition to state 2",
"RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
}
],
"Color": "bg-gray-5 text-white"
},
{
"Uid": "2974bab2-613d-429a-841d-98ab091249c8",
"Alias": "State2",
"Label": "State 2",
"Transitions": [],
"Color": "bg-yellow-l1 text-white"
}
],
"ProductAssignmentProductStructureUids": [
"333be26b-af23-446b-973c-d190e9df676b"
],
"VariantAssignmentProductStructureUids": [],
"CatalogueAssignmentCatalogueUids": [],
"VariantGroupAssignmentProductStructureUids": []
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| workflow | body | object : WorkflowUpdateModel |
Updated workflow |
| Property name | Data type | Description |
|---|---|---|
| MoveEntitiesFromStateUidToStateUid | object |
Move entities from state uid to another state uid when e.g. deleting a state |
| Uid | string |
Unique id of workflow |
| Alias | string |
Alias of the workflow |
| Label | string |
Label of the workflow |
| DefaultStateUid | string |
The default state of the workflow |
| States | array : WorkflowStateModel |
The states of the workflow |
| ProductAssignmentProductStructureUids | array |
Assignment of the workflow to products using the product structures |
| VariantAssignmentProductStructureUids | array |
Assignment of the workflow to variants using the product structures |
| CatalogueAssignmentCatalogueUids | array |
Assignment of the workflow to categories in the catalogues |
| VariantGroupAssignmentProductStructureUids | array |
Assignment of the workflow to variant groups using the product structures |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow state |
| Alias | string |
Alias of the workflow state |
| Label | string |
Label of the workflow state |
| Transitions | array : WorkflowTransitionModel |
The transitions of the workflow |
| Color | string |
The color of the state in the UI |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow transition |
| TransitionToStateUid | string |
The state it can transition to |
| Label | string |
Label of the workflow transition |
| Description | string |
Description of the workflow transition |
| RequiredPermission | string |
The required permission to use the transition |
Response status OK (200)
POST /workflows Create a workflow
{
"Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
"Alias": "Workflow1",
"Label": "Workflow 1",
"DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"States": [
{
"Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"Alias": "State1",
"Label": "State 1",
"Transitions": [
{
"Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
"TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
"Label": "To state 2",
"Description": "Transition to state 2",
"RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
}
],
"Color": "bg-gray-5 text-white"
},
{
"Uid": "2974bab2-613d-429a-841d-98ab091249c8",
"Alias": "State2",
"Label": "State 2",
"Transitions": [],
"Color": "bg-yellow-l1 text-white"
}
],
"ProductAssignmentProductStructureUids": [
"333be26b-af23-446b-973c-d190e9df676b"
],
"VariantAssignmentProductStructureUids": [],
"CatalogueAssignmentCatalogueUids": [],
"VariantGroupAssignmentProductStructureUids": []
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| workflow | body | object : WorkflowModel |
Workflow to create |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow |
| Alias | string |
Alias of the workflow |
| Label | string |
Label of the workflow |
| DefaultStateUid | string |
The default state of the workflow |
| States | array : WorkflowStateModel |
The states of the workflow |
| ProductAssignmentProductStructureUids | array |
Assignment of the workflow to products using the product structures |
| VariantAssignmentProductStructureUids | array |
Assignment of the workflow to variants using the product structures |
| CatalogueAssignmentCatalogueUids | array |
Assignment of the workflow to categories in the catalogues |
| VariantGroupAssignmentProductStructureUids | array |
Assignment of the workflow to variant groups using the product structures |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow state |
| Alias | string |
Alias of the workflow state |
| Label | string |
Label of the workflow state |
| Transitions | array : WorkflowTransitionModel |
The transitions of the workflow |
| Color | string |
The color of the state in the UI |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow transition |
| TransitionToStateUid | string |
The state it can transition to |
| Label | string |
Label of the workflow transition |
| Description | string |
Description of the workflow transition |
| RequiredPermission | string |
The required permission to use the transition |
Response status OK (200)
GET /workflows/{uid} Get a workflow
{
"Uid": "4570ec68-bb73-4e20-93f1-cf10b813b89d",
"Alias": "Workflow1",
"Label": "Workflow 1",
"DefaultStateUid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"States": [
{
"Uid": "7d000a12-849f-405a-8ea7-0f3a0cf92048",
"Alias": "State1",
"Label": "State 1",
"Transitions": [
{
"Uid": "d4b98216-d287-46f9-825a-f3084fda6cc5",
"TransitionToStateUid": "2974bab2-613d-429a-841d-98ab091249c8",
"Label": "To state 2",
"Description": "Transition to state 2",
"RequiredPermission": "6233292f-3991-4f65-ad2d-0c9e83e69616"
}
],
"Color": "bg-gray-5 text-white"
},
{
"Uid": "2974bab2-613d-429a-841d-98ab091249c8",
"Alias": "State2",
"Label": "State 2",
"Transitions": [],
"Color": "bg-yellow-l1 text-white"
}
],
"ProductAssignmentProductStructureUids": [
"333be26b-af23-446b-973c-d190e9df676b"
],
"VariantAssignmentProductStructureUids": [],
"CatalogueAssignmentCatalogueUids": [],
"VariantGroupAssignmentProductStructureUids": []
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Id of workflow to get |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow |
| Alias | string |
Alias of the workflow |
| Label | string |
Label of the workflow |
| DefaultStateUid | string |
The default state of the workflow |
| States | array : WorkflowStateModel |
The states of the workflow |
| ProductAssignmentProductStructureUids | array |
Assignment of the workflow to products using the product structures |
| VariantAssignmentProductStructureUids | array |
Assignment of the workflow to variants using the product structures |
| CatalogueAssignmentCatalogueUids | array |
Assignment of the workflow to categories in the catalogues |
| VariantGroupAssignmentProductStructureUids | array |
Assignment of the workflow to variant groups using the product structures |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow state |
| Alias | string |
Alias of the workflow state |
| Label | string |
Label of the workflow state |
| Transitions | array : WorkflowTransitionModel |
The transitions of the workflow |
| Color | string |
The color of the state in the UI |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of workflow transition |
| TransitionToStateUid | string |
The state it can transition to |
| Label | string |
Label of the workflow transition |
| Description | string |
Description of the workflow transition |
| RequiredPermission | string |
The required permission to use the transition |
DELETE /workflows/{uid} Delete a workflow
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Id of workflow to delete |