cityworks 1.0.6 → 2.1.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.
- package/README.md +9 -2
- package/dist/activity_link.d.ts +84 -84
- package/dist/attachments.d.ts +134 -75
- package/dist/briefcase.d.ts +274 -241
- package/dist/case_admin.d.ts +349 -349
- package/dist/case_assets.d.ts +89 -89
- package/dist/case_data.d.ts +214 -213
- package/dist/case_financial.d.ts +406 -348
- package/dist/case_people.d.ts +79 -0
- package/dist/case_workflow.d.ts +187 -187
- package/dist/comments.d.ts +53 -53
- package/dist/error.d.ts +57 -57
- package/dist/general.d.ts +78 -78
- package/dist/gis.d.ts +92 -92
- package/dist/index.d.ts +231 -224
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.m.js +1 -1
- package/dist/index.m.js.map +1 -1
- package/dist/index.modern.mjs +1 -1
- package/dist/index.modern.mjs.map +1 -1
- package/dist/index.umd.js +1 -1
- package/dist/index.umd.js.map +1 -1
- package/dist/inspection.d.ts +354 -349
- package/dist/inspection_admin.d.ts +25 -25
- package/dist/inspection_costs.d.ts +86 -86
- package/dist/message_queue.d.ts +73 -73
- package/dist/query.d.ts +108 -108
- package/dist/report.d.ts +28 -0
- package/dist/request.d.ts +369 -372
- package/dist/request_admin.d.ts +18 -18
- package/dist/request_costs.d.ts +54 -54
- package/dist/search.d.ts +138 -138
- package/dist/workorder.d.ts +333 -328
- package/dist/workorder_admin.d.ts +111 -111
- package/dist/workorder_costs.d.ts +113 -113
- package/package.json +12 -12
package/dist/case_assets.d.ts
CHANGED
|
@@ -1,89 +1,89 @@
|
|
|
1
|
-
export declare class CaseAssets {
|
|
2
|
-
/**
|
|
3
|
-
* @hidden
|
|
4
|
-
*/
|
|
5
|
-
cw: any;
|
|
6
|
-
/**
|
|
7
|
-
* @hidden
|
|
8
|
-
*/
|
|
9
|
-
constructor(cw: any);
|
|
10
|
-
/**
|
|
11
|
-
* Attach asset to case
|
|
12
|
-
*
|
|
13
|
-
* @category Case Assets
|
|
14
|
-
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
15
|
-
* @param {boolean} updateXY - Whether or not to update the Case's X/Y values when attaching the asset. Defaults to true.
|
|
16
|
-
* @param {Object} [options] - Options for CaseDataGroup including Address, AddressId, AssetId, AssetObjectId, AssetType, CityName, CrossStreet, DateExpired, ExpiredFlag, Facility_Id, FeatureAssetId, FeatureClass, FeatureObjectId, LegacyId, Level_Id, LndObjectId, Location, MasterFlag, ObjectId, StateCode, StreetDirection, StreetFraction, StreetName, StreetNumber, StreetPostDir, StreetType, Suite, TileNo, UpdateCaseData, XCoord, YCoord, ZCoord, and ZipCode
|
|
17
|
-
* @return {Object} Returns Promise that represents an object describing CaAddress.
|
|
18
|
-
* // {"AddressId":OBJECTID,"AssetId":"GUID","AssetType":"ASSET_NAME","CaObjectId":CA_OBJECTID,"FeatureAssetId":"GUID","FeatureClass":"ASSET_NAME","FeatureObjectId":OBJECTID,"Location":"Address string","ObjectId":"OBJECTID","XCoord":,"YCoord":,"UpdateCaseData":false}
|
|
19
|
-
*/
|
|
20
|
-
attach(caObjectId: number, updateXY?: boolean, options?: {
|
|
21
|
-
Address?: string;
|
|
22
|
-
AddressId?: number;
|
|
23
|
-
AssetId?: string;
|
|
24
|
-
AssetObjectId?: number;
|
|
25
|
-
AssetType?: string;
|
|
26
|
-
CityName?: string;
|
|
27
|
-
CrossStreet?: string;
|
|
28
|
-
DateExpired?: string;
|
|
29
|
-
ExpiredFlag?: string;
|
|
30
|
-
Facility_Id?: string;
|
|
31
|
-
FeatureAssetId?: string;
|
|
32
|
-
FeatureClass?: string;
|
|
33
|
-
FeatureObjectId?: number;
|
|
34
|
-
LegacyId?: string;
|
|
35
|
-
Level_Id?: string;
|
|
36
|
-
LndObjectId?: number;
|
|
37
|
-
Location?: string;
|
|
38
|
-
MasterFlag?: string;
|
|
39
|
-
ObjectId?: string;
|
|
40
|
-
StateCode?: string;
|
|
41
|
-
StreetDirection?: string;
|
|
42
|
-
StreetFraction?: string;
|
|
43
|
-
StreetName?: string;
|
|
44
|
-
StreetNumber?: number;
|
|
45
|
-
StreetPostDir?: string;
|
|
46
|
-
StreetType?: string;
|
|
47
|
-
Suite?: string;
|
|
48
|
-
TileNo?: string;
|
|
49
|
-
UpdateCaseData?: boolean;
|
|
50
|
-
XCoord?: number;
|
|
51
|
-
YCoord?: number;
|
|
52
|
-
ZCoord?: number;
|
|
53
|
-
ZipCode?: string;
|
|
54
|
-
}): Promise<unknown>;
|
|
55
|
-
/**
|
|
56
|
-
* Detach specific asset from case
|
|
57
|
-
*
|
|
58
|
-
* @category Case Assets
|
|
59
|
-
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
60
|
-
* @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the assets. Defaults to true.
|
|
61
|
-
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
62
|
-
*/
|
|
63
|
-
detach(caAddressId: number, updateXY?: boolean): Promise<unknown>;
|
|
64
|
-
/**
|
|
65
|
-
* Detach all assets from case
|
|
66
|
-
*
|
|
67
|
-
* @category Case Assets
|
|
68
|
-
* @param {number} caObjectId - The Case Object to detach the assets from.
|
|
69
|
-
* @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the asset(s). Defaults to false.
|
|
70
|
-
* @return {Object} Returns Promise that represents a collection of detached CaAddressIds.
|
|
71
|
-
*/
|
|
72
|
-
detachAll(caObjectId: number, updateXY?: boolean): Promise<unknown>;
|
|
73
|
-
/**
|
|
74
|
-
* Get assets attached to a specific case
|
|
75
|
-
*
|
|
76
|
-
* @category Case Assets
|
|
77
|
-
* @param {number} caObjectId - The Case Object from which to get attached assets
|
|
78
|
-
* @return {Object} Returns Promise that represents a collection of the default CaAddresses.
|
|
79
|
-
*/
|
|
80
|
-
getForCase(caObjectId: number): Promise<unknown>;
|
|
81
|
-
/**
|
|
82
|
-
* Search for Case Assets. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
83
|
-
*
|
|
84
|
-
* @category Case Assets
|
|
85
|
-
* @param {Object} filters - The parameters to search by. (AssetType, CaAddressId, CaObjectId, CityName, ExpiredFlag, StateCode, StateName, StreetName, StreetNumber, Suite, ZipCode)
|
|
86
|
-
* @return {Object} Returns Promise that represents an Array of resulting CaAddresses
|
|
87
|
-
*/
|
|
88
|
-
search(filters?: Object): Promise<unknown>;
|
|
89
|
-
}
|
|
1
|
+
export declare class CaseAssets {
|
|
2
|
+
/**
|
|
3
|
+
* @hidden
|
|
4
|
+
*/
|
|
5
|
+
cw: any;
|
|
6
|
+
/**
|
|
7
|
+
* @hidden
|
|
8
|
+
*/
|
|
9
|
+
constructor(cw: any);
|
|
10
|
+
/**
|
|
11
|
+
* Attach asset to case
|
|
12
|
+
*
|
|
13
|
+
* @category Case Assets
|
|
14
|
+
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
15
|
+
* @param {boolean} updateXY - Whether or not to update the Case's X/Y values when attaching the asset. Defaults to true.
|
|
16
|
+
* @param {Object} [options] - Options for CaseDataGroup including Address, AddressId, AssetId, AssetObjectId, AssetType, CityName, CrossStreet, DateExpired, ExpiredFlag, Facility_Id, FeatureAssetId, FeatureClass, FeatureObjectId, LegacyId, Level_Id, LndObjectId, Location, MasterFlag, ObjectId, StateCode, StreetDirection, StreetFraction, StreetName, StreetNumber, StreetPostDir, StreetType, Suite, TileNo, UpdateCaseData, XCoord, YCoord, ZCoord, and ZipCode
|
|
17
|
+
* @return {Object} Returns Promise that represents an object describing CaAddress.
|
|
18
|
+
* // {"AddressId":OBJECTID,"AssetId":"GUID","AssetType":"ASSET_NAME","CaObjectId":CA_OBJECTID,"FeatureAssetId":"GUID","FeatureClass":"ASSET_NAME","FeatureObjectId":OBJECTID,"Location":"Address string","ObjectId":"OBJECTID","XCoord":,"YCoord":,"UpdateCaseData":false}
|
|
19
|
+
*/
|
|
20
|
+
attach(caObjectId: number, updateXY?: boolean, options?: {
|
|
21
|
+
Address?: string;
|
|
22
|
+
AddressId?: number;
|
|
23
|
+
AssetId?: string;
|
|
24
|
+
AssetObjectId?: number;
|
|
25
|
+
AssetType?: string;
|
|
26
|
+
CityName?: string;
|
|
27
|
+
CrossStreet?: string;
|
|
28
|
+
DateExpired?: string;
|
|
29
|
+
ExpiredFlag?: string;
|
|
30
|
+
Facility_Id?: string;
|
|
31
|
+
FeatureAssetId?: string;
|
|
32
|
+
FeatureClass?: string;
|
|
33
|
+
FeatureObjectId?: number;
|
|
34
|
+
LegacyId?: string;
|
|
35
|
+
Level_Id?: string;
|
|
36
|
+
LndObjectId?: number;
|
|
37
|
+
Location?: string;
|
|
38
|
+
MasterFlag?: string;
|
|
39
|
+
ObjectId?: string;
|
|
40
|
+
StateCode?: string;
|
|
41
|
+
StreetDirection?: string;
|
|
42
|
+
StreetFraction?: string;
|
|
43
|
+
StreetName?: string;
|
|
44
|
+
StreetNumber?: number;
|
|
45
|
+
StreetPostDir?: string;
|
|
46
|
+
StreetType?: string;
|
|
47
|
+
Suite?: string;
|
|
48
|
+
TileNo?: string;
|
|
49
|
+
UpdateCaseData?: boolean;
|
|
50
|
+
XCoord?: number;
|
|
51
|
+
YCoord?: number;
|
|
52
|
+
ZCoord?: number;
|
|
53
|
+
ZipCode?: string;
|
|
54
|
+
}): Promise<unknown>;
|
|
55
|
+
/**
|
|
56
|
+
* Detach specific asset from case
|
|
57
|
+
*
|
|
58
|
+
* @category Case Assets
|
|
59
|
+
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
60
|
+
* @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the assets. Defaults to true.
|
|
61
|
+
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
62
|
+
*/
|
|
63
|
+
detach(caAddressId: number, updateXY?: boolean): Promise<unknown>;
|
|
64
|
+
/**
|
|
65
|
+
* Detach all assets from case
|
|
66
|
+
*
|
|
67
|
+
* @category Case Assets
|
|
68
|
+
* @param {number} caObjectId - The Case Object to detach the assets from.
|
|
69
|
+
* @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the asset(s). Defaults to false.
|
|
70
|
+
* @return {Object} Returns Promise that represents a collection of detached CaAddressIds.
|
|
71
|
+
*/
|
|
72
|
+
detachAll(caObjectId: number, updateXY?: boolean): Promise<unknown>;
|
|
73
|
+
/**
|
|
74
|
+
* Get assets attached to a specific case
|
|
75
|
+
*
|
|
76
|
+
* @category Case Assets
|
|
77
|
+
* @param {number} caObjectId - The Case Object from which to get attached assets
|
|
78
|
+
* @return {Object} Returns Promise that represents a collection of the default CaAddresses.
|
|
79
|
+
*/
|
|
80
|
+
getForCase(caObjectId: number): Promise<unknown>;
|
|
81
|
+
/**
|
|
82
|
+
* Search for Case Assets. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
83
|
+
*
|
|
84
|
+
* @category Case Assets
|
|
85
|
+
* @param {Object} filters - The parameters to search by. (AssetType, CaAddressId, CaObjectId, CityName, ExpiredFlag, StateCode, StateName, StreetName, StreetNumber, Suite, ZipCode)
|
|
86
|
+
* @return {Object} Returns Promise that represents an Array of resulting CaAddresses
|
|
87
|
+
*/
|
|
88
|
+
search(filters?: Object): Promise<unknown>;
|
|
89
|
+
}
|
package/dist/case_data.d.ts
CHANGED
|
@@ -1,213 +1,214 @@
|
|
|
1
|
-
export declare class CaseData {
|
|
2
|
-
/**
|
|
3
|
-
* @hidden
|
|
4
|
-
*/
|
|
5
|
-
cw: any;
|
|
6
|
-
/**
|
|
7
|
-
* @hidden
|
|
8
|
-
*/
|
|
9
|
-
constructor(cw: any);
|
|
10
|
-
/**
|
|
11
|
-
* Add Case Data Group
|
|
12
|
-
*
|
|
13
|
-
* @category Data Groups
|
|
14
|
-
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
15
|
-
* @param {number} caseDataGroupId - CaseDataGroupId as defined in CaseDataGroup admin.
|
|
16
|
-
* @param {string} groupCode - The Group Code.
|
|
17
|
-
* @param {Object} [options] - Options for CaseDataGroup including GroupDesc, GroupSum, and SumFlag
|
|
18
|
-
* @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
|
|
19
|
-
*/
|
|
20
|
-
addGroup(caObjectId: number, caseDataGroupId: number, groupCode: string, options?: {
|
|
21
|
-
GroupDesc?: string;
|
|
22
|
-
GroupSum?: number;
|
|
23
|
-
SumFlag?: string;
|
|
24
|
-
}): Promise<unknown>;
|
|
25
|
-
/**
|
|
26
|
-
* Add Default Case Data Groups
|
|
27
|
-
*
|
|
28
|
-
* @category Data Groups
|
|
29
|
-
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
30
|
-
* @param {number} busCaseId - The business case ID
|
|
31
|
-
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
32
|
-
*/
|
|
33
|
-
addDefaultGroups(caObjectId: number, busCaseId: number): Promise<unknown>;
|
|
34
|
-
/**
|
|
35
|
-
* Adds a data detail entry to the case data group specified by the CaDataGroupId. The CaDataGroupId is associated to a case.
|
|
36
|
-
*
|
|
37
|
-
* @category Data Groups
|
|
38
|
-
* @param {number} caseDataDetailId - The Data Detail template ID
|
|
39
|
-
* @param {number} caDataGroupId - The Case Instance Data Group ID
|
|
40
|
-
* @param {string} columnSequence - The column sequence
|
|
41
|
-
* @param {string} detailCode - The detail Code
|
|
42
|
-
* @param {number} detailSequence - The detail order number
|
|
43
|
-
* @param {Object} [options] - Other options for CaseDataDetail. See WIPAdd here: /{subdirectory}/apidocs/#/service-info/Pll/CaseDataDetail
|
|
44
|
-
* @return {Object} Returns Promise that represents an object describing CaDataDetailItemBase.
|
|
45
|
-
*/
|
|
46
|
-
wipAddDetail(caseDataDetailId: number, caDataGroupId: number, columnSequence: string, detailCode: string, detailSequence: number, options?: Object): Promise<unknown>;
|
|
47
|
-
/**
|
|
48
|
-
* Get groups by CaObjectId
|
|
49
|
-
*
|
|
50
|
-
* @category Data Groups
|
|
51
|
-
* @param {number} caseId - The Case Object to get the attached data groups.
|
|
52
|
-
* @return {Object} Returns Promise that represents a collection of the CaDataGroupItemBases.
|
|
53
|
-
*/
|
|
54
|
-
getGroupsByCaseId(caseId: number): Promise<unknown>;
|
|
55
|
-
/**
|
|
56
|
-
* Delete Case Data Groups by Case Object ID.
|
|
57
|
-
*
|
|
58
|
-
* @category Data Groups
|
|
59
|
-
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
60
|
-
* @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
|
|
61
|
-
*/
|
|
62
|
-
deleteGroupsByCaseId(caObjectId: number): Promise<unknown>;
|
|
63
|
-
/**
|
|
64
|
-
* Search for Case Data Groups. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
65
|
-
*
|
|
66
|
-
* @category Data Groups
|
|
67
|
-
* @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
|
|
68
|
-
* @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
|
|
69
|
-
*/
|
|
70
|
-
searchForGroups(filters?: Object): Promise<Array<any>>;
|
|
71
|
-
/**
|
|
72
|
-
* Get Case Data Groups by Case ObjectId
|
|
73
|
-
*
|
|
74
|
-
* @category Data Groups
|
|
75
|
-
* @param {string} entityType - The entity type to check
|
|
76
|
-
* @param {string} entityUid - The specific entityUID to check
|
|
77
|
-
* @param {Object} options - The other options for checkGIS. Either CaObjectId or CaseDataGroupId is required.
|
|
78
|
-
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
79
|
-
*/
|
|
80
|
-
checkGIS(entityType: string, entityUid: string, options: {
|
|
81
|
-
CaObjectId?: number;
|
|
82
|
-
CaseDataGroupId?: number;
|
|
83
|
-
CaseDataDetailId?: number;
|
|
84
|
-
}): Promise<unknown>;
|
|
85
|
-
/**
|
|
86
|
-
* Update data groups on a case based on asset value mappings.
|
|
87
|
-
*
|
|
88
|
-
* @category Data Groups
|
|
89
|
-
* @param {number} caObjectId - The case to update
|
|
90
|
-
* @param {string} entityType - The entity type to check
|
|
91
|
-
* @param {string} entityUid - The specific entityUID to check
|
|
92
|
-
* @param {number} [caDataGroupId] - The specific data group ID to limit updates to
|
|
93
|
-
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
94
|
-
*/
|
|
95
|
-
updateGroupsFromAsset(caObjectId: number, entityType: string, entityUid: string, caDataGroupId?: number): Promise<unknown>;
|
|
96
|
-
/**
|
|
97
|
-
* Attach Case Data Detail
|
|
98
|
-
*
|
|
99
|
-
* @category Data Details
|
|
100
|
-
* @param {number} caDataGroupId - The Case Data Group ID to attach the data detail to.
|
|
101
|
-
* @param {number} caseDataDetailId - caseDataDetailId to attach.
|
|
102
|
-
* @param {Object} [options] - Options
|
|
103
|
-
* @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
|
|
104
|
-
*/
|
|
105
|
-
addDetail(caDataGroupId: number, caseDataDetailId: number, options?: Object): Promise<unknown>;
|
|
106
|
-
/**
|
|
107
|
-
* Update Case Data Detail
|
|
108
|
-
*
|
|
109
|
-
* @category Data Details
|
|
110
|
-
* @param {number} caDataDetailId - The Case Data Group ID to attach the data detail to.
|
|
111
|
-
* @param {Object} [options] - Options
|
|
112
|
-
* @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
|
|
113
|
-
*/
|
|
114
|
-
updateDetail(caDataDetailId: number, options?: Object): Promise<unknown>;
|
|
115
|
-
/**
|
|
116
|
-
* Lock Case Data Detail
|
|
117
|
-
*
|
|
118
|
-
* @category Data Details
|
|
119
|
-
* @param {number} caDataDetailId - The Case Data Detail ID to lock
|
|
120
|
-
* @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
|
|
121
|
-
*/
|
|
122
|
-
lockDetail(caDataDetailId: number): Promise<unknown>;
|
|
123
|
-
/**
|
|
124
|
-
* Unlock Case Data Detail
|
|
125
|
-
*
|
|
126
|
-
* @category Data Details
|
|
127
|
-
* @param {number} caDataDetailId - The Case Data Group ID to unlock
|
|
128
|
-
* @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
|
|
129
|
-
*/
|
|
130
|
-
unlockDetail(caDataDetailId: number): Promise<unknown>;
|
|
131
|
-
/**
|
|
132
|
-
* Search for Case Data Details. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
133
|
-
*
|
|
134
|
-
* @category Data Details
|
|
135
|
-
* @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
|
|
136
|
-
* @return {Object} Returns Promise that represents an object describing CaDataDetailItemBase.
|
|
137
|
-
*/
|
|
138
|
-
searchForDetails(filters?: Object): Promise<Array<any>>;
|
|
139
|
-
/**
|
|
140
|
-
* Adds a list of possible values to the data detail entry specified by the CaDataDetailId.
|
|
141
|
-
*
|
|
142
|
-
* @category Data List Values
|
|
143
|
-
* @param {number} caDataDetailId - The Case Object to attach the data group to.
|
|
144
|
-
* @param {string} listValue - The Group Code.
|
|
145
|
-
* @return {Object} Returns Promise that represents an object describing CaDataListValuesItemBase.
|
|
146
|
-
*/
|
|
147
|
-
addListValue(caDataDetailId: number, listValue: string): Promise<unknown>;
|
|
148
|
-
/**
|
|
149
|
-
* Delete by Id (Ca Data List Id)
|
|
150
|
-
*
|
|
151
|
-
* @category Data List Values
|
|
152
|
-
* @param {number} CaDataListId - The Case Data List ID
|
|
153
|
-
* @return {Object} Returns Promise that represents an object describing CaDataListValuesItemBase.
|
|
154
|
-
*/
|
|
155
|
-
deleteListValue(caDataDetailId: number): Promise<unknown>;
|
|
156
|
-
/**
|
|
157
|
-
* Search for List Value IDs. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
158
|
-
*
|
|
159
|
-
* @category Data List Values
|
|
160
|
-
* @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue)
|
|
161
|
-
* @return {Object} Returns Promise that represents an Array of resulting CaDataListIds
|
|
162
|
-
*/
|
|
163
|
-
searchForListValueIds(filters?: Object): Promise<unknown>;
|
|
164
|
-
/**
|
|
165
|
-
* Search for List Value Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
166
|
-
*
|
|
167
|
-
* @category Data List Values
|
|
168
|
-
* @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue, CaDataGroupId)
|
|
169
|
-
* @return {Object} Returns Promise that represents a collection of resulting CaDataListValuesItemBase objects
|
|
170
|
-
*/
|
|
171
|
-
searchForListValueObjects(filters?: Object): Promise<unknown>;
|
|
172
|
-
/**
|
|
173
|
-
* Set a data detail item's value without needing to find the type
|
|
174
|
-
*
|
|
175
|
-
* @category Data Details
|
|
176
|
-
* @param dataDetailId - The data detail item's ID
|
|
177
|
-
* @param {any} value - the value to set the data detail item to
|
|
178
|
-
* @param {number} rate - the rate to set the data detail item to
|
|
179
|
-
* @param {number} quantity - the quantitye to set the data detail item to
|
|
180
|
-
* @returns Promise that represents
|
|
181
|
-
*/
|
|
182
|
-
updateDetailItemValue(dataDetailId: number, value: any, rate?: number, quantity?: number): Promise<unknown>;
|
|
183
|
-
/**
|
|
184
|
-
* Get the Case Data Details for a Case by Case ID
|
|
185
|
-
*
|
|
186
|
-
* @category Data Details
|
|
187
|
-
* @param {number} caseId - The case ID to get the details for
|
|
188
|
-
* @return {Object} Returns Promise that represents a collection of Case Data Detail Items
|
|
189
|
-
*/
|
|
190
|
-
getAllDataDetails(caseId: number): Promise<Array<any>>;
|
|
191
|
-
/**
|
|
192
|
-
* Set Case Data Detail Items for a Case by GroupCode.ItemCode syntax reference
|
|
193
|
-
*
|
|
194
|
-
* @category Data Details
|
|
195
|
-
* @param {number} caseId - The case ID to get the details for
|
|
196
|
-
* @param {Object} items - The parameters to search by. (DataGroup/Item string, Value) (e.g. {code: 'GroupCode.ItemCode', value: 'Value goes here'})
|
|
197
|
-
* @return {Object} Returns Promise that represents a collection
|
|
198
|
-
*/
|
|
199
|
-
setCaseData(caseId: number, items: Array<{
|
|
200
|
-
code: string;
|
|
201
|
-
value: any;
|
|
202
|
-
}>): Promise<unknown>;
|
|
203
|
-
/**
|
|
204
|
-
* Set Case Data Detail Item for a Case by GroupCode.ItemCode syntax reference
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
* @
|
|
208
|
-
* @param {
|
|
209
|
-
* @param {
|
|
210
|
-
* @
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
1
|
+
export declare class CaseData {
|
|
2
|
+
/**
|
|
3
|
+
* @hidden
|
|
4
|
+
*/
|
|
5
|
+
cw: any;
|
|
6
|
+
/**
|
|
7
|
+
* @hidden
|
|
8
|
+
*/
|
|
9
|
+
constructor(cw: any);
|
|
10
|
+
/**
|
|
11
|
+
* Add Case Data Group
|
|
12
|
+
*
|
|
13
|
+
* @category Data Groups
|
|
14
|
+
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
15
|
+
* @param {number} caseDataGroupId - CaseDataGroupId as defined in CaseDataGroup admin.
|
|
16
|
+
* @param {string} groupCode - The Group Code.
|
|
17
|
+
* @param {Object} [options] - Options for CaseDataGroup including GroupDesc, GroupSum, and SumFlag
|
|
18
|
+
* @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
|
|
19
|
+
*/
|
|
20
|
+
addGroup(caObjectId: number, caseDataGroupId: number, groupCode: string, options?: {
|
|
21
|
+
GroupDesc?: string;
|
|
22
|
+
GroupSum?: number;
|
|
23
|
+
SumFlag?: string;
|
|
24
|
+
}): Promise<unknown>;
|
|
25
|
+
/**
|
|
26
|
+
* Add Default Case Data Groups
|
|
27
|
+
*
|
|
28
|
+
* @category Data Groups
|
|
29
|
+
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
30
|
+
* @param {number} busCaseId - The business case ID
|
|
31
|
+
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
32
|
+
*/
|
|
33
|
+
addDefaultGroups(caObjectId: number, busCaseId: number): Promise<unknown>;
|
|
34
|
+
/**
|
|
35
|
+
* Adds a data detail entry to the case data group specified by the CaDataGroupId. The CaDataGroupId is associated to a case.
|
|
36
|
+
*
|
|
37
|
+
* @category Data Groups
|
|
38
|
+
* @param {number} caseDataDetailId - The Data Detail template ID
|
|
39
|
+
* @param {number} caDataGroupId - The Case Instance Data Group ID
|
|
40
|
+
* @param {string} columnSequence - The column sequence
|
|
41
|
+
* @param {string} detailCode - The detail Code
|
|
42
|
+
* @param {number} detailSequence - The detail order number
|
|
43
|
+
* @param {Object} [options] - Other options for CaseDataDetail. See WIPAdd here: /{subdirectory}/apidocs/#/service-info/Pll/CaseDataDetail
|
|
44
|
+
* @return {Object} Returns Promise that represents an object describing CaDataDetailItemBase.
|
|
45
|
+
*/
|
|
46
|
+
wipAddDetail(caseDataDetailId: number, caDataGroupId: number, columnSequence: string, detailCode: string, detailSequence: number, options?: Object): Promise<unknown>;
|
|
47
|
+
/**
|
|
48
|
+
* Get groups by CaObjectId
|
|
49
|
+
*
|
|
50
|
+
* @category Data Groups
|
|
51
|
+
* @param {number} caseId - The Case Object to get the attached data groups.
|
|
52
|
+
* @return {Object} Returns Promise that represents a collection of the CaDataGroupItemBases.
|
|
53
|
+
*/
|
|
54
|
+
getGroupsByCaseId(caseId: number): Promise<unknown>;
|
|
55
|
+
/**
|
|
56
|
+
* Delete Case Data Groups by Case Object ID.
|
|
57
|
+
*
|
|
58
|
+
* @category Data Groups
|
|
59
|
+
* @param {number} caObjectId - The Case Object to attach the data group to.
|
|
60
|
+
* @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
|
|
61
|
+
*/
|
|
62
|
+
deleteGroupsByCaseId(caObjectId: number): Promise<unknown>;
|
|
63
|
+
/**
|
|
64
|
+
* Search for Case Data Groups. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
65
|
+
*
|
|
66
|
+
* @category Data Groups
|
|
67
|
+
* @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
|
|
68
|
+
* @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
|
|
69
|
+
*/
|
|
70
|
+
searchForGroups(filters?: Object): Promise<Array<any>>;
|
|
71
|
+
/**
|
|
72
|
+
* Get Case Data Groups by Case ObjectId
|
|
73
|
+
*
|
|
74
|
+
* @category Data Groups
|
|
75
|
+
* @param {string} entityType - The entity type to check
|
|
76
|
+
* @param {string} entityUid - The specific entityUID to check
|
|
77
|
+
* @param {Object} options - The other options for checkGIS. Either CaObjectId or CaseDataGroupId is required.
|
|
78
|
+
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
79
|
+
*/
|
|
80
|
+
checkGIS(entityType: string, entityUid: string, options: {
|
|
81
|
+
CaObjectId?: number;
|
|
82
|
+
CaseDataGroupId?: number;
|
|
83
|
+
CaseDataDetailId?: number;
|
|
84
|
+
}): Promise<unknown>;
|
|
85
|
+
/**
|
|
86
|
+
* Update data groups on a case based on asset value mappings.
|
|
87
|
+
*
|
|
88
|
+
* @category Data Groups
|
|
89
|
+
* @param {number} caObjectId - The case to update
|
|
90
|
+
* @param {string} entityType - The entity type to check
|
|
91
|
+
* @param {string} entityUid - The specific entityUID to check
|
|
92
|
+
* @param {number} [caDataGroupId] - The specific data group ID to limit updates to
|
|
93
|
+
* @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
|
|
94
|
+
*/
|
|
95
|
+
updateGroupsFromAsset(caObjectId: number, entityType: string, entityUid: string, caDataGroupId?: number): Promise<unknown>;
|
|
96
|
+
/**
|
|
97
|
+
* Attach Case Data Detail
|
|
98
|
+
*
|
|
99
|
+
* @category Data Details
|
|
100
|
+
* @param {number} caDataGroupId - The Case Data Group ID to attach the data detail to.
|
|
101
|
+
* @param {number} caseDataDetailId - caseDataDetailId to attach.
|
|
102
|
+
* @param {Object} [options] - Options
|
|
103
|
+
* @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
|
|
104
|
+
*/
|
|
105
|
+
addDetail(caDataGroupId: number, caseDataDetailId: number, options?: Object): Promise<unknown>;
|
|
106
|
+
/**
|
|
107
|
+
* Update Case Data Detail
|
|
108
|
+
*
|
|
109
|
+
* @category Data Details
|
|
110
|
+
* @param {number} caDataDetailId - The Case Data Group ID to attach the data detail to.
|
|
111
|
+
* @param {Object} [options] - Options
|
|
112
|
+
* @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
|
|
113
|
+
*/
|
|
114
|
+
updateDetail(caDataDetailId: number, options?: Object): Promise<unknown>;
|
|
115
|
+
/**
|
|
116
|
+
* Lock Case Data Detail
|
|
117
|
+
*
|
|
118
|
+
* @category Data Details
|
|
119
|
+
* @param {number} caDataDetailId - The Case Data Detail ID to lock
|
|
120
|
+
* @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
|
|
121
|
+
*/
|
|
122
|
+
lockDetail(caDataDetailId: number): Promise<unknown>;
|
|
123
|
+
/**
|
|
124
|
+
* Unlock Case Data Detail
|
|
125
|
+
*
|
|
126
|
+
* @category Data Details
|
|
127
|
+
* @param {number} caDataDetailId - The Case Data Group ID to unlock
|
|
128
|
+
* @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
|
|
129
|
+
*/
|
|
130
|
+
unlockDetail(caDataDetailId: number): Promise<unknown>;
|
|
131
|
+
/**
|
|
132
|
+
* Search for Case Data Details. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
133
|
+
*
|
|
134
|
+
* @category Data Details
|
|
135
|
+
* @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
|
|
136
|
+
* @return {Object} Returns Promise that represents an object describing CaDataDetailItemBase.
|
|
137
|
+
*/
|
|
138
|
+
searchForDetails(filters?: Object): Promise<Array<any>>;
|
|
139
|
+
/**
|
|
140
|
+
* Adds a list of possible values to the data detail entry specified by the CaDataDetailId.
|
|
141
|
+
*
|
|
142
|
+
* @category Data List Values
|
|
143
|
+
* @param {number} caDataDetailId - The Case Object to attach the data group to.
|
|
144
|
+
* @param {string} listValue - The Group Code.
|
|
145
|
+
* @return {Object} Returns Promise that represents an object describing CaDataListValuesItemBase.
|
|
146
|
+
*/
|
|
147
|
+
addListValue(caDataDetailId: number, listValue: string): Promise<unknown>;
|
|
148
|
+
/**
|
|
149
|
+
* Delete by Id (Ca Data List Id)
|
|
150
|
+
*
|
|
151
|
+
* @category Data List Values
|
|
152
|
+
* @param {number} CaDataListId - The Case Data List ID
|
|
153
|
+
* @return {Object} Returns Promise that represents an object describing CaDataListValuesItemBase.
|
|
154
|
+
*/
|
|
155
|
+
deleteListValue(caDataDetailId: number): Promise<unknown>;
|
|
156
|
+
/**
|
|
157
|
+
* Search for List Value IDs. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
158
|
+
*
|
|
159
|
+
* @category Data List Values
|
|
160
|
+
* @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue)
|
|
161
|
+
* @return {Object} Returns Promise that represents an Array of resulting CaDataListIds
|
|
162
|
+
*/
|
|
163
|
+
searchForListValueIds(filters?: Object): Promise<unknown>;
|
|
164
|
+
/**
|
|
165
|
+
* Search for List Value Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
|
|
166
|
+
*
|
|
167
|
+
* @category Data List Values
|
|
168
|
+
* @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue, CaDataGroupId)
|
|
169
|
+
* @return {Object} Returns Promise that represents a collection of resulting CaDataListValuesItemBase objects
|
|
170
|
+
*/
|
|
171
|
+
searchForListValueObjects(filters?: Object): Promise<unknown>;
|
|
172
|
+
/**
|
|
173
|
+
* Set a data detail item's value without needing to find the type
|
|
174
|
+
*
|
|
175
|
+
* @category Data Details
|
|
176
|
+
* @param dataDetailId - The data detail item's ID
|
|
177
|
+
* @param {any} value - the value to set the data detail item to
|
|
178
|
+
* @param {number} rate - the rate to set the data detail item to
|
|
179
|
+
* @param {number} quantity - the quantitye to set the data detail item to
|
|
180
|
+
* @returns Promise that represents
|
|
181
|
+
*/
|
|
182
|
+
updateDetailItemValue(dataDetailId: number, value: any, rate?: number, quantity?: number): Promise<unknown>;
|
|
183
|
+
/**
|
|
184
|
+
* Get the Case Data Details for a Case by Case ID
|
|
185
|
+
*
|
|
186
|
+
* @category Data Details
|
|
187
|
+
* @param {number} caseId - The case ID to get the details for
|
|
188
|
+
* @return {Object} Returns Promise that represents a collection of Case Data Detail Items
|
|
189
|
+
*/
|
|
190
|
+
getAllDataDetails(caseId: number): Promise<Array<any>>;
|
|
191
|
+
/**
|
|
192
|
+
* Set Case Data Detail Items for a Case by GroupCode.ItemCode syntax reference
|
|
193
|
+
*
|
|
194
|
+
* @category Data Details
|
|
195
|
+
* @param {number} caseId - The case ID to get the details for
|
|
196
|
+
* @param {Object} items - The parameters to search by. (DataGroup/Item string, Value) (e.g. {code: 'GroupCode.ItemCode', value: 'Value goes here'})
|
|
197
|
+
* @return {Object} Returns Promise that represents a collection
|
|
198
|
+
*/
|
|
199
|
+
setCaseData(caseId: number, items: Array<{
|
|
200
|
+
code: string;
|
|
201
|
+
value: any;
|
|
202
|
+
}>): Promise<unknown>;
|
|
203
|
+
/**
|
|
204
|
+
* Set Case Data Detail Item for a Case by GroupCode.ItemCode syntax reference
|
|
205
|
+
* This is a convenience method that allows you to set a single detail item without needing to find the type. Reference it within {instance}.briefcase.data.setCaseDataItem.
|
|
206
|
+
*
|
|
207
|
+
* @category Data Details
|
|
208
|
+
* @param {number} caseId - The Case ID to set the detail for
|
|
209
|
+
* @param {string} detailGroupAndItemCode - The parameters to search (e.g. 'GroupCode.ItemCode')
|
|
210
|
+
* @param {any} value - The value to set the specified detail to
|
|
211
|
+
* @return {Object} Returns Promise
|
|
212
|
+
*/
|
|
213
|
+
setCaseDataItem(caseId: number, detailGroupAndItemCode: string, value: any): Promise<unknown>;
|
|
214
|
+
}
|