grexx-api 1.0.0

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 (193) hide show
  1. package/.idea/grexx-api.iml +12 -0
  2. package/.idea/modules.xml +8 -0
  3. package/.idea/vcs.xml +6 -0
  4. package/dist/api.js +2508 -0
  5. package/dist/base.js +68 -0
  6. package/dist/common.js +161 -0
  7. package/dist/configuration.js +44 -0
  8. package/dist/generated/api.js +2448 -0
  9. package/dist/generated/apis/CaseApi.js +745 -0
  10. package/dist/generated/apis/PlatformApi.js +82 -0
  11. package/dist/generated/apis/index.js +20 -0
  12. package/dist/generated/base.js +71 -0
  13. package/dist/generated/common.js +145 -0
  14. package/dist/generated/configuration.js +104 -0
  15. package/dist/generated/core/ApiError.js +20 -0
  16. package/dist/generated/core/ApiRequestOptions.js +2 -0
  17. package/dist/generated/core/ApiResult.js +2 -0
  18. package/dist/generated/core/CancelablePromise.js +104 -0
  19. package/dist/generated/core/OpenAPI.js +14 -0
  20. package/dist/generated/core/request.js +294 -0
  21. package/dist/generated/index.js +58 -0
  22. package/dist/generated/models/AbstractCondition.js +2 -0
  23. package/dist/generated/models/AbstractReference.js +2 -0
  24. package/dist/generated/models/AbstractRule.js +2 -0
  25. package/dist/generated/models/Activity.js +2 -0
  26. package/dist/generated/models/ActivityDirectSubmit200Response.js +74 -0
  27. package/dist/generated/models/AdditionalAggregateColumn.js +10 -0
  28. package/dist/generated/models/AdditionalDataHistoryColumn.js +10 -0
  29. package/dist/generated/models/AdditionalDerivedColumn.js +16 -0
  30. package/dist/generated/models/AdditionalExternalColumn.js +10 -0
  31. package/dist/generated/models/AdditionalGroupbyColumn.js +10 -0
  32. package/dist/generated/models/AdditionalMetaColumn.js +27 -0
  33. package/dist/generated/models/AdditionalTemplateColumn.js +10 -0
  34. package/dist/generated/models/AnalyseDependency.js +2 -0
  35. package/dist/generated/models/BaseMessage.js +14 -0
  36. package/dist/generated/models/CaseInfo200Response.js +88 -0
  37. package/dist/generated/models/CaseInfo200ResponseCasetype.js +63 -0
  38. package/dist/generated/models/CaseInfo200ResponseCasetypePlatformTheme.js +84 -0
  39. package/dist/generated/models/CaseInfo200ResponseCasetypePlatformThemeCssVariables.js +98 -0
  40. package/dist/generated/models/CaseInfo200ResponseCasetypeViewsInner.js +96 -0
  41. package/dist/generated/models/CaseInfo200ResponseRootlineInner.js +52 -0
  42. package/dist/generated/models/CaseReference.js +2 -0
  43. package/dist/generated/models/CasetypeAttribute.js +2 -0
  44. package/dist/generated/models/CasetypeAttributeCurrency.js +48 -0
  45. package/dist/generated/models/CasetypeCss.js +2 -0
  46. package/dist/generated/models/CatchBlock.js +2 -0
  47. package/dist/generated/models/CatchPattern.js +11 -0
  48. package/dist/generated/models/ColumnId.js +2 -0
  49. package/dist/generated/models/ColumnIdentifier.js +14 -0
  50. package/dist/generated/models/ConditionList.js +2 -0
  51. package/dist/generated/models/ConditionOperatorType.js +30 -0
  52. package/dist/generated/models/CustomThrow.js +2 -0
  53. package/dist/generated/models/Dataset.js +2 -0
  54. package/dist/generated/models/DatasetColumn.js +2 -0
  55. package/dist/generated/models/DatasetCondition.js +2 -0
  56. package/dist/generated/models/DatasetResult.js +2 -0
  57. package/dist/generated/models/DatasetResultDatasetDefinition.js +54 -0
  58. package/dist/generated/models/DatasetResultDatasetDefinitionSortConfig.js +50 -0
  59. package/dist/generated/models/DatasetRetrieveRequest.js +80 -0
  60. package/dist/generated/models/DatasetRetrieveRequestAdditionalColumnsInner.js +120 -0
  61. package/dist/generated/models/DatasetRetrieveRequestSearch.js +73 -0
  62. package/dist/generated/models/DatasetRetrieveViaWidgetRequest.js +86 -0
  63. package/dist/generated/models/FieldType.js +20 -0
  64. package/dist/generated/models/FileUploadProfile.js +2 -0
  65. package/dist/generated/models/ForEach.js +2 -0
  66. package/dist/generated/models/FormAction.js +2 -0
  67. package/dist/generated/models/FormActionInlineJavascript.js +2 -0
  68. package/dist/generated/models/FormField.js +2 -0
  69. package/dist/generated/models/FormFieldConditionList.js +10 -0
  70. package/dist/generated/models/FormFieldMultitaskPlatformAttribute.js +184 -0
  71. package/dist/generated/models/FormFieldNotCondition.js +2 -0
  72. package/dist/generated/models/FormFieldSimpleCondition.js +10 -0
  73. package/dist/generated/models/FormFieldValueInner.js +58 -0
  74. package/dist/generated/models/FormGroup.js +2 -0
  75. package/dist/generated/models/FormRetrieve200Response.js +95 -0
  76. package/dist/generated/models/GrexxComplexDatatype.js +2 -0
  77. package/dist/generated/models/HasRoleCondition.js +2 -0
  78. package/dist/generated/models/IfThenElse.js +2 -0
  79. package/dist/generated/models/Instant.js +2 -0
  80. package/dist/generated/models/InterfaceConditionListType.js +12 -0
  81. package/dist/generated/models/MapStringObject.js +2 -0
  82. package/dist/generated/models/Mapping.js +2 -0
  83. package/dist/generated/models/ModelRequestContext.js +107 -0
  84. package/dist/generated/models/NotCondition.js +2 -0
  85. package/dist/generated/models/ParallelBlock.js +2 -0
  86. package/dist/generated/models/Picklist.js +2 -0
  87. package/dist/generated/models/PicklistTemplate.js +78 -0
  88. package/dist/generated/models/PlatformVersion200Response.js +54 -0
  89. package/dist/generated/models/PrimitiveType.js +39 -0
  90. package/dist/generated/models/RequestContext.js +2 -0
  91. package/dist/generated/models/ReturnTypeFlags.js +11 -0
  92. package/dist/generated/models/RuleList.js +2 -0
  93. package/dist/generated/models/SimpleCondition.js +2 -0
  94. package/dist/generated/models/SortConfigSearchCondition.js +10 -0
  95. package/dist/generated/models/SortConfigSearchConditionValueDatatype.js +52 -0
  96. package/dist/generated/models/SortConfigSearchList.js +10 -0
  97. package/dist/generated/models/SortConfigSort.js +11 -0
  98. package/dist/generated/models/TaskCreate200Response.js +63 -0
  99. package/dist/generated/models/TaskCreate200ResponseFormCondition.js +79 -0
  100. package/dist/generated/models/TaskCreateRequest.js +74 -0
  101. package/dist/generated/models/TaskCreateRequestAnyOf.js +65 -0
  102. package/dist/generated/models/TaskCreateRequestAnyOf1.js +65 -0
  103. package/dist/generated/models/TaskCreateRequestAnyOf2.js +64 -0
  104. package/dist/generated/models/TaskSubmitRequest.js +71 -0
  105. package/dist/generated/models/TaskSubmitRequestAnyOf.js +67 -0
  106. package/dist/generated/models/TaskSubmitRequestAnyOf1.js +66 -0
  107. package/dist/generated/models/TaskSubmitRequestAnyOf1FieldsInner.js +56 -0
  108. package/dist/generated/models/TaskSubmitRequestAnyOf2.js +65 -0
  109. package/dist/generated/models/Trigger.js +2 -0
  110. package/dist/generated/models/TryBlock.js +2 -0
  111. package/dist/generated/models/UUID.js +2 -0
  112. package/dist/generated/models/UnversionedReference.js +2 -0
  113. package/dist/generated/models/VersionedReference.js +2 -0
  114. package/dist/generated/models/While.js +2 -0
  115. package/dist/generated/models/index.js +102 -0
  116. package/dist/generated/runtime.js +345 -0
  117. package/dist/generated/services/CaseService.js +378 -0
  118. package/dist/generated/services/PlatformService.js +19 -0
  119. package/dist/index.js +31 -0
  120. package/openapi.yaml +4470 -0
  121. package/openapitools.json +7 -0
  122. package/package.json +15 -0
  123. package/src/generated/core/ApiError.ts +25 -0
  124. package/src/generated/core/ApiRequestOptions.ts +17 -0
  125. package/src/generated/core/ApiResult.ts +11 -0
  126. package/src/generated/core/CancelablePromise.ts +131 -0
  127. package/src/generated/core/OpenAPI.ts +32 -0
  128. package/src/generated/core/request.ts +322 -0
  129. package/src/generated/index.ts +73 -0
  130. package/src/generated/models/AbstractCondition.ts +11 -0
  131. package/src/generated/models/AbstractReference.ts +8 -0
  132. package/src/generated/models/AbstractRule.ts +19 -0
  133. package/src/generated/models/Activity.ts +7 -0
  134. package/src/generated/models/AdditionalAggregateColumn.ts +20 -0
  135. package/src/generated/models/AdditionalDataHistoryColumn.ts +17 -0
  136. package/src/generated/models/AdditionalDerivedColumn.ts +24 -0
  137. package/src/generated/models/AdditionalExternalColumn.ts +16 -0
  138. package/src/generated/models/AdditionalGroupbyColumn.ts +18 -0
  139. package/src/generated/models/AdditionalMetaColumn.ts +34 -0
  140. package/src/generated/models/AdditionalTemplateColumn.ts +22 -0
  141. package/src/generated/models/AnalyseDependency.ts +39 -0
  142. package/src/generated/models/BaseMessage.ts +26 -0
  143. package/src/generated/models/CaseReference.ts +8 -0
  144. package/src/generated/models/CasetypeAttribute.ts +7 -0
  145. package/src/generated/models/CasetypeCss.ts +10 -0
  146. package/src/generated/models/CatchBlock.ts +7 -0
  147. package/src/generated/models/CatchPattern.ts +7 -0
  148. package/src/generated/models/ColumnId.ts +5 -0
  149. package/src/generated/models/ColumnIdentifier.ts +10 -0
  150. package/src/generated/models/ConditionList.ts +7 -0
  151. package/src/generated/models/ConditionOperatorType.ts +26 -0
  152. package/src/generated/models/CustomThrow.ts +7 -0
  153. package/src/generated/models/Dataset.ts +7 -0
  154. package/src/generated/models/DatasetColumn.ts +7 -0
  155. package/src/generated/models/DatasetCondition.ts +7 -0
  156. package/src/generated/models/DatasetResult.ts +20 -0
  157. package/src/generated/models/FieldType.ts +16 -0
  158. package/src/generated/models/FileUploadProfile.ts +7 -0
  159. package/src/generated/models/ForEach.ts +7 -0
  160. package/src/generated/models/FormAction.ts +7 -0
  161. package/src/generated/models/FormActionInlineJavascript.ts +7 -0
  162. package/src/generated/models/FormField.ts +7 -0
  163. package/src/generated/models/FormFieldConditionList.ts +19 -0
  164. package/src/generated/models/FormFieldNotCondition.ts +12 -0
  165. package/src/generated/models/FormFieldSimpleCondition.ts +27 -0
  166. package/src/generated/models/FormGroup.ts +7 -0
  167. package/src/generated/models/GrexxComplexDatatype.ts +11 -0
  168. package/src/generated/models/HasRoleCondition.ts +7 -0
  169. package/src/generated/models/IfThenElse.ts +7 -0
  170. package/src/generated/models/Instant.ts +5 -0
  171. package/src/generated/models/InterfaceConditionListType.ts +8 -0
  172. package/src/generated/models/MapStringObject.ts +5 -0
  173. package/src/generated/models/Mapping.ts +7 -0
  174. package/src/generated/models/NotCondition.ts +7 -0
  175. package/src/generated/models/ParallelBlock.ts +7 -0
  176. package/src/generated/models/Picklist.ts +7 -0
  177. package/src/generated/models/PrimitiveType.ts +35 -0
  178. package/src/generated/models/RequestContext.ts +7 -0
  179. package/src/generated/models/ReturnTypeFlags.ts +19 -0
  180. package/src/generated/models/RuleList.ts +7 -0
  181. package/src/generated/models/SimpleCondition.ts +7 -0
  182. package/src/generated/models/SortConfigSearchCondition.ts +24 -0
  183. package/src/generated/models/SortConfigSearchList.ts +17 -0
  184. package/src/generated/models/SortConfigSort.ts +16 -0
  185. package/src/generated/models/Trigger.ts +7 -0
  186. package/src/generated/models/TryBlock.ts +7 -0
  187. package/src/generated/models/UUID.ts +5 -0
  188. package/src/generated/models/UnversionedReference.ts +8 -0
  189. package/src/generated/models/VersionedReference.ts +8 -0
  190. package/src/generated/models/While.ts +7 -0
  191. package/src/generated/services/CaseService.ts +800 -0
  192. package/src/generated/services/PlatformService.ts +26 -0
  193. package/tsconfig.json +13 -0
@@ -0,0 +1,800 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { AbstractReference } from '../models/AbstractReference';
6
+ import type { Activity } from '../models/Activity';
7
+ import type { AdditionalAggregateColumn } from '../models/AdditionalAggregateColumn';
8
+ import type { AdditionalDataHistoryColumn } from '../models/AdditionalDataHistoryColumn';
9
+ import type { AdditionalDerivedColumn } from '../models/AdditionalDerivedColumn';
10
+ import type { AdditionalExternalColumn } from '../models/AdditionalExternalColumn';
11
+ import type { AdditionalGroupbyColumn } from '../models/AdditionalGroupbyColumn';
12
+ import type { AdditionalMetaColumn } from '../models/AdditionalMetaColumn';
13
+ import type { AdditionalTemplateColumn } from '../models/AdditionalTemplateColumn';
14
+ import type { CaseReference } from '../models/CaseReference';
15
+ import type { CasetypeCss } from '../models/CasetypeCss';
16
+ import type { ColumnId } from '../models/ColumnId';
17
+ import type { ColumnIdentifier } from '../models/ColumnIdentifier';
18
+ import type { DatasetResult } from '../models/DatasetResult';
19
+ import type { FormFieldConditionList } from '../models/FormFieldConditionList';
20
+ import type { FormFieldNotCondition } from '../models/FormFieldNotCondition';
21
+ import type { FormFieldSimpleCondition } from '../models/FormFieldSimpleCondition';
22
+ import type { MapStringObject } from '../models/MapStringObject';
23
+ import type { SortConfigSearchCondition } from '../models/SortConfigSearchCondition';
24
+ import type { SortConfigSearchList } from '../models/SortConfigSearchList';
25
+ import type { SortConfigSort } from '../models/SortConfigSort';
26
+ import type { UnversionedReference } from '../models/UnversionedReference';
27
+ import type { VersionedReference } from '../models/VersionedReference';
28
+ import type { CancelablePromise } from '../core/CancelablePromise';
29
+ import { OpenAPI } from '../core/OpenAPI';
30
+ import { request as __request } from '../core/request';
31
+ export class CaseService {
32
+ /**
33
+ * Retrieve information on a case
34
+ * @param casePath Path or Id of case
35
+ * @param css Set css
36
+ * @param rootline Set rootline
37
+ * @param views Set views
38
+ * @returns any Retrieve information on a case
39
+ * @throws ApiError
40
+ */
41
+ public static caseInfo(
42
+ casePath: string,
43
+ css?: boolean,
44
+ rootline?: boolean,
45
+ views?: boolean,
46
+ ): CancelablePromise<{
47
+ caseRedirect?: string;
48
+ casetype: {
49
+ cssTemplates?: Array<CasetypeCss>;
50
+ defaultView?: VersionedReference;
51
+ /**
52
+ * the name of the casetype
53
+ */
54
+ name: string;
55
+ platformCssTemplates?: Array<CasetypeCss>;
56
+ platformTheme?: any;
57
+ views?: Array<any>;
58
+ };
59
+ devParentCase?: UnversionedReference;
60
+ id: CaseReference;
61
+ jumpToCase?: boolean;
62
+ jumpToCase_case?: UnversionedReference;
63
+ jumpToCase_view?: AbstractReference;
64
+ redirectToURL?: string;
65
+ redirectToURL_data?: string;
66
+ redirectToURL_encoding?: string;
67
+ redirectToURL_method?: string;
68
+ reference?: string;
69
+ reloadCaches?: string;
70
+ rootline?: Array<{
71
+ id: CaseReference;
72
+ reference?: string;
73
+ }>;
74
+ submitMessageBody?: string;
75
+ submitMessageButtonText?: string;
76
+ submitMessageStyle?: string;
77
+ userCaseLocale?: string;
78
+ }> {
79
+ return __request(OpenAPI, {
80
+ method: 'GET',
81
+ url: '/case-info/{casePath}',
82
+ path: {
83
+ 'casePath': casePath,
84
+ },
85
+ query: {
86
+ 'css': css,
87
+ 'rootline': rootline,
88
+ 'views': views,
89
+ },
90
+ });
91
+ }
92
+ /**
93
+ * Retrieve the contents of a dataset, rights are checked via dataset rights
94
+ * @param casePath Path or Id of case
95
+ * @param dataset ID of dataset
96
+ * @param format Format of the result
97
+ * @param requestBody
98
+ * @returns DatasetResult Retrieve the contents of a dataset, rights are checked via dataset rights
99
+ * @throws ApiError
100
+ */
101
+ public static datasetRetrieve(
102
+ casePath: string,
103
+ dataset: UnversionedReference,
104
+ format: 'simple' | 'full' = 'simple',
105
+ requestBody?: {
106
+ additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
107
+ allowHtmlAlways?: boolean;
108
+ calculateFullCount?: boolean;
109
+ columns?: Array<ColumnId>;
110
+ dataset: AbstractReference;
111
+ doAnalysis?: boolean;
112
+ forceCount?: boolean;
113
+ identifier?: ColumnIdentifier;
114
+ limit?: number;
115
+ search?: (SortConfigSearchList | SortConfigSearchCondition);
116
+ skip?: number;
117
+ sort?: Array<SortConfigSort>;
118
+ unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
119
+ unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
120
+ },
121
+ ): CancelablePromise<DatasetResult> {
122
+ return __request(OpenAPI, {
123
+ method: 'POST',
124
+ url: '/dataset/{dataset}/{casePath}',
125
+ path: {
126
+ 'casePath': casePath,
127
+ 'dataset': dataset,
128
+ },
129
+ query: {
130
+ 'format': format,
131
+ },
132
+ body: requestBody,
133
+ mediaType: 'application/json',
134
+ });
135
+ }
136
+ /**
137
+ * Retrieve the contents of a form, rights are checked via form rights
138
+ * @param casePath Path or Id of case
139
+ * @param formId ID of form
140
+ * @param form Set form
141
+ * @param format Format of the result
142
+ * @returns any Retrieve the contents of a form, rights are checked via form rights
143
+ * @throws ApiError
144
+ */
145
+ public static formRetrieve(
146
+ casePath: string,
147
+ formId: UnversionedReference,
148
+ form?: any,
149
+ format: 'simple' | 'extended' | 'full' = 'simple',
150
+ ): CancelablePromise<any> {
151
+ return __request(OpenAPI, {
152
+ method: 'GET',
153
+ url: '/form/{form}/{casePath}',
154
+ path: {
155
+ 'casePath': casePath,
156
+ 'formId': formId,
157
+ },
158
+ query: {
159
+ 'form': form,
160
+ 'format': format,
161
+ },
162
+ });
163
+ }
164
+ /**
165
+ * Retrieve the contents of a dataset, rights are checked via widget rights
166
+ * @param casePath Path or Id of case
167
+ * @param dataset ID of dataset
168
+ * @param widget ID of widget
169
+ * @param format Format of the result
170
+ * @param requestBody
171
+ * @returns DatasetResult Retrieve the contents of a dataset, rights are checked via widget rights
172
+ * @throws ApiError
173
+ */
174
+ public static datasetRetrieveViaWidget(
175
+ casePath: string,
176
+ dataset: UnversionedReference,
177
+ widget: UnversionedReference,
178
+ format: 'simple' | 'full' = 'full',
179
+ requestBody?: {
180
+ additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
181
+ allowHtmlAlways?: boolean;
182
+ calculateFullCount?: boolean;
183
+ columns?: Array<ColumnId>;
184
+ dataset: AbstractReference;
185
+ doAnalysis?: boolean;
186
+ forceCount?: boolean;
187
+ identifier?: ColumnIdentifier;
188
+ limit?: number;
189
+ search?: (SortConfigSearchList | SortConfigSearchCondition);
190
+ skip?: number;
191
+ sort?: Array<SortConfigSort>;
192
+ unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
193
+ unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
194
+ widget: AbstractReference;
195
+ widgetCaseid?: CaseReference;
196
+ },
197
+ ): CancelablePromise<DatasetResult> {
198
+ return __request(OpenAPI, {
199
+ method: 'POST',
200
+ url: '/widget-dataset/{dataset}/{widget}/{casePath}',
201
+ path: {
202
+ 'casePath': casePath,
203
+ 'dataset': dataset,
204
+ 'widget': widget,
205
+ },
206
+ query: {
207
+ 'format': format,
208
+ },
209
+ body: requestBody,
210
+ mediaType: 'application/json',
211
+ });
212
+ }
213
+ /**
214
+ * Submit (create and submit) an activity based on the activity ID and filled in fields
215
+ * @param casePath Path or Id of case
216
+ * @param activity ID of activity
217
+ * @param requestBody
218
+ * @returns any Submit (create and submit) an activity based on the activity ID and filled in fields
219
+ * @throws ApiError
220
+ */
221
+ public static activityDirectSubmit(
222
+ casePath: string,
223
+ activity: UnversionedReference,
224
+ requestBody?: Record<string, any>,
225
+ ): CancelablePromise<{
226
+ createdCase?: CaseReference;
227
+ jumpToCase?: boolean;
228
+ jumpToCase_case?: UnversionedReference;
229
+ jumpToCase_view?: AbstractReference;
230
+ redirectToURL?: string;
231
+ redirectToURL_data?: string;
232
+ redirectToURL_encoding?: string;
233
+ redirectToURL_method?: string;
234
+ reloadCaches?: string;
235
+ returnResult?: MapStringObject;
236
+ status?: string;
237
+ submitMessageBody?: string;
238
+ submitMessageButtonText?: string;
239
+ submitMessageStyle?: string;
240
+ }> {
241
+ return __request(OpenAPI, {
242
+ method: 'POST',
243
+ url: '/activity/{activity}/{casePath}',
244
+ path: {
245
+ 'casePath': casePath,
246
+ 'activity': activity,
247
+ },
248
+ body: requestBody,
249
+ mediaType: 'application/json',
250
+ });
251
+ }
252
+ /**
253
+ * Create a new optional task based on an activity ID
254
+ * @param casePath Path or Id of case
255
+ * @param activity ID of activity
256
+ * @param format Format of the result
257
+ * @param requestBody
258
+ * @returns any Create a new optional task based on an activity ID
259
+ * @throws ApiError
260
+ */
261
+ public static taskCreate(
262
+ casePath: string,
263
+ activity: UnversionedReference,
264
+ format: 'simple' | 'full' = 'full',
265
+ requestBody?: ({
266
+ activity: AbstractReference;
267
+ autoProgress?: boolean;
268
+ skipCheckRights?: boolean;
269
+ type: 'optional';
270
+ } | {
271
+ activityTag: string;
272
+ autoProgress?: boolean;
273
+ skipCheckRights?: boolean;
274
+ type: 'optionalByTag';
275
+ } | {
276
+ autoProgress?: boolean;
277
+ skipCheckRights?: boolean;
278
+ task?: number;
279
+ type: 'mandatory' | 'required';
280
+ }),
281
+ ): CancelablePromise<{
282
+ activity?: Activity;
283
+ form?: any;
284
+ formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
285
+ name?: string;
286
+ parentCase?: UnversionedReference;
287
+ startActivity?: Activity;
288
+ task?: number;
289
+ }> {
290
+ return __request(OpenAPI, {
291
+ method: 'POST',
292
+ url: '/task-create/{activity}/{casePath}',
293
+ path: {
294
+ 'casePath': casePath,
295
+ 'activity': activity,
296
+ },
297
+ query: {
298
+ 'format': format,
299
+ },
300
+ body: requestBody,
301
+ mediaType: 'application/json',
302
+ });
303
+ }
304
+ /**
305
+ * Retrieve an existing task based on the task ID
306
+ * @param casePath Path or Id of case
307
+ * @param task ID of task
308
+ * @param format Format of the result
309
+ * @returns any Retrieve an existing task based on the task ID
310
+ * @throws ApiError
311
+ */
312
+ public static taskInfo(
313
+ casePath: string,
314
+ task: number,
315
+ format: 'simple' | 'full' = 'full',
316
+ ): CancelablePromise<{
317
+ activity?: Activity;
318
+ form?: any;
319
+ formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
320
+ name?: string;
321
+ parentCase?: UnversionedReference;
322
+ startActivity?: Activity;
323
+ task?: number;
324
+ }> {
325
+ return __request(OpenAPI, {
326
+ method: 'GET',
327
+ url: '/task-info/{task}/{casePath}',
328
+ path: {
329
+ 'casePath': casePath,
330
+ 'task': task,
331
+ },
332
+ query: {
333
+ 'format': format,
334
+ },
335
+ });
336
+ }
337
+ /**
338
+ * Submit an existing task based on the task ID and filled in fields
339
+ * @param casePath Path or Id of case
340
+ * @param task ID of task
341
+ * @param requestBody
342
+ * @returns any Submit an existing task based on the task ID and filled in fields
343
+ * @throws ApiError
344
+ */
345
+ public static taskSubmit(
346
+ casePath: string,
347
+ task: number,
348
+ requestBody?: ({
349
+ activity: AbstractReference;
350
+ autoProgress?: boolean;
351
+ fields?: MapStringObject;
352
+ returnResult?: boolean;
353
+ skipCheckRights?: boolean;
354
+ type?: 'optional';
355
+ } | {
356
+ autoProgress?: boolean;
357
+ fields?: Array<{
358
+ /**
359
+ * Only allowed in the studio's.
360
+ */
361
+ devref?: string;
362
+ /**
363
+ * The external reference.
364
+ */
365
+ externalReference?: string;
366
+ id?: AbstractReference;
367
+ /**
368
+ * Not used in the backend side
369
+ */
370
+ name?: string;
371
+ value?: any;
372
+ }>;
373
+ returnResult?: boolean;
374
+ skipCheckRights?: boolean;
375
+ task?: number;
376
+ type?: 'task-array';
377
+ } | {
378
+ autoProgress?: boolean;
379
+ fields?: MapStringObject;
380
+ returnResult?: boolean;
381
+ skipCheckRights?: boolean;
382
+ task?: number;
383
+ type?: 'task-json';
384
+ }),
385
+ ): CancelablePromise<{
386
+ createdCase?: CaseReference;
387
+ jumpToCase?: boolean;
388
+ jumpToCase_case?: UnversionedReference;
389
+ jumpToCase_view?: AbstractReference;
390
+ redirectToURL?: string;
391
+ redirectToURL_data?: string;
392
+ redirectToURL_encoding?: string;
393
+ redirectToURL_method?: string;
394
+ reloadCaches?: string;
395
+ returnResult?: MapStringObject;
396
+ status?: string;
397
+ submitMessageBody?: string;
398
+ submitMessageButtonText?: string;
399
+ submitMessageStyle?: string;
400
+ }> {
401
+ return __request(OpenAPI, {
402
+ method: 'POST',
403
+ url: '/task-submit/{task}/{casePath}',
404
+ path: {
405
+ 'casePath': casePath,
406
+ 'task': task,
407
+ },
408
+ body: requestBody,
409
+ mediaType: 'application/json',
410
+ });
411
+ }
412
+ /**
413
+ * @deprecated
414
+ * Retrieve information on a case
415
+ * @param caseId ID of case
416
+ * @param css Set css
417
+ * @param rootline Set rootline
418
+ * @param views Set views
419
+ * @returns any Retrieve information on a case
420
+ * @throws ApiError
421
+ */
422
+ public static caseView(
423
+ caseId: UnversionedReference,
424
+ css?: boolean,
425
+ rootline?: boolean,
426
+ views?: boolean,
427
+ ): CancelablePromise<{
428
+ caseRedirect?: string;
429
+ casetype: {
430
+ cssTemplates?: Array<CasetypeCss>;
431
+ defaultView?: VersionedReference;
432
+ /**
433
+ * the name of the casetype
434
+ */
435
+ name: string;
436
+ platformCssTemplates?: Array<CasetypeCss>;
437
+ platformTheme?: any;
438
+ views?: Array<any>;
439
+ };
440
+ devParentCase?: UnversionedReference;
441
+ id: CaseReference;
442
+ jumpToCase?: boolean;
443
+ jumpToCase_case?: UnversionedReference;
444
+ jumpToCase_view?: AbstractReference;
445
+ redirectToURL?: string;
446
+ redirectToURL_data?: string;
447
+ redirectToURL_encoding?: string;
448
+ redirectToURL_method?: string;
449
+ reference?: string;
450
+ reloadCaches?: string;
451
+ rootline?: Array<{
452
+ id: CaseReference;
453
+ reference?: string;
454
+ }>;
455
+ submitMessageBody?: string;
456
+ submitMessageButtonText?: string;
457
+ submitMessageStyle?: string;
458
+ userCaseLocale?: string;
459
+ }> {
460
+ return __request(OpenAPI, {
461
+ method: 'GET',
462
+ url: '/case/{caseId}',
463
+ path: {
464
+ 'caseId': caseId,
465
+ },
466
+ query: {
467
+ 'css': css,
468
+ 'rootline': rootline,
469
+ 'views': views,
470
+ },
471
+ });
472
+ }
473
+ /**
474
+ * @deprecated
475
+ * Retrieve the contents of a dataset, rights are checked via dataset rights
476
+ * @param caseId ID of case
477
+ * @param dataset ID of dataset
478
+ * @param format Format of the result
479
+ * @param requestBody
480
+ * @returns DatasetResult Retrieve the contents of a dataset, rights are checked via dataset rights
481
+ * @throws ApiError
482
+ */
483
+ public static datasetGet(
484
+ caseId: UnversionedReference,
485
+ dataset: UnversionedReference,
486
+ format: 'simple' | 'full' = 'simple',
487
+ requestBody?: {
488
+ additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
489
+ allowHtmlAlways?: boolean;
490
+ calculateFullCount?: boolean;
491
+ columns?: Array<ColumnId>;
492
+ dataset: AbstractReference;
493
+ doAnalysis?: boolean;
494
+ forceCount?: boolean;
495
+ identifier?: ColumnIdentifier;
496
+ limit?: number;
497
+ search?: (SortConfigSearchList | SortConfigSearchCondition);
498
+ skip?: number;
499
+ sort?: Array<SortConfigSort>;
500
+ unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
501
+ unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
502
+ },
503
+ ): CancelablePromise<DatasetResult> {
504
+ return __request(OpenAPI, {
505
+ method: 'POST',
506
+ url: '/case/{caseId}/dataset/{dataset}',
507
+ path: {
508
+ 'caseId': caseId,
509
+ 'dataset': dataset,
510
+ },
511
+ query: {
512
+ 'format': format,
513
+ },
514
+ body: requestBody,
515
+ mediaType: 'application/json',
516
+ });
517
+ }
518
+ /**
519
+ * @deprecated
520
+ * Retrieve the contents of a form, rights are checked via form rights
521
+ * @param caseId ID of case
522
+ * @param formId ID of form
523
+ * @param form Set form
524
+ * @param format Format of the result
525
+ * @returns any Retrieve the contents of a form, rights are checked via form rights
526
+ * @throws ApiError
527
+ */
528
+ public static formGet(
529
+ caseId: UnversionedReference,
530
+ formId: UnversionedReference,
531
+ form?: any,
532
+ format: 'simple' | 'extended' | 'full' = 'simple',
533
+ ): CancelablePromise<any> {
534
+ return __request(OpenAPI, {
535
+ method: 'GET',
536
+ url: '/case/{caseId}/form/{form}',
537
+ path: {
538
+ 'caseId': caseId,
539
+ 'formId': formId,
540
+ },
541
+ query: {
542
+ 'form': form,
543
+ 'format': format,
544
+ },
545
+ });
546
+ }
547
+ /**
548
+ * @deprecated
549
+ * Retrieve the contents of a dataset, rights are checked via widget rights
550
+ * @param caseId ID of case
551
+ * @param dataset ID of dataset
552
+ * @param widget ID of widget
553
+ * @param format Format of the result
554
+ * @param requestBody
555
+ * @returns DatasetResult Retrieve the contents of a dataset, rights are checked via widget rights
556
+ * @throws ApiError
557
+ */
558
+ public static datasetGetViaWidget(
559
+ caseId: UnversionedReference,
560
+ dataset: UnversionedReference,
561
+ widget: UnversionedReference,
562
+ format: 'simple' | 'full' = 'full',
563
+ requestBody?: {
564
+ additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
565
+ allowHtmlAlways?: boolean;
566
+ calculateFullCount?: boolean;
567
+ columns?: Array<ColumnId>;
568
+ dataset: AbstractReference;
569
+ doAnalysis?: boolean;
570
+ forceCount?: boolean;
571
+ identifier?: ColumnIdentifier;
572
+ limit?: number;
573
+ search?: (SortConfigSearchList | SortConfigSearchCondition);
574
+ skip?: number;
575
+ sort?: Array<SortConfigSort>;
576
+ unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
577
+ unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
578
+ widget: AbstractReference;
579
+ widgetCaseid?: CaseReference;
580
+ },
581
+ ): CancelablePromise<DatasetResult> {
582
+ return __request(OpenAPI, {
583
+ method: 'POST',
584
+ url: '/case/{caseId}/dataset/{dataset}/widget/{widget}',
585
+ path: {
586
+ 'caseId': caseId,
587
+ 'dataset': dataset,
588
+ 'widget': widget,
589
+ },
590
+ query: {
591
+ 'format': format,
592
+ },
593
+ body: requestBody,
594
+ mediaType: 'application/json',
595
+ });
596
+ }
597
+ /**
598
+ * @deprecated
599
+ * Submit (create and submit) an activity based on the activity ID and filled in fields
600
+ * @param caseId ID of case
601
+ * @param activity ID of activity
602
+ * @param requestBody
603
+ * @returns any Submit (create and submit) an activity based on the activity ID and filled in fields
604
+ * @throws ApiError
605
+ */
606
+ public static activitySubmit(
607
+ caseId: UnversionedReference,
608
+ activity: UnversionedReference,
609
+ requestBody?: Record<string, any>,
610
+ ): CancelablePromise<{
611
+ createdCase?: CaseReference;
612
+ jumpToCase?: boolean;
613
+ jumpToCase_case?: UnversionedReference;
614
+ jumpToCase_view?: AbstractReference;
615
+ redirectToURL?: string;
616
+ redirectToURL_data?: string;
617
+ redirectToURL_encoding?: string;
618
+ redirectToURL_method?: string;
619
+ reloadCaches?: string;
620
+ returnResult?: MapStringObject;
621
+ status?: string;
622
+ submitMessageBody?: string;
623
+ submitMessageButtonText?: string;
624
+ submitMessageStyle?: string;
625
+ }> {
626
+ return __request(OpenAPI, {
627
+ method: 'POST',
628
+ url: '/case/{caseId}/activity/{activity}',
629
+ path: {
630
+ 'caseId': caseId,
631
+ 'activity': activity,
632
+ },
633
+ body: requestBody,
634
+ mediaType: 'application/json',
635
+ });
636
+ }
637
+ /**
638
+ * @deprecated
639
+ * Create a new optional task based on an activity ID
640
+ * @param caseId ID of case
641
+ * @param activity ID of activity
642
+ * @param format Format of the result
643
+ * @param requestBody
644
+ * @returns any Create a new optional task based on an activity ID
645
+ * @throws ApiError
646
+ */
647
+ public static caseTaskCreate(
648
+ caseId: UnversionedReference,
649
+ activity: UnversionedReference,
650
+ format: 'simple' | 'full' = 'full',
651
+ requestBody?: ({
652
+ activity: AbstractReference;
653
+ autoProgress?: boolean;
654
+ skipCheckRights?: boolean;
655
+ type: 'optional';
656
+ } | {
657
+ activityTag: string;
658
+ autoProgress?: boolean;
659
+ skipCheckRights?: boolean;
660
+ type: 'optionalByTag';
661
+ } | {
662
+ autoProgress?: boolean;
663
+ skipCheckRights?: boolean;
664
+ task?: number;
665
+ type: 'mandatory' | 'required';
666
+ }),
667
+ ): CancelablePromise<{
668
+ activity?: Activity;
669
+ form?: any;
670
+ formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
671
+ name?: string;
672
+ parentCase?: UnversionedReference;
673
+ startActivity?: Activity;
674
+ task?: number;
675
+ }> {
676
+ return __request(OpenAPI, {
677
+ method: 'POST',
678
+ url: '/case/{caseId}/task/create/{activity}',
679
+ path: {
680
+ 'caseId': caseId,
681
+ 'activity': activity,
682
+ },
683
+ query: {
684
+ 'format': format,
685
+ },
686
+ body: requestBody,
687
+ mediaType: 'application/json',
688
+ });
689
+ }
690
+ /**
691
+ * @deprecated
692
+ * Retrieve an existing task based on the task ID
693
+ * @param caseId ID of case
694
+ * @param task ID of task
695
+ * @param format Format of the result
696
+ * @returns any Retrieve an existing task based on the task ID
697
+ * @throws ApiError
698
+ */
699
+ public static caseTaskGet(
700
+ caseId: UnversionedReference,
701
+ task: number,
702
+ format: 'simple' | 'full' = 'full',
703
+ ): CancelablePromise<{
704
+ activity?: Activity;
705
+ form?: any;
706
+ formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
707
+ name?: string;
708
+ parentCase?: UnversionedReference;
709
+ startActivity?: Activity;
710
+ task?: number;
711
+ }> {
712
+ return __request(OpenAPI, {
713
+ method: 'GET',
714
+ url: '/case/{caseId}/task/{task}',
715
+ path: {
716
+ 'caseId': caseId,
717
+ 'task': task,
718
+ },
719
+ query: {
720
+ 'format': format,
721
+ },
722
+ });
723
+ }
724
+ /**
725
+ * @deprecated
726
+ * Submit an existing task based on the task ID and filled in fields
727
+ * @param caseId ID of case
728
+ * @param task ID of task
729
+ * @param requestBody
730
+ * @returns any Submit an existing task based on the task ID and filled in fields
731
+ * @throws ApiError
732
+ */
733
+ public static caseTaskSubmit(
734
+ caseId: UnversionedReference,
735
+ task: number,
736
+ requestBody?: ({
737
+ activity: AbstractReference;
738
+ autoProgress?: boolean;
739
+ fields?: MapStringObject;
740
+ returnResult?: boolean;
741
+ skipCheckRights?: boolean;
742
+ type?: 'optional';
743
+ } | {
744
+ autoProgress?: boolean;
745
+ fields?: Array<{
746
+ /**
747
+ * Only allowed in the studio's.
748
+ */
749
+ devref?: string;
750
+ /**
751
+ * The external reference.
752
+ */
753
+ externalReference?: string;
754
+ id?: AbstractReference;
755
+ /**
756
+ * Not used in the backend side
757
+ */
758
+ name?: string;
759
+ value?: any;
760
+ }>;
761
+ returnResult?: boolean;
762
+ skipCheckRights?: boolean;
763
+ task?: number;
764
+ type?: 'task-array';
765
+ } | {
766
+ autoProgress?: boolean;
767
+ fields?: MapStringObject;
768
+ returnResult?: boolean;
769
+ skipCheckRights?: boolean;
770
+ task?: number;
771
+ type?: 'task-json';
772
+ }),
773
+ ): CancelablePromise<{
774
+ createdCase?: CaseReference;
775
+ jumpToCase?: boolean;
776
+ jumpToCase_case?: UnversionedReference;
777
+ jumpToCase_view?: AbstractReference;
778
+ redirectToURL?: string;
779
+ redirectToURL_data?: string;
780
+ redirectToURL_encoding?: string;
781
+ redirectToURL_method?: string;
782
+ reloadCaches?: string;
783
+ returnResult?: MapStringObject;
784
+ status?: string;
785
+ submitMessageBody?: string;
786
+ submitMessageButtonText?: string;
787
+ submitMessageStyle?: string;
788
+ }> {
789
+ return __request(OpenAPI, {
790
+ method: 'POST',
791
+ url: '/case/{caseId}/task/{task}',
792
+ path: {
793
+ 'caseId': caseId,
794
+ 'task': task,
795
+ },
796
+ body: requestBody,
797
+ mediaType: 'application/json',
798
+ });
799
+ }
800
+ }