grexx-api 1.0.0 → 1.0.1
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.
- package/dist/generated/core/ApiError.d.ts +10 -0
- package/dist/generated/core/ApiRequestOptions.d.ts +13 -0
- package/dist/generated/core/ApiResult.d.ts +7 -0
- package/dist/generated/core/CancelablePromise.d.ts +20 -0
- package/dist/generated/core/OpenAPI.d.ts +16 -0
- package/dist/generated/core/request.d.ts +30 -0
- package/dist/generated/index.d.ts +67 -0
- package/dist/generated/models/AbstractCondition.d.ts +6 -0
- package/dist/generated/models/AbstractReference.d.ts +4 -0
- package/dist/generated/models/AbstractRule.d.ts +14 -0
- package/dist/generated/models/Activity.d.ts +1 -0
- package/dist/generated/models/AdditionalAggregateColumn.d.ts +15 -0
- package/dist/generated/models/AdditionalDataHistoryColumn.d.ts +12 -0
- package/dist/generated/models/AdditionalDerivedColumn.d.ts +19 -0
- package/dist/generated/models/AdditionalExternalColumn.d.ts +11 -0
- package/dist/generated/models/AdditionalGroupbyColumn.d.ts +13 -0
- package/dist/generated/models/AdditionalMetaColumn.d.ts +29 -0
- package/dist/generated/models/AdditionalTemplateColumn.d.ts +17 -0
- package/dist/generated/models/AnalyseDependency.d.ts +34 -0
- package/dist/generated/models/BaseMessage.d.ts +21 -0
- package/dist/generated/models/CaseReference.d.ts +4 -0
- package/dist/generated/models/CasetypeAttribute.d.ts +1 -0
- package/dist/generated/models/CasetypeCss.d.ts +5 -0
- package/dist/generated/models/CatchBlock.d.ts +1 -0
- package/dist/generated/models/CatchPattern.d.ts +3 -0
- package/dist/generated/models/ColumnId.d.ts +1 -0
- package/dist/generated/models/ColumnIdentifier.d.ts +6 -0
- package/dist/generated/models/ConditionList.d.ts +1 -0
- package/dist/generated/models/ConditionOperatorType.d.ts +22 -0
- package/dist/generated/models/CustomThrow.d.ts +1 -0
- package/dist/generated/models/Dataset.d.ts +1 -0
- package/dist/generated/models/DatasetColumn.d.ts +1 -0
- package/dist/generated/models/DatasetCondition.d.ts +1 -0
- package/dist/generated/models/DatasetResult.d.ts +15 -0
- package/dist/generated/models/FieldType.d.ts +12 -0
- package/dist/generated/models/FileUploadProfile.d.ts +1 -0
- package/dist/generated/models/ForEach.d.ts +1 -0
- package/dist/generated/models/FormAction.d.ts +1 -0
- package/dist/generated/models/FormActionInlineJavascript.d.ts +1 -0
- package/dist/generated/models/FormField.d.ts +1 -0
- package/dist/generated/models/FormFieldConditionList.d.ts +14 -0
- package/dist/generated/models/FormFieldNotCondition.d.ts +7 -0
- package/dist/generated/models/FormFieldSimpleCondition.d.ts +22 -0
- package/dist/generated/models/FormGroup.d.ts +1 -0
- package/dist/generated/models/GrexxComplexDatatype.d.ts +6 -0
- package/dist/generated/models/HasRoleCondition.d.ts +1 -0
- package/dist/generated/models/IfThenElse.d.ts +1 -0
- package/dist/generated/models/Instant.d.ts +1 -0
- package/dist/generated/models/InterfaceConditionListType.d.ts +4 -0
- package/dist/generated/models/MapStringObject.d.ts +1 -0
- package/dist/generated/models/Mapping.d.ts +1 -0
- package/dist/generated/models/NotCondition.d.ts +1 -0
- package/dist/generated/models/ParallelBlock.d.ts +1 -0
- package/dist/generated/models/Picklist.d.ts +1 -0
- package/dist/generated/models/PrimitiveType.d.ts +31 -0
- package/dist/generated/models/RequestContext.d.ts +1 -0
- package/dist/generated/models/ReturnTypeFlags.d.ts +14 -0
- package/dist/generated/models/RuleList.d.ts +1 -0
- package/dist/generated/models/SimpleCondition.d.ts +1 -0
- package/dist/generated/models/SortConfigSearchCondition.d.ts +19 -0
- package/dist/generated/models/SortConfigSearchList.d.ts +12 -0
- package/dist/generated/models/SortConfigSort.d.ts +11 -0
- package/dist/generated/models/Trigger.d.ts +1 -0
- package/dist/generated/models/TryBlock.d.ts +1 -0
- package/dist/generated/models/UUID.d.ts +1 -0
- package/dist/generated/models/UnversionedReference.d.ts +4 -0
- package/dist/generated/models/VersionedReference.d.ts +4 -0
- package/dist/generated/models/While.d.ts +1 -0
- package/dist/generated/services/CaseService.d.ts +512 -0
- package/dist/generated/services/PlatformService.d.ts +15 -0
- package/package.json +6 -3
- package/tsconfig.json +2 -1
- package/dist/api.js +0 -2508
- package/dist/base.js +0 -68
- package/dist/common.js +0 -161
- package/dist/configuration.js +0 -44
- package/dist/generated/api.js +0 -2448
- package/dist/generated/apis/CaseApi.js +0 -745
- package/dist/generated/apis/PlatformApi.js +0 -82
- package/dist/generated/apis/index.js +0 -20
- package/dist/generated/base.js +0 -71
- package/dist/generated/common.js +0 -145
- package/dist/generated/configuration.js +0 -104
- package/dist/generated/models/ActivityDirectSubmit200Response.js +0 -74
- package/dist/generated/models/CaseInfo200Response.js +0 -88
- package/dist/generated/models/CaseInfo200ResponseCasetype.js +0 -63
- package/dist/generated/models/CaseInfo200ResponseCasetypePlatformTheme.js +0 -84
- package/dist/generated/models/CaseInfo200ResponseCasetypePlatformThemeCssVariables.js +0 -98
- package/dist/generated/models/CaseInfo200ResponseCasetypeViewsInner.js +0 -96
- package/dist/generated/models/CaseInfo200ResponseRootlineInner.js +0 -52
- package/dist/generated/models/CasetypeAttributeCurrency.js +0 -48
- package/dist/generated/models/DatasetResultDatasetDefinition.js +0 -54
- package/dist/generated/models/DatasetResultDatasetDefinitionSortConfig.js +0 -50
- package/dist/generated/models/DatasetRetrieveRequest.js +0 -80
- package/dist/generated/models/DatasetRetrieveRequestAdditionalColumnsInner.js +0 -120
- package/dist/generated/models/DatasetRetrieveRequestSearch.js +0 -73
- package/dist/generated/models/DatasetRetrieveViaWidgetRequest.js +0 -86
- package/dist/generated/models/FormFieldMultitaskPlatformAttribute.js +0 -184
- package/dist/generated/models/FormFieldValueInner.js +0 -58
- package/dist/generated/models/FormRetrieve200Response.js +0 -95
- package/dist/generated/models/ModelRequestContext.js +0 -107
- package/dist/generated/models/PicklistTemplate.js +0 -78
- package/dist/generated/models/PlatformVersion200Response.js +0 -54
- package/dist/generated/models/SortConfigSearchConditionValueDatatype.js +0 -52
- package/dist/generated/models/TaskCreate200Response.js +0 -63
- package/dist/generated/models/TaskCreate200ResponseFormCondition.js +0 -79
- package/dist/generated/models/TaskCreateRequest.js +0 -74
- package/dist/generated/models/TaskCreateRequestAnyOf.js +0 -65
- package/dist/generated/models/TaskCreateRequestAnyOf1.js +0 -65
- package/dist/generated/models/TaskCreateRequestAnyOf2.js +0 -64
- package/dist/generated/models/TaskSubmitRequest.js +0 -71
- package/dist/generated/models/TaskSubmitRequestAnyOf.js +0 -67
- package/dist/generated/models/TaskSubmitRequestAnyOf1.js +0 -66
- package/dist/generated/models/TaskSubmitRequestAnyOf1FieldsInner.js +0 -56
- package/dist/generated/models/TaskSubmitRequestAnyOf2.js +0 -65
- package/dist/generated/models/index.js +0 -102
- package/dist/generated/runtime.js +0 -345
- package/dist/index.js +0 -31
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type RequestContext = {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export type ReturnTypeFlags = {
|
|
2
|
+
currency?: {
|
|
3
|
+
currencyCode?: string;
|
|
4
|
+
};
|
|
5
|
+
multilanguage?: boolean;
|
|
6
|
+
multivalue?: boolean;
|
|
7
|
+
multivalueType?: ReturnTypeFlags.multivalueType;
|
|
8
|
+
};
|
|
9
|
+
export declare namespace ReturnTypeFlags {
|
|
10
|
+
enum multivalueType {
|
|
11
|
+
SET = "set",
|
|
12
|
+
LIST = "list"
|
|
13
|
+
}
|
|
14
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type RuleList = {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type SimpleCondition = {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { ConditionOperatorType } from './ConditionOperatorType';
|
|
2
|
+
import type { PrimitiveType } from './PrimitiveType';
|
|
3
|
+
import type { ReturnTypeFlags } from './ReturnTypeFlags';
|
|
4
|
+
export type SortConfigSearchCondition = {
|
|
5
|
+
column?: string;
|
|
6
|
+
operator?: ConditionOperatorType;
|
|
7
|
+
type?: SortConfigSearchCondition.type;
|
|
8
|
+
value?: any;
|
|
9
|
+
valueDatatype?: {
|
|
10
|
+
flags?: ReturnTypeFlags;
|
|
11
|
+
type?: PrimitiveType;
|
|
12
|
+
};
|
|
13
|
+
valueType?: string;
|
|
14
|
+
};
|
|
15
|
+
export declare namespace SortConfigSearchCondition {
|
|
16
|
+
enum type {
|
|
17
|
+
SIMPLE_CONDITION = "simpleCondition"
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { InterfaceConditionListType } from './InterfaceConditionListType';
|
|
2
|
+
import type { SortConfigSearchCondition } from './SortConfigSearchCondition';
|
|
3
|
+
export type SortConfigSearchList = {
|
|
4
|
+
conditions?: Array<(SortConfigSearchList | SortConfigSearchCondition)>;
|
|
5
|
+
listType?: InterfaceConditionListType;
|
|
6
|
+
type?: SortConfigSearchList.type;
|
|
7
|
+
};
|
|
8
|
+
export declare namespace SortConfigSearchList {
|
|
9
|
+
enum type {
|
|
10
|
+
CONDITION_LIST = "conditionList"
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type Trigger = {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type TryBlock = {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type UUID = string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type While = {};
|
|
@@ -0,0 +1,512 @@
|
|
|
1
|
+
import type { AbstractReference } from '../models/AbstractReference';
|
|
2
|
+
import type { Activity } from '../models/Activity';
|
|
3
|
+
import type { AdditionalAggregateColumn } from '../models/AdditionalAggregateColumn';
|
|
4
|
+
import type { AdditionalDataHistoryColumn } from '../models/AdditionalDataHistoryColumn';
|
|
5
|
+
import type { AdditionalDerivedColumn } from '../models/AdditionalDerivedColumn';
|
|
6
|
+
import type { AdditionalExternalColumn } from '../models/AdditionalExternalColumn';
|
|
7
|
+
import type { AdditionalGroupbyColumn } from '../models/AdditionalGroupbyColumn';
|
|
8
|
+
import type { AdditionalMetaColumn } from '../models/AdditionalMetaColumn';
|
|
9
|
+
import type { AdditionalTemplateColumn } from '../models/AdditionalTemplateColumn';
|
|
10
|
+
import type { CaseReference } from '../models/CaseReference';
|
|
11
|
+
import type { CasetypeCss } from '../models/CasetypeCss';
|
|
12
|
+
import type { ColumnId } from '../models/ColumnId';
|
|
13
|
+
import type { ColumnIdentifier } from '../models/ColumnIdentifier';
|
|
14
|
+
import type { DatasetResult } from '../models/DatasetResult';
|
|
15
|
+
import type { FormFieldConditionList } from '../models/FormFieldConditionList';
|
|
16
|
+
import type { FormFieldNotCondition } from '../models/FormFieldNotCondition';
|
|
17
|
+
import type { FormFieldSimpleCondition } from '../models/FormFieldSimpleCondition';
|
|
18
|
+
import type { MapStringObject } from '../models/MapStringObject';
|
|
19
|
+
import type { SortConfigSearchCondition } from '../models/SortConfigSearchCondition';
|
|
20
|
+
import type { SortConfigSearchList } from '../models/SortConfigSearchList';
|
|
21
|
+
import type { SortConfigSort } from '../models/SortConfigSort';
|
|
22
|
+
import type { UnversionedReference } from '../models/UnversionedReference';
|
|
23
|
+
import type { VersionedReference } from '../models/VersionedReference';
|
|
24
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
25
|
+
export declare class CaseService {
|
|
26
|
+
/**
|
|
27
|
+
* Retrieve information on a case
|
|
28
|
+
* @param casePath Path or Id of case
|
|
29
|
+
* @param css Set css
|
|
30
|
+
* @param rootline Set rootline
|
|
31
|
+
* @param views Set views
|
|
32
|
+
* @returns any Retrieve information on a case
|
|
33
|
+
* @throws ApiError
|
|
34
|
+
*/
|
|
35
|
+
static caseInfo(casePath: string, css?: boolean, rootline?: boolean, views?: boolean): CancelablePromise<{
|
|
36
|
+
caseRedirect?: string;
|
|
37
|
+
casetype: {
|
|
38
|
+
cssTemplates?: Array<CasetypeCss>;
|
|
39
|
+
defaultView?: VersionedReference;
|
|
40
|
+
/**
|
|
41
|
+
* the name of the casetype
|
|
42
|
+
*/
|
|
43
|
+
name: string;
|
|
44
|
+
platformCssTemplates?: Array<CasetypeCss>;
|
|
45
|
+
platformTheme?: any;
|
|
46
|
+
views?: Array<any>;
|
|
47
|
+
};
|
|
48
|
+
devParentCase?: UnversionedReference;
|
|
49
|
+
id: CaseReference;
|
|
50
|
+
jumpToCase?: boolean;
|
|
51
|
+
jumpToCase_case?: UnversionedReference;
|
|
52
|
+
jumpToCase_view?: AbstractReference;
|
|
53
|
+
redirectToURL?: string;
|
|
54
|
+
redirectToURL_data?: string;
|
|
55
|
+
redirectToURL_encoding?: string;
|
|
56
|
+
redirectToURL_method?: string;
|
|
57
|
+
reference?: string;
|
|
58
|
+
reloadCaches?: string;
|
|
59
|
+
rootline?: Array<{
|
|
60
|
+
id: CaseReference;
|
|
61
|
+
reference?: string;
|
|
62
|
+
}>;
|
|
63
|
+
submitMessageBody?: string;
|
|
64
|
+
submitMessageButtonText?: string;
|
|
65
|
+
submitMessageStyle?: string;
|
|
66
|
+
userCaseLocale?: string;
|
|
67
|
+
}>;
|
|
68
|
+
/**
|
|
69
|
+
* Retrieve the contents of a dataset, rights are checked via dataset rights
|
|
70
|
+
* @param casePath Path or Id of case
|
|
71
|
+
* @param dataset ID of dataset
|
|
72
|
+
* @param format Format of the result
|
|
73
|
+
* @param requestBody
|
|
74
|
+
* @returns DatasetResult Retrieve the contents of a dataset, rights are checked via dataset rights
|
|
75
|
+
* @throws ApiError
|
|
76
|
+
*/
|
|
77
|
+
static datasetRetrieve(casePath: string, dataset: UnversionedReference, format?: 'simple' | 'full', requestBody?: {
|
|
78
|
+
additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
79
|
+
allowHtmlAlways?: boolean;
|
|
80
|
+
calculateFullCount?: boolean;
|
|
81
|
+
columns?: Array<ColumnId>;
|
|
82
|
+
dataset: AbstractReference;
|
|
83
|
+
doAnalysis?: boolean;
|
|
84
|
+
forceCount?: boolean;
|
|
85
|
+
identifier?: ColumnIdentifier;
|
|
86
|
+
limit?: number;
|
|
87
|
+
search?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
88
|
+
skip?: number;
|
|
89
|
+
sort?: Array<SortConfigSort>;
|
|
90
|
+
unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
91
|
+
unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
92
|
+
}): CancelablePromise<DatasetResult>;
|
|
93
|
+
/**
|
|
94
|
+
* Retrieve the contents of a form, rights are checked via form rights
|
|
95
|
+
* @param casePath Path or Id of case
|
|
96
|
+
* @param formId ID of form
|
|
97
|
+
* @param form Set form
|
|
98
|
+
* @param format Format of the result
|
|
99
|
+
* @returns any Retrieve the contents of a form, rights are checked via form rights
|
|
100
|
+
* @throws ApiError
|
|
101
|
+
*/
|
|
102
|
+
static formRetrieve(casePath: string, formId: UnversionedReference, form?: any, format?: 'simple' | 'extended' | 'full'): CancelablePromise<any>;
|
|
103
|
+
/**
|
|
104
|
+
* Retrieve the contents of a dataset, rights are checked via widget rights
|
|
105
|
+
* @param casePath Path or Id of case
|
|
106
|
+
* @param dataset ID of dataset
|
|
107
|
+
* @param widget ID of widget
|
|
108
|
+
* @param format Format of the result
|
|
109
|
+
* @param requestBody
|
|
110
|
+
* @returns DatasetResult Retrieve the contents of a dataset, rights are checked via widget rights
|
|
111
|
+
* @throws ApiError
|
|
112
|
+
*/
|
|
113
|
+
static datasetRetrieveViaWidget(casePath: string, dataset: UnversionedReference, widget: UnversionedReference, format?: 'simple' | 'full', requestBody?: {
|
|
114
|
+
additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
115
|
+
allowHtmlAlways?: boolean;
|
|
116
|
+
calculateFullCount?: boolean;
|
|
117
|
+
columns?: Array<ColumnId>;
|
|
118
|
+
dataset: AbstractReference;
|
|
119
|
+
doAnalysis?: boolean;
|
|
120
|
+
forceCount?: boolean;
|
|
121
|
+
identifier?: ColumnIdentifier;
|
|
122
|
+
limit?: number;
|
|
123
|
+
search?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
124
|
+
skip?: number;
|
|
125
|
+
sort?: Array<SortConfigSort>;
|
|
126
|
+
unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
127
|
+
unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
128
|
+
widget: AbstractReference;
|
|
129
|
+
widgetCaseid?: CaseReference;
|
|
130
|
+
}): CancelablePromise<DatasetResult>;
|
|
131
|
+
/**
|
|
132
|
+
* Submit (create and submit) an activity based on the activity ID and filled in fields
|
|
133
|
+
* @param casePath Path or Id of case
|
|
134
|
+
* @param activity ID of activity
|
|
135
|
+
* @param requestBody
|
|
136
|
+
* @returns any Submit (create and submit) an activity based on the activity ID and filled in fields
|
|
137
|
+
* @throws ApiError
|
|
138
|
+
*/
|
|
139
|
+
static activityDirectSubmit(casePath: string, activity: UnversionedReference, requestBody?: Record<string, any>): CancelablePromise<{
|
|
140
|
+
createdCase?: CaseReference;
|
|
141
|
+
jumpToCase?: boolean;
|
|
142
|
+
jumpToCase_case?: UnversionedReference;
|
|
143
|
+
jumpToCase_view?: AbstractReference;
|
|
144
|
+
redirectToURL?: string;
|
|
145
|
+
redirectToURL_data?: string;
|
|
146
|
+
redirectToURL_encoding?: string;
|
|
147
|
+
redirectToURL_method?: string;
|
|
148
|
+
reloadCaches?: string;
|
|
149
|
+
returnResult?: MapStringObject;
|
|
150
|
+
status?: string;
|
|
151
|
+
submitMessageBody?: string;
|
|
152
|
+
submitMessageButtonText?: string;
|
|
153
|
+
submitMessageStyle?: string;
|
|
154
|
+
}>;
|
|
155
|
+
/**
|
|
156
|
+
* Create a new optional task based on an activity ID
|
|
157
|
+
* @param casePath Path or Id of case
|
|
158
|
+
* @param activity ID of activity
|
|
159
|
+
* @param format Format of the result
|
|
160
|
+
* @param requestBody
|
|
161
|
+
* @returns any Create a new optional task based on an activity ID
|
|
162
|
+
* @throws ApiError
|
|
163
|
+
*/
|
|
164
|
+
static taskCreate(casePath: string, activity: UnversionedReference, format?: 'simple' | 'full', requestBody?: ({
|
|
165
|
+
activity: AbstractReference;
|
|
166
|
+
autoProgress?: boolean;
|
|
167
|
+
skipCheckRights?: boolean;
|
|
168
|
+
type: 'optional';
|
|
169
|
+
} | {
|
|
170
|
+
activityTag: string;
|
|
171
|
+
autoProgress?: boolean;
|
|
172
|
+
skipCheckRights?: boolean;
|
|
173
|
+
type: 'optionalByTag';
|
|
174
|
+
} | {
|
|
175
|
+
autoProgress?: boolean;
|
|
176
|
+
skipCheckRights?: boolean;
|
|
177
|
+
task?: number;
|
|
178
|
+
type: 'mandatory' | 'required';
|
|
179
|
+
})): CancelablePromise<{
|
|
180
|
+
activity?: Activity;
|
|
181
|
+
form?: any;
|
|
182
|
+
formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
|
|
183
|
+
name?: string;
|
|
184
|
+
parentCase?: UnversionedReference;
|
|
185
|
+
startActivity?: Activity;
|
|
186
|
+
task?: number;
|
|
187
|
+
}>;
|
|
188
|
+
/**
|
|
189
|
+
* Retrieve an existing task based on the task ID
|
|
190
|
+
* @param casePath Path or Id of case
|
|
191
|
+
* @param task ID of task
|
|
192
|
+
* @param format Format of the result
|
|
193
|
+
* @returns any Retrieve an existing task based on the task ID
|
|
194
|
+
* @throws ApiError
|
|
195
|
+
*/
|
|
196
|
+
static taskInfo(casePath: string, task: number, format?: 'simple' | 'full'): CancelablePromise<{
|
|
197
|
+
activity?: Activity;
|
|
198
|
+
form?: any;
|
|
199
|
+
formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
|
|
200
|
+
name?: string;
|
|
201
|
+
parentCase?: UnversionedReference;
|
|
202
|
+
startActivity?: Activity;
|
|
203
|
+
task?: number;
|
|
204
|
+
}>;
|
|
205
|
+
/**
|
|
206
|
+
* Submit an existing task based on the task ID and filled in fields
|
|
207
|
+
* @param casePath Path or Id of case
|
|
208
|
+
* @param task ID of task
|
|
209
|
+
* @param requestBody
|
|
210
|
+
* @returns any Submit an existing task based on the task ID and filled in fields
|
|
211
|
+
* @throws ApiError
|
|
212
|
+
*/
|
|
213
|
+
static taskSubmit(casePath: string, task: number, requestBody?: ({
|
|
214
|
+
activity: AbstractReference;
|
|
215
|
+
autoProgress?: boolean;
|
|
216
|
+
fields?: MapStringObject;
|
|
217
|
+
returnResult?: boolean;
|
|
218
|
+
skipCheckRights?: boolean;
|
|
219
|
+
type?: 'optional';
|
|
220
|
+
} | {
|
|
221
|
+
autoProgress?: boolean;
|
|
222
|
+
fields?: Array<{
|
|
223
|
+
/**
|
|
224
|
+
* Only allowed in the studio's.
|
|
225
|
+
*/
|
|
226
|
+
devref?: string;
|
|
227
|
+
/**
|
|
228
|
+
* The external reference.
|
|
229
|
+
*/
|
|
230
|
+
externalReference?: string;
|
|
231
|
+
id?: AbstractReference;
|
|
232
|
+
/**
|
|
233
|
+
* Not used in the backend side
|
|
234
|
+
*/
|
|
235
|
+
name?: string;
|
|
236
|
+
value?: any;
|
|
237
|
+
}>;
|
|
238
|
+
returnResult?: boolean;
|
|
239
|
+
skipCheckRights?: boolean;
|
|
240
|
+
task?: number;
|
|
241
|
+
type?: 'task-array';
|
|
242
|
+
} | {
|
|
243
|
+
autoProgress?: boolean;
|
|
244
|
+
fields?: MapStringObject;
|
|
245
|
+
returnResult?: boolean;
|
|
246
|
+
skipCheckRights?: boolean;
|
|
247
|
+
task?: number;
|
|
248
|
+
type?: 'task-json';
|
|
249
|
+
})): CancelablePromise<{
|
|
250
|
+
createdCase?: CaseReference;
|
|
251
|
+
jumpToCase?: boolean;
|
|
252
|
+
jumpToCase_case?: UnversionedReference;
|
|
253
|
+
jumpToCase_view?: AbstractReference;
|
|
254
|
+
redirectToURL?: string;
|
|
255
|
+
redirectToURL_data?: string;
|
|
256
|
+
redirectToURL_encoding?: string;
|
|
257
|
+
redirectToURL_method?: string;
|
|
258
|
+
reloadCaches?: string;
|
|
259
|
+
returnResult?: MapStringObject;
|
|
260
|
+
status?: string;
|
|
261
|
+
submitMessageBody?: string;
|
|
262
|
+
submitMessageButtonText?: string;
|
|
263
|
+
submitMessageStyle?: string;
|
|
264
|
+
}>;
|
|
265
|
+
/**
|
|
266
|
+
* @deprecated
|
|
267
|
+
* Retrieve information on a case
|
|
268
|
+
* @param caseId ID of case
|
|
269
|
+
* @param css Set css
|
|
270
|
+
* @param rootline Set rootline
|
|
271
|
+
* @param views Set views
|
|
272
|
+
* @returns any Retrieve information on a case
|
|
273
|
+
* @throws ApiError
|
|
274
|
+
*/
|
|
275
|
+
static caseView(caseId: UnversionedReference, css?: boolean, rootline?: boolean, views?: boolean): CancelablePromise<{
|
|
276
|
+
caseRedirect?: string;
|
|
277
|
+
casetype: {
|
|
278
|
+
cssTemplates?: Array<CasetypeCss>;
|
|
279
|
+
defaultView?: VersionedReference;
|
|
280
|
+
/**
|
|
281
|
+
* the name of the casetype
|
|
282
|
+
*/
|
|
283
|
+
name: string;
|
|
284
|
+
platformCssTemplates?: Array<CasetypeCss>;
|
|
285
|
+
platformTheme?: any;
|
|
286
|
+
views?: Array<any>;
|
|
287
|
+
};
|
|
288
|
+
devParentCase?: UnversionedReference;
|
|
289
|
+
id: CaseReference;
|
|
290
|
+
jumpToCase?: boolean;
|
|
291
|
+
jumpToCase_case?: UnversionedReference;
|
|
292
|
+
jumpToCase_view?: AbstractReference;
|
|
293
|
+
redirectToURL?: string;
|
|
294
|
+
redirectToURL_data?: string;
|
|
295
|
+
redirectToURL_encoding?: string;
|
|
296
|
+
redirectToURL_method?: string;
|
|
297
|
+
reference?: string;
|
|
298
|
+
reloadCaches?: string;
|
|
299
|
+
rootline?: Array<{
|
|
300
|
+
id: CaseReference;
|
|
301
|
+
reference?: string;
|
|
302
|
+
}>;
|
|
303
|
+
submitMessageBody?: string;
|
|
304
|
+
submitMessageButtonText?: string;
|
|
305
|
+
submitMessageStyle?: string;
|
|
306
|
+
userCaseLocale?: string;
|
|
307
|
+
}>;
|
|
308
|
+
/**
|
|
309
|
+
* @deprecated
|
|
310
|
+
* Retrieve the contents of a dataset, rights are checked via dataset rights
|
|
311
|
+
* @param caseId ID of case
|
|
312
|
+
* @param dataset ID of dataset
|
|
313
|
+
* @param format Format of the result
|
|
314
|
+
* @param requestBody
|
|
315
|
+
* @returns DatasetResult Retrieve the contents of a dataset, rights are checked via dataset rights
|
|
316
|
+
* @throws ApiError
|
|
317
|
+
*/
|
|
318
|
+
static datasetGet(caseId: UnversionedReference, dataset: UnversionedReference, format?: 'simple' | 'full', requestBody?: {
|
|
319
|
+
additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
320
|
+
allowHtmlAlways?: boolean;
|
|
321
|
+
calculateFullCount?: boolean;
|
|
322
|
+
columns?: Array<ColumnId>;
|
|
323
|
+
dataset: AbstractReference;
|
|
324
|
+
doAnalysis?: boolean;
|
|
325
|
+
forceCount?: boolean;
|
|
326
|
+
identifier?: ColumnIdentifier;
|
|
327
|
+
limit?: number;
|
|
328
|
+
search?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
329
|
+
skip?: number;
|
|
330
|
+
sort?: Array<SortConfigSort>;
|
|
331
|
+
unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
332
|
+
unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
333
|
+
}): CancelablePromise<DatasetResult>;
|
|
334
|
+
/**
|
|
335
|
+
* @deprecated
|
|
336
|
+
* Retrieve the contents of a form, rights are checked via form rights
|
|
337
|
+
* @param caseId ID of case
|
|
338
|
+
* @param formId ID of form
|
|
339
|
+
* @param form Set form
|
|
340
|
+
* @param format Format of the result
|
|
341
|
+
* @returns any Retrieve the contents of a form, rights are checked via form rights
|
|
342
|
+
* @throws ApiError
|
|
343
|
+
*/
|
|
344
|
+
static formGet(caseId: UnversionedReference, formId: UnversionedReference, form?: any, format?: 'simple' | 'extended' | 'full'): CancelablePromise<any>;
|
|
345
|
+
/**
|
|
346
|
+
* @deprecated
|
|
347
|
+
* Retrieve the contents of a dataset, rights are checked via widget rights
|
|
348
|
+
* @param caseId ID of case
|
|
349
|
+
* @param dataset ID of dataset
|
|
350
|
+
* @param widget ID of widget
|
|
351
|
+
* @param format Format of the result
|
|
352
|
+
* @param requestBody
|
|
353
|
+
* @returns DatasetResult Retrieve the contents of a dataset, rights are checked via widget rights
|
|
354
|
+
* @throws ApiError
|
|
355
|
+
*/
|
|
356
|
+
static datasetGetViaWidget(caseId: UnversionedReference, dataset: UnversionedReference, widget: UnversionedReference, format?: 'simple' | 'full', requestBody?: {
|
|
357
|
+
additionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
358
|
+
allowHtmlAlways?: boolean;
|
|
359
|
+
calculateFullCount?: boolean;
|
|
360
|
+
columns?: Array<ColumnId>;
|
|
361
|
+
dataset: AbstractReference;
|
|
362
|
+
doAnalysis?: boolean;
|
|
363
|
+
forceCount?: boolean;
|
|
364
|
+
identifier?: ColumnIdentifier;
|
|
365
|
+
limit?: number;
|
|
366
|
+
search?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
367
|
+
skip?: number;
|
|
368
|
+
sort?: Array<SortConfigSort>;
|
|
369
|
+
unAggregatedAdditionalColumns?: Array<(AdditionalTemplateColumn | AdditionalMetaColumn | AdditionalAggregateColumn | AdditionalGroupbyColumn | AdditionalDataHistoryColumn | AdditionalExternalColumn | AdditionalDerivedColumn)>;
|
|
370
|
+
unAggregatedSearch?: (SortConfigSearchList | SortConfigSearchCondition);
|
|
371
|
+
widget: AbstractReference;
|
|
372
|
+
widgetCaseid?: CaseReference;
|
|
373
|
+
}): CancelablePromise<DatasetResult>;
|
|
374
|
+
/**
|
|
375
|
+
* @deprecated
|
|
376
|
+
* Submit (create and submit) an activity based on the activity ID and filled in fields
|
|
377
|
+
* @param caseId ID of case
|
|
378
|
+
* @param activity ID of activity
|
|
379
|
+
* @param requestBody
|
|
380
|
+
* @returns any Submit (create and submit) an activity based on the activity ID and filled in fields
|
|
381
|
+
* @throws ApiError
|
|
382
|
+
*/
|
|
383
|
+
static activitySubmit(caseId: UnversionedReference, activity: UnversionedReference, requestBody?: Record<string, any>): CancelablePromise<{
|
|
384
|
+
createdCase?: CaseReference;
|
|
385
|
+
jumpToCase?: boolean;
|
|
386
|
+
jumpToCase_case?: UnversionedReference;
|
|
387
|
+
jumpToCase_view?: AbstractReference;
|
|
388
|
+
redirectToURL?: string;
|
|
389
|
+
redirectToURL_data?: string;
|
|
390
|
+
redirectToURL_encoding?: string;
|
|
391
|
+
redirectToURL_method?: string;
|
|
392
|
+
reloadCaches?: string;
|
|
393
|
+
returnResult?: MapStringObject;
|
|
394
|
+
status?: string;
|
|
395
|
+
submitMessageBody?: string;
|
|
396
|
+
submitMessageButtonText?: string;
|
|
397
|
+
submitMessageStyle?: string;
|
|
398
|
+
}>;
|
|
399
|
+
/**
|
|
400
|
+
* @deprecated
|
|
401
|
+
* Create a new optional task based on an activity ID
|
|
402
|
+
* @param caseId ID of case
|
|
403
|
+
* @param activity ID of activity
|
|
404
|
+
* @param format Format of the result
|
|
405
|
+
* @param requestBody
|
|
406
|
+
* @returns any Create a new optional task based on an activity ID
|
|
407
|
+
* @throws ApiError
|
|
408
|
+
*/
|
|
409
|
+
static caseTaskCreate(caseId: UnversionedReference, activity: UnversionedReference, format?: 'simple' | 'full', requestBody?: ({
|
|
410
|
+
activity: AbstractReference;
|
|
411
|
+
autoProgress?: boolean;
|
|
412
|
+
skipCheckRights?: boolean;
|
|
413
|
+
type: 'optional';
|
|
414
|
+
} | {
|
|
415
|
+
activityTag: string;
|
|
416
|
+
autoProgress?: boolean;
|
|
417
|
+
skipCheckRights?: boolean;
|
|
418
|
+
type: 'optionalByTag';
|
|
419
|
+
} | {
|
|
420
|
+
autoProgress?: boolean;
|
|
421
|
+
skipCheckRights?: boolean;
|
|
422
|
+
task?: number;
|
|
423
|
+
type: 'mandatory' | 'required';
|
|
424
|
+
})): CancelablePromise<{
|
|
425
|
+
activity?: Activity;
|
|
426
|
+
form?: any;
|
|
427
|
+
formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
|
|
428
|
+
name?: string;
|
|
429
|
+
parentCase?: UnversionedReference;
|
|
430
|
+
startActivity?: Activity;
|
|
431
|
+
task?: number;
|
|
432
|
+
}>;
|
|
433
|
+
/**
|
|
434
|
+
* @deprecated
|
|
435
|
+
* Retrieve an existing task based on the task ID
|
|
436
|
+
* @param caseId ID of case
|
|
437
|
+
* @param task ID of task
|
|
438
|
+
* @param format Format of the result
|
|
439
|
+
* @returns any Retrieve an existing task based on the task ID
|
|
440
|
+
* @throws ApiError
|
|
441
|
+
*/
|
|
442
|
+
static caseTaskGet(caseId: UnversionedReference, task: number, format?: 'simple' | 'full'): CancelablePromise<{
|
|
443
|
+
activity?: Activity;
|
|
444
|
+
form?: any;
|
|
445
|
+
formCondition?: (FormFieldConditionList | FormFieldSimpleCondition | FormFieldNotCondition);
|
|
446
|
+
name?: string;
|
|
447
|
+
parentCase?: UnversionedReference;
|
|
448
|
+
startActivity?: Activity;
|
|
449
|
+
task?: number;
|
|
450
|
+
}>;
|
|
451
|
+
/**
|
|
452
|
+
* @deprecated
|
|
453
|
+
* Submit an existing task based on the task ID and filled in fields
|
|
454
|
+
* @param caseId ID of case
|
|
455
|
+
* @param task ID of task
|
|
456
|
+
* @param requestBody
|
|
457
|
+
* @returns any Submit an existing task based on the task ID and filled in fields
|
|
458
|
+
* @throws ApiError
|
|
459
|
+
*/
|
|
460
|
+
static caseTaskSubmit(caseId: UnversionedReference, task: number, requestBody?: ({
|
|
461
|
+
activity: AbstractReference;
|
|
462
|
+
autoProgress?: boolean;
|
|
463
|
+
fields?: MapStringObject;
|
|
464
|
+
returnResult?: boolean;
|
|
465
|
+
skipCheckRights?: boolean;
|
|
466
|
+
type?: 'optional';
|
|
467
|
+
} | {
|
|
468
|
+
autoProgress?: boolean;
|
|
469
|
+
fields?: Array<{
|
|
470
|
+
/**
|
|
471
|
+
* Only allowed in the studio's.
|
|
472
|
+
*/
|
|
473
|
+
devref?: string;
|
|
474
|
+
/**
|
|
475
|
+
* The external reference.
|
|
476
|
+
*/
|
|
477
|
+
externalReference?: string;
|
|
478
|
+
id?: AbstractReference;
|
|
479
|
+
/**
|
|
480
|
+
* Not used in the backend side
|
|
481
|
+
*/
|
|
482
|
+
name?: string;
|
|
483
|
+
value?: any;
|
|
484
|
+
}>;
|
|
485
|
+
returnResult?: boolean;
|
|
486
|
+
skipCheckRights?: boolean;
|
|
487
|
+
task?: number;
|
|
488
|
+
type?: 'task-array';
|
|
489
|
+
} | {
|
|
490
|
+
autoProgress?: boolean;
|
|
491
|
+
fields?: MapStringObject;
|
|
492
|
+
returnResult?: boolean;
|
|
493
|
+
skipCheckRights?: boolean;
|
|
494
|
+
task?: number;
|
|
495
|
+
type?: 'task-json';
|
|
496
|
+
})): CancelablePromise<{
|
|
497
|
+
createdCase?: CaseReference;
|
|
498
|
+
jumpToCase?: boolean;
|
|
499
|
+
jumpToCase_case?: UnversionedReference;
|
|
500
|
+
jumpToCase_view?: AbstractReference;
|
|
501
|
+
redirectToURL?: string;
|
|
502
|
+
redirectToURL_data?: string;
|
|
503
|
+
redirectToURL_encoding?: string;
|
|
504
|
+
redirectToURL_method?: string;
|
|
505
|
+
reloadCaches?: string;
|
|
506
|
+
returnResult?: MapStringObject;
|
|
507
|
+
status?: string;
|
|
508
|
+
submitMessageBody?: string;
|
|
509
|
+
submitMessageButtonText?: string;
|
|
510
|
+
submitMessageStyle?: string;
|
|
511
|
+
}>;
|
|
512
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Instant } from '../models/Instant';
|
|
2
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
3
|
+
export declare class PlatformService {
|
|
4
|
+
/**
|
|
5
|
+
* Get version, compile and reload information
|
|
6
|
+
* @returns any Get version, compile and reload information
|
|
7
|
+
* @throws ApiError
|
|
8
|
+
*/
|
|
9
|
+
static platformVersion(): CancelablePromise<{
|
|
10
|
+
definitionHash?: string;
|
|
11
|
+
releaseRing?: string;
|
|
12
|
+
reloadTime?: Instant;
|
|
13
|
+
version?: string;
|
|
14
|
+
}>;
|
|
15
|
+
}
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "grexx-api",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "",
|
|
5
|
-
"main": "
|
|
6
|
-
"types": "
|
|
5
|
+
"main": "dist/generated/index.js",
|
|
6
|
+
"types": "dist/generated/index.d.ts",
|
|
7
7
|
"scripts": {
|
|
8
8
|
"build": "tsc",
|
|
9
9
|
"generate": "openapi-typescript-codegen --input openapi.yaml --output ./src/generated"
|
|
@@ -11,5 +11,8 @@
|
|
|
11
11
|
"devDependencies": {
|
|
12
12
|
"openapi-typescript-codegen": "^0.29.0",
|
|
13
13
|
"typescript": "4.9.5"
|
|
14
|
+
},
|
|
15
|
+
"dependencies": {
|
|
16
|
+
"grexx-api": "^1.0.0"
|
|
14
17
|
}
|
|
15
18
|
}
|