cityworks 0.0.45 → 0.0.46
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 +18 -52
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,9 +16,7 @@ Instantiate the Class for the instance of Cityworks available given a domain:
|
|
|
16
16
|
|
|
17
17
|
Authenticate with the Cityworks install:
|
|
18
18
|
|
|
19
|
-
cw.Cityworks.authenticate('myuser', 'mypassword').then(resp => {
|
|
20
|
-
|
|
21
|
-
}).catch(error => {
|
|
19
|
+
cw.Cityworks.authenticate('myuser', 'mypassword').then(resp => {}).catch(error => {
|
|
22
20
|
console.log(error.message)
|
|
23
21
|
})
|
|
24
22
|
|
|
@@ -33,52 +31,34 @@ Provide a saved token instead of the standard u/p auth:
|
|
|
33
31
|
|
|
34
32
|
## Main method calls
|
|
35
33
|
|
|
36
|
-
Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [
|
|
37
|
-
|
|
38
|
-
cw.Cityworks.inspection.methodHere().then(resp => {
|
|
34
|
+
Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [Service Request](https://walker.github.io/cityworks/classes/request.Request.html)) & [PLL](https://walker.github.io/cityworks/classes/case.Briefcase.html) object libraries like so:
|
|
39
35
|
|
|
40
|
-
})
|
|
41
|
-
cw.
|
|
42
|
-
|
|
43
|
-
})
|
|
44
|
-
cw.Cityworks.request.methodHere().then(resp => {
|
|
45
|
-
|
|
46
|
-
})
|
|
47
|
-
cw.Cityworks.briefcase.methodHere().then(resp => {
|
|
48
|
-
|
|
49
|
-
})
|
|
36
|
+
cw.inspection.methodHere().then(resp => {})
|
|
37
|
+
cw.workorder.methodHere().then(resp => {})
|
|
38
|
+
cw.request.methodHere().then(resp => {})
|
|
39
|
+
cw.briefcase.methodHere().then(resp => {})
|
|
50
40
|
|
|
51
41
|
Some of the methods are general or top-level, and so, are accessed separately are at the same level of reference from the cityworks object:
|
|
52
42
|
|
|
53
43
|
[General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
|
|
54
44
|
|
|
55
|
-
cw.
|
|
56
|
-
|
|
57
|
-
})
|
|
45
|
+
cw.general.methodHere().then(resp => {})
|
|
58
46
|
|
|
59
47
|
[Message queue](https://walker.github.io/cityworks/classes/message_queue.MessageQueue.html) methods for examining, processing, and troubleshooting webhooks and activity events:
|
|
60
48
|
|
|
61
|
-
cw.
|
|
62
|
-
|
|
63
|
-
})
|
|
49
|
+
cw.message_queue.methodHere().then(resp => {})
|
|
64
50
|
|
|
65
51
|
[Activity link](https://walker.github.io/cityworks/classes/activity_link.ActivityLinks.html) for linking one node/object to another:
|
|
66
52
|
|
|
67
|
-
cw.
|
|
68
|
-
|
|
69
|
-
})
|
|
53
|
+
cw.activity_link.methodHere().then(resp => {})
|
|
70
54
|
|
|
71
55
|
[Mapping and GIS methods](https://walker.github.io/cityworks/classes/gis.Gis.html) not specific to a single object type:
|
|
72
56
|
|
|
73
|
-
cw.
|
|
74
|
-
|
|
75
|
-
})
|
|
57
|
+
cw.gis.methodHere().then(resp => {})
|
|
76
58
|
|
|
77
59
|
[General search methods](https://walker.github.io/cityworks/classes/search.Search.html):
|
|
78
60
|
|
|
79
|
-
cw.
|
|
80
|
-
|
|
81
|
-
})
|
|
61
|
+
cw.search.methodHere().then(resp => {})
|
|
82
62
|
|
|
83
63
|
## Case financials, data details, and admin
|
|
84
64
|
|
|
@@ -86,40 +66,26 @@ For the sake of organizing some of the other methods needed by the primary and s
|
|
|
86
66
|
|
|
87
67
|
For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
|
|
88
68
|
|
|
89
|
-
cw.
|
|
90
|
-
|
|
91
|
-
})
|
|
69
|
+
cw.briefcase.financial.methodHere().then(resp => {})
|
|
92
70
|
|
|
93
71
|
For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
|
|
94
72
|
|
|
95
|
-
cw.
|
|
96
|
-
|
|
97
|
-
})
|
|
73
|
+
cw.briefcase.data.methodHere().then(resp => {})
|
|
98
74
|
|
|
99
75
|
For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
|
|
100
76
|
|
|
101
|
-
cw.
|
|
102
|
-
|
|
103
|
-
})
|
|
77
|
+
cw.briefcase.workflow.methodHere().then(resp => {})
|
|
104
78
|
|
|
105
79
|
For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
|
|
106
80
|
|
|
107
|
-
cw.
|
|
108
|
-
|
|
109
|
-
})
|
|
81
|
+
cw.briefcase.admin.methodHere().then(resp => {})
|
|
110
82
|
|
|
111
83
|
## Commenting
|
|
112
84
|
|
|
113
85
|
For any object in Cityworks which can be commented on, use the [Comments class](https://walker.github.io/cityworks/classes/comments.Comments.html) via the class the comment is to be made on:
|
|
114
86
|
|
|
115
|
-
cw.
|
|
116
|
-
|
|
117
|
-
})
|
|
118
|
-
|
|
119
|
-
cw.Cityworks.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {
|
|
120
|
-
|
|
121
|
-
})
|
|
87
|
+
cw.briefcase.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {})
|
|
122
88
|
|
|
123
|
-
cw.
|
|
89
|
+
cw.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {})
|
|
124
90
|
|
|
125
|
-
})
|
|
91
|
+
cw.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {})
|