Skip to content

Commit a66129b

Browse files
author
Jens Kürten
committed
Refactor: clean up objects documentation and consolidate change order/request sections
1 parent 666a0d7 commit a66129b

1 file changed

Lines changed: 8 additions & 50 deletions

File tree

‎docs/reference/objects.md‎

Lines changed: 8 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
|Attribute|Type|Description|
66
|-|-|-|
77
|cdb_object_id|str \| None|Object ID|
8-
|cdb_object_id|str \| None|Object ID|
98
|baugruppe|str \| None|Assembly|
109
|b_index|str \| None|Assembly Index|
1110
|component_materialnr_erp|str \| None|Material Number ERP Component|
@@ -144,7 +143,8 @@
144143
## Briefcase
145144
`csfunctions.objects.Briefcase`
146145

147-
Briefcases are used by Workflows and can contain parts, documents, engineering changes, change orders or change requests.
146+
Briefcases are used by Workflows and can contain parts, documents, engineering changes,
147+
change orders or change requests.
148148

149149
|Attribute|Type|Description|
150150
|-|-|-|
@@ -158,56 +158,14 @@ Briefcases are used by Workflows and can contain parts, documents, engineering c
158158
|parts|list[[Part](objects.md#part)]||
159159
|documents|list[[Document](objects.md#document)]||
160160
|engineering_changes|list[[EngineeringChange](objects.md#engineeringchange)]||
161-
|change_orders|list[[ChangeOrder](objects.md#changeorder)]||
162-
|change_requests|list[[ChangeRequest](objects.md#changerequest)]||
163-
164-
## ChangeOrder
165-
`csfunctions.objects.ChangeOrder`
166-
167-
A change order of the ECM module. Shares all attributes of its base class `csfunctions.objects.Change`.
168-
169-
|Attribute|Type|Description|
170-
|-|-|-|
171-
|cs_change_id|str|Change ID|
172-
|cdb_project_id|str \| None|Project ID|
173-
|product_object_oid|str \| None|Product object ID|
174-
|end_time_plan|datetime \| None|Planned end time|
175-
|status|int|Status|
176-
|title_de|str \| None|Title (de)|
177-
|title_en|str \| None|Title (en)|
178-
|title_ja|str \| None|Title (ja)|
179-
|title_zh|str \| None|Title (zh)|
180-
|cdb_object_id|str \| None|Object ID|
181-
|change_type|str \| None|Change Type|
182-
|cs_ecm_change_description_de|str \| None|Description (de)|
183-
|cs_ecm_change_description_en|str \| None|Description (en)|
184-
|cs_ecm_change_description_ja|str \| None|Description (ja)|
185-
|cs_ecm_change_description_zh|str \| None|Description (zh)|
186-
|c_event|str \| None|Event|
187-
|change_reason_de|str \| None|Reason (de)|
188-
|change_reason_en|str \| None|Reason (en)|
189-
|change_reason_ja|str \| None|Reason (ja)|
190-
|change_reason_zh|str \| None|Reason (zh)|
191-
|c_source|str \| None|Source|
192-
|part_ids|list[str]|List of part IDs, that were changed. (teilenummer@t_index)|
193-
|document_ids|list[str]|List of document IDs, that were changed. (z_nummer@z_index)|
194-
|affected_part_ids|list[str]|List of part IDs, that were planned to be changed. (teilenummer@t_index)|
195-
|affected_document_ids|list[str]|List of document IDs, that were planned to be changed. (z_nummer@z_index)|
196-
|accompanying_document_ids|list[str]|List of document IDs, that accompany the change. (z_nummer@z_index)|
197-
|parts|list[[Part](objects.md#part)]||
198-
|documents|list[[Document](objects.md#document)]||
199-
|affected_parts|list[[Part](objects.md#part)]||
200-
|affected_documents|list[[Document](objects.md#document)]||
201-
|accompanying_documents|list[[Document](objects.md#document)]||
202-
|cdb_cpersno|str \| None|Created by|
203-
|cdb_cdate|datetime \| None|Created on|
204-
|cdb_mpersno|str|Last Modified by|
205-
|cdb_mdate|datetime \| None|Last Modified on|
161+
|change_orders|list[[Change](objects.md#change)Order]||
162+
|change_requests|list[[Change](objects.md#change)Request]||
206163

207-
## ChangeRequest
208-
`csfunctions.objects.ChangeRequest`
164+
## Change
165+
`csfunctions.objects.Change`
209166

210-
A change request of the ECM module. Shares all attributes of its base class `csfunctions.objects.Change`.
167+
Base class for changes of the ECM module (change orders and change requests).
168+
Use the concrete subclasses :class:`ChangeOrder` and :class:`ChangeRequest`.
211169

212170
|Attribute|Type|Description|
213171
|-|-|-|

0 commit comments

Comments
 (0)