@manyos/smileconnect-api 1.40.1 → 1.41.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/conf/clients.json +2 -1
- package/conf/scripts/update.js +12 -0
- package/docs/_sidebar.md +14 -13
- package/docs/adapter.md +64 -14
- package/docs/releases.md +21 -1
- package/package.json +1 -1
package/conf/clients.json
CHANGED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
const settings = {
|
|
2
|
+
"form":"Sample:Cities",
|
|
3
|
+
"id": "000000000000115",
|
|
4
|
+
"entry": {
|
|
5
|
+
"Airport Code": "MUC3",
|
|
6
|
+
"City": "Munich"
|
|
7
|
+
}
|
|
8
|
+
};
|
|
9
|
+
//Create Service Request
|
|
10
|
+
const resultUpdate = await adapter.remedy.update(settings.form, settings.id, settings.entry);
|
|
11
|
+
|
|
12
|
+
resolve(resultUpdate);
|
package/docs/_sidebar.md
CHANGED
|
@@ -1,25 +1,26 @@
|
|
|
1
1
|
- Getting started
|
|
2
2
|
|
|
3
|
-
- [Quick start](quickstart
|
|
4
|
-
- [Architecture](architecture
|
|
3
|
+
- [Quick start](quickstart)
|
|
4
|
+
- [Architecture](architecture)
|
|
5
5
|
- [API Specification](https://smileconnect.manyosdocs.de/spec/index.html)
|
|
6
|
+
- [Release notes](releases)
|
|
6
7
|
|
|
7
8
|
- Configuration
|
|
8
9
|
|
|
9
|
-
- [Global Settings](configuration/config
|
|
10
|
-
- [Mapping](configuration/mapping
|
|
11
|
-
- [Client Configuration](configuration/clients
|
|
12
|
-
- [Events](configuration/events
|
|
10
|
+
- [Global Settings](configuration/config)
|
|
11
|
+
- [Mapping](configuration/mapping)
|
|
12
|
+
- [Client Configuration](configuration/clients)
|
|
13
|
+
- [Events](configuration/events)
|
|
13
14
|
|
|
14
15
|
- Data manipulation
|
|
15
16
|
|
|
16
|
-
- [Scripts](scripts
|
|
17
|
-
- [Adapter](adapter
|
|
17
|
+
- [Scripts](scripts)
|
|
18
|
+
- [Adapter](adapter)
|
|
18
19
|
|
|
19
20
|
- How-Tos
|
|
20
21
|
|
|
21
|
-
- [Authentication](howto/token
|
|
22
|
-
- [Incident Requests](howto/incidents
|
|
23
|
-
- [Handle Worklogs](howto/worklogs
|
|
24
|
-
- [Handle Attachments](howto/attachments
|
|
25
|
-
- [Read Configuration Items](howto/cmdbobjects
|
|
22
|
+
- [Authentication](howto/token)
|
|
23
|
+
- [Incident Requests](howto/incidents)
|
|
24
|
+
- [Handle Worklogs](howto/worklogs)
|
|
25
|
+
- [Handle Attachments](howto/attachments)
|
|
26
|
+
- [Read Configuration Items](howto/cmdbobjects)
|
package/docs/adapter.md
CHANGED
|
@@ -49,11 +49,11 @@ return adapterParams;
|
|
|
49
49
|
|
|
50
50
|
The different Adapter and their configuration values are described in detail below.
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
# Remedy
|
|
53
53
|
|
|
54
54
|
The Remedy Adapter is used to connect to BMC Remedy Action Request Servers. It allows you to create, query and update records.
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
## Configuration values
|
|
57
57
|
|
|
58
58
|
**arServer**: The name of the arsystem server. e.g. ars1.mydomain.com
|
|
59
59
|
|
|
@@ -71,9 +71,9 @@ The Remedy Adapter is used to connect to BMC Remedy Action Request Servers. It a
|
|
|
71
71
|
|
|
72
72
|
**limitMax**: The maximum number of records retrieved in a query. This parameter can be used to enforce a limit. The limit can not be overwritten by queries.
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
## Functions
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
### Search
|
|
77
77
|
|
|
78
78
|
```javascript
|
|
79
79
|
async function search(form, query, fields, options)
|
|
@@ -125,7 +125,7 @@ Will return an object with a data array and some meta data.
|
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
|
|
128
|
-
|
|
128
|
+
### Create
|
|
129
129
|
|
|
130
130
|
```javascript
|
|
131
131
|
async function create(form, entry, options)
|
|
@@ -170,9 +170,59 @@ const settings = {
|
|
|
170
170
|
const resultCreate = await adapter.remedy.create(settings.createForm, settings.entry);
|
|
171
171
|
```
|
|
172
172
|
|
|
173
|
-
Will return return the id of the created record. e.g. REQ00000002893
|
|
173
|
+
Will return return the id of the created record. e.g. REQ00000002893 or throw an error.
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
### Update
|
|
176
|
+
|
|
177
|
+
```javascript
|
|
178
|
+
async function update(form, id, entry, options)
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
Parameter:
|
|
182
|
+
|
|
183
|
+
* form (string):
|
|
184
|
+
|
|
185
|
+
The form in which a record is updated. e.g. CTM:People
|
|
186
|
+
|
|
187
|
+
* id (string):
|
|
188
|
+
|
|
189
|
+
The id of the entry that should be updated
|
|
190
|
+
|
|
191
|
+
* entry (object):
|
|
192
|
+
|
|
193
|
+
The entry object that is updated.
|
|
194
|
+
|
|
195
|
+
e.g.
|
|
196
|
+
|
|
197
|
+
```javascript
|
|
198
|
+
{
|
|
199
|
+
"Source Keyword": "SMILEcatalog",
|
|
200
|
+
"Company": "Calbro Services",
|
|
201
|
+
"AppRequestSummary": "New Request from SMILEcatalog",
|
|
202
|
+
"TitleInstanceID": "SRGAA5V0GEfds7LO5YL6Q945Z",
|
|
203
|
+
"Login ID": "Allen"
|
|
204
|
+
}
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Full example:
|
|
208
|
+
|
|
209
|
+
```javascript
|
|
210
|
+
const settings = {
|
|
211
|
+
"form":"Sample:Cities",
|
|
212
|
+
"id": "000000000000115",
|
|
213
|
+
"entry": {
|
|
214
|
+
"Airport Code": "MUC1",
|
|
215
|
+
"City": "Munich"
|
|
216
|
+
}
|
|
217
|
+
};
|
|
218
|
+
//Create Service Request
|
|
219
|
+
const resultUpdate = await adapter.remedy.update(settings.form, settings.id, settings.entry);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
Will return return the id of the updated record. e.g. 000000000000115 or throw an error.
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
### Options
|
|
176
226
|
|
|
177
227
|
* limit
|
|
178
228
|
|
|
@@ -217,10 +267,10 @@ const options = {
|
|
|
217
267
|
}
|
|
218
268
|
```
|
|
219
269
|
|
|
220
|
-
|
|
270
|
+
# LDAP
|
|
221
271
|
|
|
222
272
|
|
|
223
|
-
|
|
273
|
+
## Configuration values
|
|
224
274
|
|
|
225
275
|
* ldapUrl
|
|
226
276
|
|
|
@@ -234,10 +284,10 @@ The Bind DN to authenticate with. e.g. cn=smilecatalog-user,dc=example,dc=com
|
|
|
234
284
|
|
|
235
285
|
The secret to use with the Bind DN. e.g. password
|
|
236
286
|
|
|
237
|
-
|
|
287
|
+
## Functions
|
|
238
288
|
|
|
239
289
|
|
|
240
|
-
|
|
290
|
+
### Search
|
|
241
291
|
|
|
242
292
|
```javascript
|
|
243
293
|
async search(base, options)
|
|
@@ -288,11 +338,11 @@ Returns an array of records. e.g.
|
|
|
288
338
|
]
|
|
289
339
|
```
|
|
290
340
|
|
|
291
|
-
|
|
341
|
+
# SMILEconnect
|
|
292
342
|
|
|
293
343
|
The SMILEconnect Adapter can be used to do calls against SMILEconnect. It will act as it is called externally.
|
|
294
344
|
|
|
295
|
-
|
|
345
|
+
## Configuration values
|
|
296
346
|
|
|
297
347
|
**smileConnectUrl**: The url of your SMILEconnect installation e.g. https://smileconnect.mydomain.io
|
|
298
348
|
|
|
@@ -302,7 +352,7 @@ The SMILEconnect Adapter can be used to do calls against SMILEconnect. It will a
|
|
|
302
352
|
|
|
303
353
|
**secret**: The secret of the client. e.g. jd92hd-03283d-2293s-232
|
|
304
354
|
|
|
305
|
-
|
|
355
|
+
## Functions
|
|
306
356
|
|
|
307
357
|
The SMILEconnect adapter is an open source project.
|
|
308
358
|
|
package/docs/releases.md
CHANGED
|
@@ -2,6 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## API
|
|
4
4
|
|
|
5
|
+
### 1.41.1 - 10.08.21
|
|
6
|
+
|
|
7
|
+
Fix issue with sort in Remedy Adapter
|
|
8
|
+
|
|
9
|
+
### 1.41.0 - 03.08.21
|
|
10
|
+
|
|
11
|
+
Update Record added to [Remedy Adapter](adapter#remedy).
|
|
12
|
+
|
|
5
13
|
### 1.40.0 - 30.07.21
|
|
6
14
|
|
|
7
15
|
Dynamic Impersonate Users added.
|
|
@@ -14,8 +22,20 @@ e.g.
|
|
|
14
22
|
|
|
15
23
|
## Event Manager
|
|
16
24
|
|
|
25
|
+
### 1.16.0 - 03.08.21
|
|
26
|
+
|
|
27
|
+
Update Record added to [Remedy Adapter](adapter#remedy).
|
|
28
|
+
|
|
17
29
|
### 1.15.0 - 30.07.21
|
|
18
30
|
|
|
19
31
|
The eventmanager will check all outbound webhooks for an event. If one fails, the whole Event will be set to error and the details will be added to the error message.
|
|
20
32
|
|
|
21
|
-
## GUI
|
|
33
|
+
## GUI
|
|
34
|
+
|
|
35
|
+
### 1.4.17 - 09.08.21
|
|
36
|
+
|
|
37
|
+
Multiple events caused an error in the UI.
|
|
38
|
+
|
|
39
|
+
### 1.4.16 - 02.08.21
|
|
40
|
+
|
|
41
|
+
Add Auth + Scripts to Event config
|