pyegeria 5.4.3.3__py3-none-any.whl → 5.4.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (230) hide show
  1. commands/cat/debug_log.2025-09-02_07-44-39_567276.log.zip +0 -0
  2. commands/cat/debug_log.2025-09-03_07-45-21_986388.log.zip +0 -0
  3. commands/cat/debug_log.2025-09-04_08-21-58_788009.log.zip +0 -0
  4. commands/cat/debug_log.2025-09-05_09-37-53_062579.log.zip +0 -0
  5. commands/cat/list_format_set.py +5 -3
  6. commands/tech/list_information_supply_chains.py +1 -1
  7. commands/tech/list_solution_blueprints.py +1 -1
  8. commands/tech/list_solution_components.py +1 -1
  9. commands/tech/list_solution_roles.py +1 -1
  10. md_processing/__init__.py +9 -5
  11. md_processing/data/commands.json +7182 -1401
  12. md_processing/data/generated_format_sets.json +4137 -0
  13. md_processing/data/generated_format_sets.py +51 -0
  14. md_processing/dr_egeria.py +20 -11
  15. md_processing/md_commands/data_designer_commands.py +90 -425
  16. md_processing/md_commands/ext_ref_commands.py +543 -0
  17. md_processing/md_commands/old_solution_architect_commands.py +1139 -0
  18. md_processing/md_commands/solution_architect_commands.py +26 -59
  19. md_processing/md_processing_utils/common_md_utils.py +50 -1
  20. md_processing/md_processing_utils/debug_log +1 -3
  21. md_processing/md_processing_utils/dr-egeria-help-2025-09-09T11:10:03.md +3305 -0
  22. md_processing/md_processing_utils/extraction_utils.py +14 -7
  23. md_processing/md_processing_utils/gen_format_sets.py +422 -0
  24. md_processing/md_processing_utils/md_processing_constants.py +20 -2
  25. pyegeria/__init__.py +1 -1
  26. pyegeria/_client_new.py +9 -7
  27. pyegeria/_output_formats.py +278 -3
  28. pyegeria/collection_manager.py +20 -59
  29. pyegeria/config.py +10 -1
  30. pyegeria/data_designer.py +166 -117
  31. pyegeria/egeria_client.py +1 -1
  32. pyegeria/egeria_tech_client.py +4 -1
  33. pyegeria/external_references.py +1794 -0
  34. pyegeria/glossary_manager.py +71 -85
  35. pyegeria/governance_officer.py +26 -29
  36. pyegeria/output_formatter.py +127 -1
  37. pyegeria/project_manager.py +33 -36
  38. pyegeria/{solution_architect_omvs.py → solution_architect.py} +733 -873
  39. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/METADATA +1 -1
  40. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/RECORD +43 -219
  41. commands/.DS_Store +0 -0
  42. commands/cat/.DS_Store +0 -0
  43. commands/cat/.env +0 -8
  44. commands/cat/debug_log.2025-08-29_07-07-27_848189.log.zip +0 -0
  45. commands/cat/debug_log.2025-08-30_21-15-48_528443.log.zip +0 -0
  46. commands/cat/debug_log.log +0 -6102
  47. commands/cat/logs/pyegeria.log +0 -90
  48. commands/cli/debug_log.log +0 -0
  49. commands/doc/.DS_Store +0 -0
  50. commands/ops/logs/pyegeria.log +0 -0
  51. md_processing/.DS_Store +0 -0
  52. md_processing/.idea/.gitignore +0 -8
  53. md_processing/.idea/inspectionProfiles/Project_Default.xml +0 -59
  54. md_processing/.idea/md_processing.iml +0 -15
  55. md_processing/.idea/modules.xml +0 -8
  56. md_processing/.idea/sonarlint/issuestore/index.pb +0 -0
  57. md_processing/.idea/sonarlint/securityhotspotstore/index.pb +0 -0
  58. md_processing/.idea/vcs.xml +0 -6
  59. md_processing/.idea/workspace.xml +0 -107
  60. md_processing/dr_egeria_inbox/Derive-Dr-Gov-Defs.md +0 -8
  61. md_processing/dr_egeria_inbox/Dr.Egeria Templates.md +0 -873
  62. md_processing/dr_egeria_inbox/arch_test.md +0 -57
  63. md_processing/dr_egeria_inbox/archive/dr_egeria_intro.md +0 -254
  64. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_more_terms.md +0 -696
  65. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part1.md +0 -254
  66. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part2.md +0 -298
  67. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part3.md +0 -608
  68. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part4.md +0 -94
  69. md_processing/dr_egeria_inbox/archive/freddie_intro.md +0 -284
  70. md_processing/dr_egeria_inbox/archive/freddie_intro_orig.md +0 -275
  71. md_processing/dr_egeria_inbox/archive/test-term.md +0 -110
  72. md_processing/dr_egeria_inbox/cat_test.md +0 -100
  73. md_processing/dr_egeria_inbox/collections.md +0 -39
  74. md_processing/dr_egeria_inbox/data_designer_debug.log +0 -6
  75. md_processing/dr_egeria_inbox/data_designer_out.md +0 -60
  76. md_processing/dr_egeria_inbox/data_designer_search_test.md +0 -11
  77. md_processing/dr_egeria_inbox/data_field.md +0 -54
  78. md_processing/dr_egeria_inbox/data_spec.md +0 -77
  79. md_processing/dr_egeria_inbox/data_spec_test.md +0 -2340
  80. md_processing/dr_egeria_inbox/data_test.md +0 -179
  81. md_processing/dr_egeria_inbox/data_test2.md +0 -429
  82. md_processing/dr_egeria_inbox/data_test3.md +0 -462
  83. md_processing/dr_egeria_inbox/dr_egeria_data_designer_1.md +0 -124
  84. md_processing/dr_egeria_inbox/dr_egeria_intro_categories.md +0 -168
  85. md_processing/dr_egeria_inbox/dr_egeria_intro_part1.md +0 -280
  86. md_processing/dr_egeria_inbox/dr_egeria_intro_part2.md +0 -318
  87. md_processing/dr_egeria_inbox/dr_egeria_intro_part3.md +0 -1073
  88. md_processing/dr_egeria_inbox/dr_egeria_isc1.md +0 -44
  89. md_processing/dr_egeria_inbox/generated_help_report.md +0 -9
  90. md_processing/dr_egeria_inbox/generated_help_terms.md +0 -842
  91. md_processing/dr_egeria_inbox/glossary_list.md +0 -5
  92. md_processing/dr_egeria_inbox/glossary_search_test.md +0 -40
  93. md_processing/dr_egeria_inbox/glossary_test1.md +0 -378
  94. md_processing/dr_egeria_inbox/gov_def.md +0 -718
  95. md_processing/dr_egeria_inbox/gov_def2.md +0 -447
  96. md_processing/dr_egeria_inbox/img.png +0 -0
  97. md_processing/dr_egeria_inbox/output_tests.md +0 -114
  98. md_processing/dr_egeria_inbox/product.md +0 -211
  99. md_processing/dr_egeria_inbox/rel.md +0 -8
  100. md_processing/dr_egeria_inbox/sb.md +0 -119
  101. md_processing/dr_egeria_inbox/solution-components.md +0 -136
  102. md_processing/dr_egeria_inbox/solution_blueprints.md +0 -118
  103. md_processing/dr_egeria_inbox/synonym_test.md +0 -42
  104. md_processing/dr_egeria_inbox/t2.md +0 -268
  105. md_processing/dr_egeria_outbox/.DS_Store +0 -0
  106. md_processing/dr_egeria_outbox/.obsidian/app.json +0 -1
  107. md_processing/dr_egeria_outbox/.obsidian/appearance.json +0 -1
  108. md_processing/dr_egeria_outbox/.obsidian/community-plugins.json +0 -7
  109. md_processing/dr_egeria_outbox/.obsidian/core-plugins.json +0 -33
  110. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/main.js +0 -5164
  111. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/manifest.json +0 -10
  112. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/styles.css +0 -624
  113. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/data.json +0 -10
  114. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/main.js +0 -4459
  115. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/manifest.json +0 -10
  116. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/data.json +0 -3
  117. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/main.js +0 -153
  118. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/manifest.json +0 -11
  119. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/styles.css +0 -1
  120. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/main.js +0 -500
  121. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/manifest.json +0 -12
  122. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/styles.css +0 -1
  123. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/data.json +0 -38
  124. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/main.js +0 -37
  125. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/manifest.json +0 -11
  126. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/styles.css +0 -220
  127. md_processing/dr_egeria_outbox/.obsidian/types.json +0 -28
  128. md_processing/dr_egeria_outbox/.obsidian/workspace.json +0 -270
  129. md_processing/dr_egeria_outbox/Button Test.md +0 -11
  130. md_processing/dr_egeria_outbox/Scripts/.DS_Store +0 -0
  131. md_processing/dr_egeria_outbox/Scripts/sendRest.js +0 -24
  132. md_processing/dr_egeria_outbox/Templates/sendToApi.md.md +0 -17
  133. md_processing/dr_egeria_outbox/Untitled.canvas +0 -1
  134. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 09:26-product.md +0 -210
  135. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 14:03-product.md +0 -209
  136. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 14:24-product.md +0 -263
  137. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 16:03-data_spec_test.md +0 -2374
  138. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 16:05-data_spec_test.md +0 -2374
  139. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:28-data_spec_test.md +0 -2321
  140. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:37-data_spec_test.md +0 -2304
  141. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:56-data_spec_test.md +0 -2324
  142. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 09:00-data_spec_test.md +0 -2324
  143. md_processing/dr_egeria_outbox/processed-2025-08-30 16:56-generated_help_terms.md +0 -795
  144. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 15:00-Derive-Dr-Gov-Defs.md +0 -719
  145. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:13-Derive-Dr-Gov-Defs.md +0 -41
  146. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:14-Derive-Dr-Gov-Defs.md +0 -33
  147. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:50-Derive-Dr-Gov-Defs.md +0 -192
  148. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 22:08-gov_def2.md +0 -486
  149. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 22:10-gov_def2.md +0 -486
  150. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 08:53-gov_def2.md +0 -486
  151. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 08:54-gov_def2.md +0 -486
  152. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:03-gov_def2.md +0 -486
  153. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:06-gov_def2.md +0 -486
  154. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:10-gov_def2.md +0 -486
  155. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 13:07-gov_def.md +0 -492
  156. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 13:25-gov_def.md +0 -520
  157. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 16:43-gov_def.md +0 -636
  158. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 16:46-gov_def.md +0 -636
  159. md_processing/family_docs/Data Designer/Create_Data_Class.md +0 -164
  160. md_processing/family_docs/Data Designer/Create_Data_Dictionary.md +0 -30
  161. md_processing/family_docs/Data Designer/Create_Data_Field.md +0 -162
  162. md_processing/family_docs/Data Designer/Create_Data_Specification.md +0 -36
  163. md_processing/family_docs/Data Designer/Create_Data_Structure.md +0 -38
  164. md_processing/family_docs/Data Designer/View_Data_Classes.md +0 -78
  165. md_processing/family_docs/Data Designer/View_Data_Dictionaries.md +0 -78
  166. md_processing/family_docs/Data Designer/View_Data_Fields.md +0 -78
  167. md_processing/family_docs/Data Designer/View_Data_Specifications.md +0 -78
  168. md_processing/family_docs/Data Designer/View_Data_Structures.md +0 -78
  169. md_processing/family_docs/Data Designer.md +0 -842
  170. md_processing/family_docs/Digital Product Manager/Add_Member->Collection.md +0 -42
  171. md_processing/family_docs/Digital Product Manager/Attach_Collection->Resource.md +0 -36
  172. md_processing/family_docs/Digital Product Manager/Create_Agreement.md +0 -96
  173. md_processing/family_docs/Digital Product Manager/Create_Data_Sharing_Agreement.md +0 -72
  174. md_processing/family_docs/Digital Product Manager/Create_DigitalSubscription.md +0 -102
  175. md_processing/family_docs/Digital Product Manager/Create_Digital_Product.md +0 -134
  176. md_processing/family_docs/Digital Product Manager/Link_Agreement_Items.md +0 -60
  177. md_processing/family_docs/Digital Product Manager/Link_Contracts.md +0 -26
  178. md_processing/family_docs/Digital Product Manager/Link_Digital_Product_-_Digital_Product.md +0 -30
  179. md_processing/family_docs/Digital Product Manager/Link_Subscribers.md +0 -48
  180. md_processing/family_docs/Digital Product Manager.md +0 -668
  181. md_processing/family_docs/Glossary/Attach_Category_Parent.md +0 -18
  182. md_processing/family_docs/Glossary/Attach_Term-Term_Relationship.md +0 -26
  183. md_processing/family_docs/Glossary/Create_Category.md +0 -38
  184. md_processing/family_docs/Glossary/Create_Glossary.md +0 -42
  185. md_processing/family_docs/Glossary/Create_Term.md +0 -70
  186. md_processing/family_docs/Glossary.md +0 -206
  187. md_processing/family_docs/Governance Officer/Create_Business_Imperative.md +0 -106
  188. md_processing/family_docs/Governance Officer/Create_Certification_Type.md +0 -112
  189. md_processing/family_docs/Governance Officer/Create_Governance_Approach.md +0 -114
  190. md_processing/family_docs/Governance Officer/Create_Governance_Obligation.md +0 -114
  191. md_processing/family_docs/Governance Officer/Create_Governance_Principle.md +0 -114
  192. md_processing/family_docs/Governance Officer/Create_Governance_Procedure.md +0 -128
  193. md_processing/family_docs/Governance Officer/Create_Governance_Process.md +0 -122
  194. md_processing/family_docs/Governance Officer/Create_Governance_Processing_Purpose.md +0 -106
  195. md_processing/family_docs/Governance Officer/Create_Governance_Responsibility.md +0 -122
  196. md_processing/family_docs/Governance Officer/Create_Governance_Rule.md +0 -122
  197. md_processing/family_docs/Governance Officer/Create_Governance_Strategy.md +0 -106
  198. md_processing/family_docs/Governance Officer/Create_License_Type.md +0 -112
  199. md_processing/family_docs/Governance Officer/Create_Naming_Standard_Rule.md +0 -122
  200. md_processing/family_docs/Governance Officer/Create_Regulation_Article.md +0 -106
  201. md_processing/family_docs/Governance Officer/Create_Regulation_Definition.md +0 -118
  202. md_processing/family_docs/Governance Officer/Create_Security_Access_Control.md +0 -114
  203. md_processing/family_docs/Governance Officer/Create_Security_Group.md +0 -120
  204. md_processing/family_docs/Governance Officer/Create_Service_Level_Objectives.md +0 -122
  205. md_processing/family_docs/Governance Officer/Create_Threat_Definition.md +0 -106
  206. md_processing/family_docs/Governance Officer/Link_Governance_Controls.md +0 -32
  207. md_processing/family_docs/Governance Officer/Link_Governance_Drivers.md +0 -32
  208. md_processing/family_docs/Governance Officer/Link_Governance_Policies.md +0 -32
  209. md_processing/family_docs/Governance Officer/View_Governance_Definitions.md +0 -82
  210. md_processing/family_docs/Governance Officer.md +0 -2412
  211. md_processing/family_docs/Solution Architect/Create_Information_Supply_Chain.md +0 -70
  212. md_processing/family_docs/Solution Architect/Create_Solution_Blueprint.md +0 -44
  213. md_processing/family_docs/Solution Architect/Create_Solution_Component.md +0 -96
  214. md_processing/family_docs/Solution Architect/Create_Solution_Role.md +0 -66
  215. md_processing/family_docs/Solution Architect/Link_Information_Supply_Chain_Peers.md +0 -32
  216. md_processing/family_docs/Solution Architect/Link_Solution_Component_Peers.md +0 -32
  217. md_processing/family_docs/Solution Architect/View_Information_Supply_Chains.md +0 -32
  218. md_processing/family_docs/Solution Architect/View_Solution_Blueprints.md +0 -32
  219. md_processing/family_docs/Solution Architect/View_Solution_Components.md +0 -32
  220. md_processing/family_docs/Solution Architect/View_Solution_Roles.md +0 -32
  221. md_processing/family_docs/Solution Architect.md +0 -490
  222. md_processing/md_commands/old_project_commands.py +0 -164
  223. md_processing/md_processing_utils/debug_log.log +0 -5580
  224. md_processing/md_processing_utils/generated_help_terms.md +0 -842
  225. md_processing/md_processing_utils/logs/pyegeria.log +0 -56
  226. pyegeria/.DS_Store +0 -0
  227. pyegeria/___external_references.py +0 -3267
  228. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/LICENSE +0 -0
  229. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/WHEEL +0 -0
  230. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/entry_points.txt +0 -0
@@ -1,164 +0,0 @@
1
- # **Create Data Class**
2
- > Describes the data values that may be stored in data fields. Can be used to configure quality validators and data field classifiers.
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the data structure.
8
-
9
- > **Alternative Labels**: Data Class; Display Name; Name; Data Class Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: A description of the data class.
16
-
17
-
18
- ## **Namespace**
19
- > **Input Required**: False
20
-
21
- > **Description**: Optional namespace that scopes the field.
22
-
23
-
24
- ## **Match Property Names**
25
- > **Input Required**: False
26
-
27
- > **Description**: Names of the properties that are set.
28
-
29
- > **Default Value**: Can be determined by Dr. Egeria?
30
-
31
-
32
- ## **Match Threshold**
33
- > **Input Required**: False
34
-
35
- > **Description**: Percent of values that must match the data class specification.
36
-
37
-
38
- ## **IsCaseSensitive**
39
- > **Input Required**: False
40
-
41
- > **Description**: Are field values case sensitive?
42
-
43
- > **Default Value**: False
44
-
45
-
46
- ## **Data Type**
47
- > **Input Required**: True
48
-
49
- > **Description**: Data type for the data class.
50
-
51
- > **Valid Values**: string; int; long; date; boolean; char; byte; float; double; biginteger; bigdecimal; array<string>; array<int>; map<string,string>; map<string, boolean>; map<string, int>; map<string, long>; map<string,double>; map<string, date> map<string, object>; short; map<string, array<string>>; other
52
-
53
-
54
- ## **Allow Duplicate Values**
55
- > **Input Required**: False
56
-
57
- > **Description**: Allow duplicate values within the data class?
58
-
59
- > **Default Value**: true
60
-
61
-
62
- ## **isNullable**
63
- > **Input Required**: False
64
-
65
- > **Description**: Can the values within the dataclass be absent?
66
-
67
- > **Alternative Labels**: Nullable
68
-
69
- > **Default Value**: true
70
-
71
-
72
- ## **isCaseSensitive**
73
- > **Input Required**: False
74
-
75
- > **Description**: Indicates if the values in a data class are case sensitive.
76
-
77
- > **Alternative Labels**: Case Sensitive
78
-
79
-
80
- ## **Default Value**
81
- > **Input Required**: False
82
-
83
- > **Description**: Specify a default value for the data class.
84
-
85
- > **Alternative Labels**: Default
86
-
87
-
88
- ## **Average Value**
89
- > **Input Required**: False
90
-
91
- > **Description**: Average value for the data class.
92
-
93
- > **Alternative Labels**: Average
94
-
95
-
96
- ## **Value List**
97
- > **Input Required**: False
98
-
99
- > **Description**:
100
-
101
-
102
- ## **Value Range From**
103
- > **Input Required**: False
104
-
105
- > **Description**: Beginning range of legal values.
106
-
107
- > **Alternative Labels**: Range From
108
-
109
-
110
- ## **Value Range To**
111
- > **Input Required**: False
112
-
113
- > **Description**: End of valid range for value.
114
-
115
- > **Alternative Labels**: Range To
116
-
117
-
118
- ## **Sample Values**
119
- > **Input Required**: False
120
-
121
- > **Description**: Sample values of the data class.
122
-
123
- > **Alternative Labels**: Samples
124
-
125
-
126
- ## **Data Patterns**
127
- > **Input Required**: False
128
-
129
- > **Description**: prescribed format of a data field - e.g. credit card numbers. Often expressed as a regular expression.
130
-
131
-
132
- ## **In Data Dictionary**
133
- > **Input Required**: False
134
-
135
- > **Description**: What data dictionaries is this data field in?
136
-
137
-
138
- ## **Containing Data Class**
139
- > **Input Required**: False
140
-
141
- > **Description**: Data classes this is part of.
142
-
143
- > **Alternative Labels**: Containing Class
144
-
145
-
146
- ## **Specializes Data Class**
147
- > **Input Required**: False
148
-
149
- > **Description**: Specializes a parent data class.
150
-
151
-
152
- ## **Qualified Name**
153
- > **Input Required**: False
154
-
155
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
156
-
157
-
158
- ## **GUID**
159
- > **Input Required**: False
160
-
161
- > **Description**: A system generated unique identifier.
162
-
163
- > **Alternative Labels**: Guid; guid
164
-
@@ -1,30 +0,0 @@
1
- # **Create Data Dictionary**
2
- > A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the Data Dictionary
8
-
9
- > **Alternative Labels**: Name; Data Dictionary; Data Dict; Data Dictionary Name; Dictionary Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: A description of the Data Dictionary.
16
-
17
-
18
- ## **Qualified Name**
19
- > **Input Required**: False
20
-
21
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
22
-
23
-
24
- ## **GUID**
25
- > **Input Required**: False
26
-
27
- > **Description**: A system generated unique identifier.
28
-
29
- > **Alternative Labels**: Guid; guid
30
-
@@ -1,162 +0,0 @@
1
- # **Create Data Field**
2
- > A data field is a fundamental building block for a data structure.
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the Data Field
8
-
9
- > **Alternative Labels**: Name; Data Field Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: A description of the Data Field
16
-
17
-
18
- ## **Data Type**
19
- > **Input Required**: True
20
-
21
- > **Description**: The data type of the data field. Point to data type valid value list if exists.
22
-
23
- > **Valid Values**: string; int; long; date; boolean; char; byte; float; double; biginteger; bigdecimal; array<string>; array<int>; map<string,string>; map<string, boolean>; map<string, int>; map<string, long>; map<string,double>; map<string, date> map<string, object>; short; map<string, array<string>>; other
24
-
25
- > **Default Value**: string
26
-
27
-
28
- ## **Position**
29
- > **Input Required**: False
30
-
31
- > **Description**: Position of the data field in the data structure. If 0, position is irrelevant.
32
-
33
- > **Default Value**: 0
34
-
35
-
36
- ## **Minimum Cardinality**
37
- > **Input Required**: False
38
-
39
- > **Description**: The minimum cardinality for a data element.
40
-
41
- > **Alternative Labels**: Min Cardinality; min cardinality
42
-
43
- > **Default Value**: 1
44
-
45
-
46
- ## **Maximum Cardinality**
47
- > **Input Required**: False
48
-
49
- > **Description**: The maximum cardinality for a data element.
50
-
51
- > **Alternative Labels**: max cardinality; Max Cardinality
52
-
53
- > **Default Value**: 1
54
-
55
-
56
- ## **In Data Structure**
57
- > **Input Required**: False
58
-
59
- > **Description**: The data structure this field is a member of. If display name is not unique, use qualified name.
60
-
61
- > **Alternative Labels**: Data Structure
62
-
63
-
64
- ## **Data Class**
65
- > **Input Required**: False
66
-
67
- > **Description**: The data class that values of this data field conform to.
68
-
69
-
70
- ## **Glossary Term**
71
- > **Input Required**: False
72
-
73
- > **Description**: Term that provides meaning to this field.
74
-
75
- > **Alternative Labels**: Term
76
-
77
-
78
- ## **isNullable**
79
- > **Input Required**: False
80
-
81
- > **Description**: Can the values within the dataclass be absent?
82
-
83
- > **Alternative Labels**: Nullable
84
-
85
- > **Default Value**: true
86
-
87
-
88
- ## **Minimum Length**
89
- > **Input Required**: False
90
-
91
- > **Description**:
92
-
93
- > **Alternative Labels**: Min Length
94
-
95
-
96
- ## **Length**
97
- > **Input Required**: False
98
-
99
- > **Description**: The length of a value for a field.
100
-
101
-
102
- ## **Precision**
103
- > **Input Required**: False
104
-
105
- > **Description**: The precision of a numeric
106
-
107
-
108
- ## **Ordered Values**
109
- > **Input Required**: False
110
-
111
- > **Description**: is this field in an ordered list?
112
-
113
-
114
- ## **Units**
115
- > **Input Required**: False
116
-
117
- > **Description**: An optional string indicating the units of the field.
118
-
119
- > **Alternative Labels**: gradians
120
-
121
-
122
- ## **Default Value**
123
- > **Input Required**: False
124
-
125
- > **Description**: Specify a default value for the data class.
126
-
127
- > **Alternative Labels**: Default
128
-
129
-
130
- ## **Version Identifier**
131
- > **Input Required**: False
132
-
133
- > **Description**: A user supplied version identifier.
134
-
135
-
136
- ## **In Data Dictionary**
137
- > **Input Required**: False
138
-
139
- > **Description**: What data dictionaries is this data field in?
140
-
141
-
142
- ## **Parent Data Field**
143
- > **Input Required**: False
144
-
145
- > **Description**: Optional parent field if this is a nested field.
146
-
147
- > **Alternative Labels**: Parent Field
148
-
149
-
150
- ## **Qualified Name**
151
- > **Input Required**: False
152
-
153
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
154
-
155
-
156
- ## **GUID**
157
- > **Input Required**: False
158
-
159
- > **Description**: A system generated unique identifier.
160
-
161
- > **Alternative Labels**: Guid; guid
162
-
@@ -1,36 +0,0 @@
1
- # **Create Data Specification**
2
- > A Data Specification defines the data requirements for a project or initiative. This includes the data structures , data fields and data classes.
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the Data Specification.
8
-
9
- > **Alternative Labels**: Data Spec; Name; Display Name; Data Specification Name; Data Specification
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: A description of the Data Specification.
16
-
17
-
18
- ## **Collection Type**
19
- > **Input Required**: False
20
-
21
- > **Description**: A user supplied collection type.
22
-
23
-
24
- ## **Qualified Name**
25
- > **Input Required**: True
26
-
27
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
28
-
29
-
30
- ## **GUID**
31
- > **Input Required**: False
32
-
33
- > **Description**: A system generated unique identifier.
34
-
35
- > **Alternative Labels**: Guid; guid
36
-
@@ -1,38 +0,0 @@
1
- # **Create Data Structure**
2
- > A collection of data fields that for a data specification for a data source.
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the data structure.
8
-
9
- > **Alternative Labels**: Name; Display Name; Data Struct; Data Structure Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: A description of the data structure.
16
-
17
-
18
- ## **In Data Specification**
19
- > **Input Required**: False
20
-
21
- > **Description**: The data specifications this structure is a member of.
22
-
23
- > **Alternative Labels**: In Data Spec
24
-
25
-
26
- ## **Qualified Name**
27
- > **Input Required**: False
28
-
29
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
30
-
31
-
32
- ## **GUID**
33
- > **Input Required**: False
34
-
35
- > **Description**: A system generated unique identifier.
36
-
37
- > **Alternative Labels**: Guid; guid
38
-
@@ -1,78 +0,0 @@
1
- # **View Data Classes**
2
- > Return the data classes, optionally filtered by the search string.
3
-
4
- ## **Search String**
5
- > **Input Required**: False
6
-
7
- > **Description**: An optional search string to filter results by.
8
-
9
- > **Alternative Labels**: Filter
10
-
11
- > **Default Value**: *
12
-
13
-
14
- ## **Output Format**
15
- > **Input Required**: False
16
-
17
- > **Description**: Optional specification of output format for the query.
18
-
19
- > **Alternative Labels**: Format
20
-
21
- > **Valid Values**: LIST; FORM; REPORT; MERMAID; DICT
22
-
23
- > **Default Value**: LIST
24
-
25
-
26
- ## **Starts With**
27
- > **Input Required**: False
28
-
29
- > **Description**: If true, look for matches with the search string starting from the beginning of a field.
30
-
31
- > **Default Value**: True
32
-
33
-
34
- ## **Ends With**
35
- > **Input Required**: False
36
-
37
- > **Description**: If true, look for matches with the search string starting from the end of a field.
38
-
39
- > **Default Value**: False
40
-
41
-
42
- ## **Ignore Case**
43
- > **Input Required**: False
44
-
45
- > **Description**: If true, ignore the difference between upper and lower characters when matching the search string.
46
-
47
- > **Default Value**: False
48
-
49
-
50
- ## **AsOfTime**
51
- > **Input Required**: False
52
-
53
- > **Description**: An ISO-8601 string representing the time to view the state of the repository.
54
-
55
- > **Alternative Labels**: As Of Time
56
-
57
-
58
- ## **Sort Order**
59
- > **Input Required**: False
60
-
61
- > **Description**: How to order the results. The sort order can be selected from a list of valid value.
62
-
63
- > **Valid Values**: ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING
64
-
65
-
66
- ## **Page Size**
67
- > **Input Required**: False
68
-
69
- > **Description**: The number of elements returned per page.
70
-
71
-
72
- ## **Start From**
73
- > **Input Required**: False
74
-
75
- > **Description**: When paging through results, the starting point of the results to return.
76
-
77
- > **Default Value**: 0
78
-
@@ -1,78 +0,0 @@
1
- # **View Data Dictionaries**
2
- > Return the data dictionaries, optionally filtered by the search string.
3
-
4
- ## **Search String**
5
- > **Input Required**: False
6
-
7
- > **Description**: An optional search string to filter results by.
8
-
9
- > **Alternative Labels**: Filter
10
-
11
- > **Default Value**: *
12
-
13
-
14
- ## **Output Format**
15
- > **Input Required**: False
16
-
17
- > **Description**: Optional specification of output format for the query.
18
-
19
- > **Alternative Labels**: Format
20
-
21
- > **Valid Values**: LIST; FORM; DICT; MD; MERMAID; REPORT
22
-
23
- > **Default Value**: LIST
24
-
25
-
26
- ## **Starts With**
27
- > **Input Required**: False
28
-
29
- > **Description**: If true, look for matches with the search string starting from the beginning of a field.
30
-
31
- > **Default Value**: True
32
-
33
-
34
- ## **Ends With**
35
- > **Input Required**: False
36
-
37
- > **Description**: If true, look for matches with the search string starting from the end of a field.
38
-
39
- > **Default Value**: False
40
-
41
-
42
- ## **Ignore Case**
43
- > **Input Required**: False
44
-
45
- > **Description**: If true, ignore the difference between upper and lower characters when matching the search string.
46
-
47
- > **Default Value**: False
48
-
49
-
50
- ## **Page Size**
51
- > **Input Required**: False
52
-
53
- > **Description**: The number of elements returned per page.
54
-
55
-
56
- ## **Start From**
57
- > **Input Required**: False
58
-
59
- > **Description**: When paging through results, the starting point of the results to return.
60
-
61
- > **Default Value**: 0
62
-
63
-
64
- ## **AsOfTime**
65
- > **Input Required**: False
66
-
67
- > **Description**: An ISO-8601 string representing the time to view the state of the repository.
68
-
69
- > **Alternative Labels**: As Of Time
70
-
71
-
72
- ## **Sort Order**
73
- > **Input Required**: False
74
-
75
- > **Description**: How to order the results. The sort order can be selected from a list of valid value.
76
-
77
- > **Valid Values**: ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING
78
-
@@ -1,78 +0,0 @@
1
- # **View Data Fields**
2
- > Return the data fields, optionally filtered by the search string.
3
-
4
- ## **Search String**
5
- > **Input Required**: False
6
-
7
- > **Description**: An optional search string to filter results by.
8
-
9
- > **Alternative Labels**: Filter
10
-
11
- > **Default Value**: *
12
-
13
-
14
- ## **Output Format**
15
- > **Input Required**: False
16
-
17
- > **Description**: Optional specification of output format for the query.
18
-
19
- > **Alternative Labels**: Format
20
-
21
- > **Valid Values**: LIST; FORM; REPORT; MERMAID; DICT
22
-
23
- > **Default Value**: LIST
24
-
25
-
26
- ## **Starts With**
27
- > **Input Required**: False
28
-
29
- > **Description**: If true, look for matches with the search string starting from the beginning of a field.
30
-
31
- > **Default Value**: True
32
-
33
-
34
- ## **Ends With**
35
- > **Input Required**: False
36
-
37
- > **Description**: If true, look for matches with the search string starting from the end of a field.
38
-
39
- > **Default Value**: False
40
-
41
-
42
- ## **Ignore Case**
43
- > **Input Required**: False
44
-
45
- > **Description**: If true, ignore the difference between upper and lower characters when matching the search string.
46
-
47
- > **Default Value**: False
48
-
49
-
50
- ## **AsOfTime**
51
- > **Input Required**: False
52
-
53
- > **Description**: An ISO-8601 string representing the time to view the state of the repository.
54
-
55
- > **Alternative Labels**: As Of Time
56
-
57
-
58
- ## **Sort Order**
59
- > **Input Required**: False
60
-
61
- > **Description**: How to order the results. The sort order can be selected from a list of valid value.
62
-
63
- > **Valid Values**: ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING
64
-
65
-
66
- ## **Page Size**
67
- > **Input Required**: False
68
-
69
- > **Description**: The number of elements returned per page.
70
-
71
-
72
- ## **Start From**
73
- > **Input Required**: False
74
-
75
- > **Description**: When paging through results, the starting point of the results to return.
76
-
77
- > **Default Value**: 0
78
-