Skip to content

Commit b0a3353

Browse files
author
Jens Kürten
committed
feat: Add CustomOperationDocumentEvent and CustomOperationPartEvent to event documentation
1 parent 6c4303a commit b0a3353

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

docs/reference/events.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,3 +317,44 @@ This event is fired when a user tries to modify an engineering change's status.
317317
| target_status | int | The status the engineering change will be set to |
318318
| documents | list[[Document](objects.md#document)] | List of documents attached to the engineering change |
319319
| parts | list[[Part](objects.md#part)] | List of parts attached to the engineering change |
320+
321+
322+
## CustomOperationDocumentEvent
323+
`csfunctions.events.CustomOperationDocumentEvent`
324+
325+
326+
This event is triggered when a custom operation is called on one or more documents.
327+
328+
**Supported actions:**
329+
330+
- [StartWorkflowAction](actions.md#startworkflowaction)
331+
- [AbortAndShowErrorAction](actions.md#abortandshowerroraction)
332+
333+
**CustomOperationDocumentEvent.name:** custom_operation_document
334+
335+
**CustomOperationDocumentEvent.data:**
336+
337+
| Attribute | Type | Description |
338+
| --------- | ------------------------------------- | ---------------------------------------------------------- |
339+
| documents | list[[Document](objects.md#document)] | List of documents that the custom operation was called on. |
340+
| parts | list[[Part](objects.md#part)] | List of parts that belong to the documents. |
341+
342+
## CustomOperationPartEvent
343+
`csfunctions.events.CustomOperationPartEvent`
344+
345+
346+
This event is triggered when a custom operation is called on one or more parts.
347+
348+
**Supported actions:**
349+
350+
- [StartWorkflowAction](actions.md#startworkflowaction)
351+
- [AbortAndShowErrorAction](actions.md#abortandshowerroraction)
352+
353+
**CustomOperationPartEvent.name:** custom_operation_part
354+
355+
**CustomOperationPartEvent.data:**
356+
357+
| Attribute | Type | Description |
358+
| --------- | ------------------------------------- | ------------------------------------------------------ |
359+
| parts | list[[Part](objects.md#part)] | List of parts that the custom operation was called on. |
360+
| documents | list[[Document](objects.md#document)] | List of documents that belong to the parts. |

0 commit comments

Comments
 (0)