Skip to content

Commit 4a4d6c7

Browse files
author
Jens Kürten
committed
add docs
1 parent 286d378 commit 4a4d6c7

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

docs/reference/actions.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,48 @@ def my_function(metadata, event, service):
1212
return AbortAndShowErrorAction(message="Custom error message.")
1313
```
1414

15-
## AbortAndShowErrorAction
15+
## AbortAndShowErrorAction (abort_and_show_error)
1616

1717
`csfunctions.actions.AbortAndShowErrorAction`
1818

1919
Aborts the current operation and shows an error message to the user.
2020

21+
**Attributes:**
2122

22-
**AbortAndShowErrorAction.name:** abort_and_show_error
23+
|Attribute|Type|Description|
24+
|-|-|-|
25+
|message|str|Error message that will be shown to the user|
2326

24-
**AbortAndShowErrorAction.message:** Error message that will be shown to the user
27+
## StartWorkflowAction (start_workflow)
28+
29+
`csfunctions.actions.StartWorkflowAction`
30+
31+
Creates a new workflow from a template and starts it.
32+
33+
34+
35+
**Attributes:**
36+
37+
|Attribute|Type|Description|
38+
|-|-|-|
39+
|template_id|str|ID of the workflow template|
40+
|cdb_project_id|str \| None|ID of the project in which the workflow should be started|
41+
|title|str|Title that the new workflow should have|
42+
|attachment_ids|list[str]|List of cdb_object_ids to attach to the workflow|
43+
|global_briefcase_object_ids|list[str]|List of cdb_object_ids to attach to the global briefcase|
44+
|task_configurations|list[[TaskConfiguration](actions.md#TaskConfiguration)]|List of task configurations|
45+
46+
**TaskConfiguration:**
47+
48+
|Attribute|Type|Description|
49+
|-|-|-|
50+
|task_id|str|Identifier for the task|
51+
|responsible|[Subject](actions.md#Subject) \| None|Responsible Subject for the task|
52+
|recipients|list[[Subject](actions.md#Subject)]|List of recipients (only used by information tasks)|
53+
54+
**Subject:**
55+
56+
|Attribute|Type|Description|
57+
|-|-|-|
58+
|subject_id|str|ID of the subject, e.g. a role name or "personalnummer"|
59+
|subject_type|str|Type of the subject. Can be "Person", "PCS Role" or "Common Role"|

0 commit comments

Comments
 (0)