@lansweeper/data-platform-outbound-grpc 0.0.2 → 0.1.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/CHANGELOG.md +16 -0
- package/DOC.md +591 -0
- package/gen-proto/image.json +1 -1
- package/gen-proto/outbound_grpc_pb.d.ts +3 -3
- package/gen-proto/outbound_grpc_pb.js +29 -25
- package/gen-proto/outbound_pb.d.ts +1 -1
- package/gen-proto/outbound_pb.js +1811 -1811
- package/package.json +2 -2
- package/pom.xml +29 -0
- package/proto/outbound.proto +9 -4
- package/src/main/java/com/lansweeper/dp/outbound/v1/Outbound.java +43170 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,22 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [0.1.1](https://github.com/Lansweeper/lansweeperapis/compare/@lansweeper/data-platform-outbound-grpc@0.0.3...@lansweeper/data-platform-outbound-grpc@0.1.1) (2023-03-14)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @lansweeper/data-platform-outbound-grpc
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [0.0.3](https://github.com/Lansweeper/lansweeperapis/compare/@lansweeper/data-platform-outbound-grpc@0.0.2...@lansweeper/data-platform-outbound-grpc@0.0.3) (2023-03-14)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @lansweeper/data-platform-outbound-grpc
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
6
22
|
## 0.0.2 (2023-03-02)
|
|
7
23
|
|
|
8
24
|
**Note:** Version bump only for package @lansweeper/data-platform-outbound-grpc
|
package/DOC.md
ADDED
|
@@ -0,0 +1,591 @@
|
|
|
1
|
+
# Protocol Documentation
|
|
2
|
+
<a name="top"></a>
|
|
3
|
+
|
|
4
|
+
## Table of Contents
|
|
5
|
+
|
|
6
|
+
- [outbound.proto](#outbound-proto)
|
|
7
|
+
- [Asset](#com-lansweeper-dp-outboundapi-v1-Asset)
|
|
8
|
+
- [AssetType](#com-lansweeper-dp-outboundapi-v1-AssetType)
|
|
9
|
+
- [CatalogBrand](#com-lansweeper-dp-outboundapi-v1-CatalogBrand)
|
|
10
|
+
- [CatalogModel](#com-lansweeper-dp-outboundapi-v1-CatalogModel)
|
|
11
|
+
- [CatalogMonitor](#com-lansweeper-dp-outboundapi-v1-CatalogMonitor)
|
|
12
|
+
- [CatalogOs](#com-lansweeper-dp-outboundapi-v1-CatalogOs)
|
|
13
|
+
- [CatalogSoftware](#com-lansweeper-dp-outboundapi-v1-CatalogSoftware)
|
|
14
|
+
- [CoreFields](#com-lansweeper-dp-outboundapi-v1-CoreFields)
|
|
15
|
+
- [Entity](#com-lansweeper-dp-outboundapi-v1-Entity)
|
|
16
|
+
- [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath)
|
|
17
|
+
- [GetEntityRequest](#com-lansweeper-dp-outboundapi-v1-GetEntityRequest)
|
|
18
|
+
- [GetEntityResponse](#com-lansweeper-dp-outboundapi-v1-GetEntityResponse)
|
|
19
|
+
- [HardwareInfo](#com-lansweeper-dp-outboundapi-v1-HardwareInfo)
|
|
20
|
+
- [ListEntityRequest](#com-lansweeper-dp-outboundapi-v1-ListEntityRequest)
|
|
21
|
+
- [ListEntityResponse](#com-lansweeper-dp-outboundapi-v1-ListEntityResponse)
|
|
22
|
+
- [OperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-OperatingSystemInfo)
|
|
23
|
+
- [RawHardwareInfo](#com-lansweeper-dp-outboundapi-v1-RawHardwareInfo)
|
|
24
|
+
- [RawSoftware](#com-lansweeper-dp-outboundapi-v1-RawSoftware)
|
|
25
|
+
- [Software](#com-lansweeper-dp-outboundapi-v1-Software)
|
|
26
|
+
- [SoftwareInventory](#com-lansweeper-dp-outboundapi-v1-SoftwareInventory)
|
|
27
|
+
- [WindowsRawOperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-WindowsRawOperatingSystemInfo)
|
|
28
|
+
|
|
29
|
+
- [DataCoreOutboundService](#com-lansweeper-dp-outboundapi-v1-DataCoreOutboundService)
|
|
30
|
+
|
|
31
|
+
- [Scalar Value Types](#scalar-value-types)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
<a name="outbound-proto"></a>
|
|
36
|
+
<p align="right"><a href="#top">Top</a></p>
|
|
37
|
+
|
|
38
|
+
## outbound.proto
|
|
39
|
+
Copyright Lansweeper (c)
|
|
40
|
+
|
|
41
|
+
This files contains the Data Access API and the definition of outbound model
|
|
42
|
+
|
|
43
|
+
N.B. This file has been documented using the specification available here: https://github.com/pseudomuto/protoc-gen-doc
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<a name="com-lansweeper-dp-outboundapi-v1-Asset"></a>
|
|
47
|
+
|
|
48
|
+
### Asset
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
| Field | Type | Label | Description |
|
|
53
|
+
| ----- | ---- | ----- | ----------- |
|
|
54
|
+
| id | [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath) | | |
|
|
55
|
+
| last_synced | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
|
|
56
|
+
| first_seen | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
|
|
57
|
+
| last_updated | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
|
|
58
|
+
| last_enriched | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
|
|
59
|
+
| core | [CoreFields](#com-lansweeper-dp-outboundapi-v1-CoreFields) | | |
|
|
60
|
+
| hw | [HardwareInfo](#com-lansweeper-dp-outboundapi-v1-HardwareInfo) | optional | |
|
|
61
|
+
| os | [OperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-OperatingSystemInfo) | optional | |
|
|
62
|
+
| software_inventory | [SoftwareInventory](#com-lansweeper-dp-outboundapi-v1-SoftwareInventory) | optional | |
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
<a name="com-lansweeper-dp-outboundapi-v1-AssetType"></a>
|
|
70
|
+
|
|
71
|
+
### AssetType
|
|
72
|
+
Asset Type enables customers to manage the settings for a
|
|
73
|
+
category of information in a centralized, reusable way.
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
| Field | Type | Label | Description |
|
|
77
|
+
| ----- | ---- | ----- | ----------- |
|
|
78
|
+
| ls_name | [string](#string) | | Lansweeper Asset Type. Full list available here: /lansweeperapis/packages/model/masterData/content/masterData.json |
|
|
79
|
+
| fing_type | [string](#string) | optional | Fing Type |
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
<a name="com-lansweeper-dp-outboundapi-v1-CatalogBrand"></a>
|
|
87
|
+
|
|
88
|
+
### CatalogBrand
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
| Field | Type | Label | Description |
|
|
93
|
+
| ----- | ---- | ----- | ----------- |
|
|
94
|
+
| id | [int64](#int64) | | |
|
|
95
|
+
| make_key | [string](#string) | | |
|
|
96
|
+
| make_name | [string](#string) | | |
|
|
97
|
+
| override_id | [int64](#int64) | optional | |
|
|
98
|
+
| parent_id | [int64](#int64) | optional | |
|
|
99
|
+
| last_update_time | [int64](#int64) | optional | |
|
|
100
|
+
| country_code | [string](#string) | optional | |
|
|
101
|
+
| logo_image_url | [string](#string) | optional | |
|
|
102
|
+
| banner_image_url | [string](#string) | optional | |
|
|
103
|
+
| wikipedia_id | [string](#string) | optional | |
|
|
104
|
+
| wikipedia_lang_code | [string](#string) | optional | |
|
|
105
|
+
| website_url | [string](#string) | optional | |
|
|
106
|
+
| support_url | [string](#string) | optional | |
|
|
107
|
+
| support_phone | [string](#string) | optional | |
|
|
108
|
+
| facebook_account | [string](#string) | optional | |
|
|
109
|
+
| twitter_account | [string](#string) | optional | |
|
|
110
|
+
| warranty_url | [string](#string) | optional | |
|
|
111
|
+
| warranty_direct_url | [string](#string) | optional | |
|
|
112
|
+
| community_url | [string](#string) | optional | |
|
|
113
|
+
| linkedin_account | [string](#string) | optional | |
|
|
114
|
+
| instagram_account | [string](#string) | optional | |
|
|
115
|
+
| youtube_account | [string](#string) | optional | |
|
|
116
|
+
| pinterest_account | [string](#string) | optional | |
|
|
117
|
+
| class_hardware | [bool](#bool) | optional | |
|
|
118
|
+
| class_software | [bool](#bool) | optional | |
|
|
119
|
+
| class_consumer | [bool](#bool) | optional | |
|
|
120
|
+
| class_enterprise | [bool](#bool) | optional | |
|
|
121
|
+
| class_industrial | [bool](#bool) | optional | |
|
|
122
|
+
| class_individual | [bool](#bool) | optional | |
|
|
123
|
+
| match_score | [int32](#int32) | optional | relevant only in search result |
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
<a name="com-lansweeper-dp-outboundapi-v1-CatalogModel"></a>
|
|
131
|
+
|
|
132
|
+
### CatalogModel
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
| Field | Type | Label | Description |
|
|
137
|
+
| ----- | ---- | ----- | ----------- |
|
|
138
|
+
| id | [int64](#int64) | | |
|
|
139
|
+
| key | [string](#string) | | |
|
|
140
|
+
| make_id | [int64](#int64) | | |
|
|
141
|
+
| device_model | [string](#string) | | |
|
|
142
|
+
| device_type | [string](#string) | optional | |
|
|
143
|
+
| device_model_code | [string](#string) | optional | |
|
|
144
|
+
| override_id | [int64](#int64) | optional | |
|
|
145
|
+
| os_default_id | [int64](#int64) | optional | |
|
|
146
|
+
| os_latest_id | [int64](#int64) | optional | |
|
|
147
|
+
| family_id | [int64](#int64) | optional | |
|
|
148
|
+
| is_family | [bool](#bool) | optional | |
|
|
149
|
+
| manual_url | [string](#string) | optional | |
|
|
150
|
+
| faq_url | [string](#string) | optional | |
|
|
151
|
+
| release_date | [int64](#int64) | optional | |
|
|
152
|
+
| disc_date | [int64](#int64) | optional | |
|
|
153
|
+
| eos_date | [int64](#int64) | optional | |
|
|
154
|
+
| lifecyle_confidence | [string](#string) | optional | |
|
|
155
|
+
| price_class | [string](#string) | optional | |
|
|
156
|
+
| product_class | [string](#string) | optional | |
|
|
157
|
+
| sh_ifttt_handle | [string](#string) | optional | |
|
|
158
|
+
| sh_google_ass_langs | [string](#string) | repeated | |
|
|
159
|
+
| sh_alexa_langs | [string](#string) | repeated | |
|
|
160
|
+
| sh_hass_handle | [string](#string) | optional | |
|
|
161
|
+
| sh_apple_home_kit | [bool](#bool) | optional | |
|
|
162
|
+
| sh_open_hab_handle | [string](#string) | optional | |
|
|
163
|
+
| nist_cpe | [string](#string) | optional | |
|
|
164
|
+
| spread_in_type | [double](#double) | optional | |
|
|
165
|
+
| last_update_time | [int64](#int64) | optional | |
|
|
166
|
+
| match_score | [int32](#int32) | optional | filled only when a result of search |
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<a name="com-lansweeper-dp-outboundapi-v1-CatalogMonitor"></a>
|
|
174
|
+
|
|
175
|
+
### CatalogMonitor
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
| Field | Type | Label | Description |
|
|
180
|
+
| ----- | ---- | ----- | ----------- |
|
|
181
|
+
| id | [int64](#int64) | | |
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<a name="com-lansweeper-dp-outboundapi-v1-CatalogOs"></a>
|
|
189
|
+
|
|
190
|
+
### CatalogOs
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
| Field | Type | Label | Description |
|
|
195
|
+
| ----- | ---- | ----- | ----------- |
|
|
196
|
+
| id | [int64](#int64) | | |
|
|
197
|
+
| os_key | [string](#string) | | |
|
|
198
|
+
| os_name | [string](#string) | | |
|
|
199
|
+
| os_version | [string](#string) | optional | |
|
|
200
|
+
| os_build | [string](#string) | optional | |
|
|
201
|
+
| os_version_name | [string](#string) | optional | |
|
|
202
|
+
| override_id | [int64](#int64) | optional | |
|
|
203
|
+
| make_id | [int64](#int64) | optional | |
|
|
204
|
+
| parent_id | [int64](#int64) | optional | |
|
|
205
|
+
| release_date | [int64](#int64) | optional | |
|
|
206
|
+
| eol_date | [int64](#int64) | optional | |
|
|
207
|
+
| eos_date | [int64](#int64) | optional | |
|
|
208
|
+
| eosx_date | [int64](#int64) | optional | |
|
|
209
|
+
| lifecyle_confidence | [string](#string) | optional | |
|
|
210
|
+
| logo_image_url | [string](#string) | optional | |
|
|
211
|
+
| banner_image_url | [string](#string) | optional | |
|
|
212
|
+
| wikipedia_id | [string](#string) | optional | |
|
|
213
|
+
| wikipedia_lang_code | [string](#string) | optional | |
|
|
214
|
+
| website_url | [string](#string) | optional | |
|
|
215
|
+
| support_url | [string](#string) | optional | |
|
|
216
|
+
| support_phone | [string](#string) | optional | |
|
|
217
|
+
| facebook_account | [string](#string) | optional | |
|
|
218
|
+
| twitter_account | [string](#string) | optional | |
|
|
219
|
+
| nist_cpe | [string](#string) | optional | |
|
|
220
|
+
| last_update_time | [int64](#int64) | optional | |
|
|
221
|
+
| match_score | [int32](#int32) | optional | filled only when a result of search |
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<a name="com-lansweeper-dp-outboundapi-v1-CatalogSoftware"></a>
|
|
229
|
+
|
|
230
|
+
### CatalogSoftware
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
| Field | Type | Label | Description |
|
|
235
|
+
| ----- | ---- | ----- | ----------- |
|
|
236
|
+
| id | [int64](#int64) | | |
|
|
237
|
+
| sw_key | [string](#string) | | |
|
|
238
|
+
| sw_name | [string](#string) | | |
|
|
239
|
+
| sw_version | [string](#string) | optional | |
|
|
240
|
+
| sw_market_ver | [string](#string) | optional | |
|
|
241
|
+
| sw_edition | [string](#string) | optional | |
|
|
242
|
+
| sw_lang | [string](#string) | optional | |
|
|
243
|
+
| sw_build | [string](#string) | optional | |
|
|
244
|
+
| override_id | [int64](#int64) | optional | |
|
|
245
|
+
| make_id | [int64](#int64) | optional | |
|
|
246
|
+
| parent_id | [int64](#int64) | optional | |
|
|
247
|
+
| sw_type | [string](#string) | optional | |
|
|
248
|
+
| sw_category | [string](#string) | optional | |
|
|
249
|
+
| nist_cpe_template | [string](#string) | optional | |
|
|
250
|
+
| release_date | [int64](#int64) | optional | |
|
|
251
|
+
| eol_date | [int64](#int64) | optional | |
|
|
252
|
+
| eos_date | [int64](#int64) | optional | |
|
|
253
|
+
| eosx_date | [int64](#int64) | optional | |
|
|
254
|
+
| lifecyle_confidence | [string](#string) | optional | |
|
|
255
|
+
| last_update_time | [int64](#int64) | optional | |
|
|
256
|
+
| flag_latest | [bool](#bool) | optional | |
|
|
257
|
+
| flag_widespread | [bool](#bool) | optional | |
|
|
258
|
+
| flag_deprecated | [bool](#bool) | optional | |
|
|
259
|
+
| match_score | [int32](#int32) | optional | filled only when a result of search |
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
<a name="com-lansweeper-dp-outboundapi-v1-CoreFields"></a>
|
|
267
|
+
|
|
268
|
+
### CoreFields
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
| Field | Type | Label | Description |
|
|
273
|
+
| ----- | ---- | ----- | ----------- |
|
|
274
|
+
| type | [AssetType](#com-lansweeper-dp-outboundapi-v1-AssetType) | | |
|
|
275
|
+
| name | [string](#string) | | |
|
|
276
|
+
| domain | [string](#string) | optional | |
|
|
277
|
+
| ip_address | [string](#string) | optional | |
|
|
278
|
+
| serial | [string](#string) | optional | |
|
|
279
|
+
| mac | [string](#string) | optional | |
|
|
280
|
+
| mac_vendor | [string](#string) | optional | |
|
|
281
|
+
| sensor_id | [string](#string) | optional | |
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<a name="com-lansweeper-dp-outboundapi-v1-Entity"></a>
|
|
289
|
+
|
|
290
|
+
### Entity
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
| Field | Type | Label | Description |
|
|
295
|
+
| ----- | ---- | ----- | ----------- |
|
|
296
|
+
| asset | [Asset](#com-lansweeper-dp-outboundapi-v1-Asset) | | User user = 2; Other ... |
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<a name="com-lansweeper-dp-outboundapi-v1-EntityPath"></a>
|
|
304
|
+
|
|
305
|
+
### EntityPath
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
| Field | Type | Label | Description |
|
|
310
|
+
| ----- | ---- | ----- | ----------- |
|
|
311
|
+
| site_id | [string](#string) | | |
|
|
312
|
+
| source_id | [string](#string) | optional | |
|
|
313
|
+
| source_type | [string](#string) | optional | IT, OT, CDK, 3rdParty |
|
|
314
|
+
| entity_type | [string](#string) | optional | "asset" "user" etc |
|
|
315
|
+
| entity_id | [string](#string) | optional | |
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<a name="com-lansweeper-dp-outboundapi-v1-GetEntityRequest"></a>
|
|
323
|
+
|
|
324
|
+
### GetEntityRequest
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
| Field | Type | Label | Description |
|
|
329
|
+
| ----- | ---- | ----- | ----------- |
|
|
330
|
+
| entity_path | [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath) | | bool send_related = 2; // send also related entities |
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<a name="com-lansweeper-dp-outboundapi-v1-GetEntityResponse"></a>
|
|
338
|
+
|
|
339
|
+
### GetEntityResponse
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
| Field | Type | Label | Description |
|
|
344
|
+
| ----- | ---- | ----- | ----------- |
|
|
345
|
+
| entity | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) | | |
|
|
346
|
+
| related | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) | repeated | |
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<a name="com-lansweeper-dp-outboundapi-v1-HardwareInfo"></a>
|
|
354
|
+
|
|
355
|
+
### HardwareInfo
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
| Field | Type | Label | Description |
|
|
360
|
+
| ----- | ---- | ----- | ----------- |
|
|
361
|
+
| type_id | [int64](#int64) | optional | |
|
|
362
|
+
| make_id | [int64](#int64) | optional | |
|
|
363
|
+
| model_id | [int64](#int64) | optional | |
|
|
364
|
+
| family_id | [int64](#int64) | optional | |
|
|
365
|
+
| is_family | [bool](#bool) | optional | |
|
|
366
|
+
| serial | [string](#string) | optional | |
|
|
367
|
+
| type_name | [string](#string) | optional | |
|
|
368
|
+
| make_name | [string](#string) | optional | |
|
|
369
|
+
| model_name | [string](#string) | optional | |
|
|
370
|
+
| family_name | [string](#string) | optional | |
|
|
371
|
+
| cpe | [string](#string) | optional | |
|
|
372
|
+
| rank | [int32](#int32) | optional | |
|
|
373
|
+
| catalog_brand | [CatalogBrand](#com-lansweeper-dp-outboundapi-v1-CatalogBrand) | optional | |
|
|
374
|
+
| catalog_model | [CatalogModel](#com-lansweeper-dp-outboundapi-v1-CatalogModel) | optional | |
|
|
375
|
+
| raw | [RawHardwareInfo](#com-lansweeper-dp-outboundapi-v1-RawHardwareInfo) | optional | |
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<a name="com-lansweeper-dp-outboundapi-v1-ListEntityRequest"></a>
|
|
383
|
+
|
|
384
|
+
### ListEntityRequest
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
| Field | Type | Label | Description |
|
|
389
|
+
| ----- | ---- | ----- | ----------- |
|
|
390
|
+
| filter | [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath) | | minimum is for a site |
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
<a name="com-lansweeper-dp-outboundapi-v1-ListEntityResponse"></a>
|
|
398
|
+
|
|
399
|
+
### ListEntityResponse
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
| Field | Type | Label | Description |
|
|
404
|
+
| ----- | ---- | ----- | ----------- |
|
|
405
|
+
| entity | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) | | |
|
|
406
|
+
| related | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) | repeated | |
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
<a name="com-lansweeper-dp-outboundapi-v1-OperatingSystemInfo"></a>
|
|
414
|
+
|
|
415
|
+
### OperatingSystemInfo
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
| Field | Type | Label | Description |
|
|
420
|
+
| ----- | ---- | ----- | ----------- |
|
|
421
|
+
| id | [int64](#int64) | optional | |
|
|
422
|
+
| name | [string](#string) | optional | |
|
|
423
|
+
| version | [string](#string) | optional | |
|
|
424
|
+
| build | [string](#string) | optional | |
|
|
425
|
+
| fw_version | [string](#string) | optional | |
|
|
426
|
+
| cpe | [string](#string) | optional | |
|
|
427
|
+
| fw_cpe | [string](#string) | optional | |
|
|
428
|
+
| rank | [int32](#int32) | optional | |
|
|
429
|
+
| catalog_brand | [CatalogBrand](#com-lansweeper-dp-outboundapi-v1-CatalogBrand) | optional | |
|
|
430
|
+
| catalog_os | [CatalogOs](#com-lansweeper-dp-outboundapi-v1-CatalogOs) | optional | |
|
|
431
|
+
| windows | [WindowsRawOperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-WindowsRawOperatingSystemInfo) | | |
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<a name="com-lansweeper-dp-outboundapi-v1-RawHardwareInfo"></a>
|
|
439
|
+
|
|
440
|
+
### RawHardwareInfo
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
| Field | Type | Label | Description |
|
|
445
|
+
| ----- | ---- | ----- | ----------- |
|
|
446
|
+
| architecture | [string](#string) | optional | |
|
|
447
|
+
| model | [string](#string) | optional | |
|
|
448
|
+
| manufacturer | [string](#string) | optional | |
|
|
449
|
+
| serial_number | [string](#string) | optional | |
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
<a name="com-lansweeper-dp-outboundapi-v1-RawSoftware"></a>
|
|
457
|
+
|
|
458
|
+
### RawSoftware
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
| Field | Type | Label | Description |
|
|
463
|
+
| ----- | ---- | ----- | ----------- |
|
|
464
|
+
| name | [string](#string) | | |
|
|
465
|
+
| vendor | [string](#string) | optional | |
|
|
466
|
+
| version | [string](#string) | optional | |
|
|
467
|
+
| info | [string](#string) | optional | |
|
|
468
|
+
| exe_path | [string](#string) | optional | |
|
|
469
|
+
| arch | [string](#string) | optional | when available the specific sw arch |
|
|
470
|
+
| install_date | [int64](#int64) | optional | |
|
|
471
|
+
| source_type | [string](#string) | optional | Registry | System | MsStore | Package | Custom | etc |
|
|
472
|
+
| sw_id | [string](#string) | optional | optional SW id on the client side |
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
<a name="com-lansweeper-dp-outboundapi-v1-Software"></a>
|
|
480
|
+
|
|
481
|
+
### Software
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
| Field | Type | Label | Description |
|
|
486
|
+
| ----- | ---- | ----- | ----------- |
|
|
487
|
+
| rank | [int32](#int32) | optional | |
|
|
488
|
+
| type_id | [int64](#int64) | optional | |
|
|
489
|
+
| cat_id | [int64](#int64) | optional | |
|
|
490
|
+
| make_id | [int64](#int64) | optional | |
|
|
491
|
+
| sw_id | [int64](#int64) | optional | |
|
|
492
|
+
| parent_id | [int64](#int64) | optional | |
|
|
493
|
+
| type_name | [string](#string) | optional | |
|
|
494
|
+
| cat_name | [string](#string) | optional | |
|
|
495
|
+
| make_name | [string](#string) | optional | |
|
|
496
|
+
| name | [string](#string) | optional | |
|
|
497
|
+
| version | [string](#string) | optional | |
|
|
498
|
+
| market_ver | [string](#string) | optional | |
|
|
499
|
+
| edition | [string](#string) | optional | |
|
|
500
|
+
| build | [string](#string) | optional | |
|
|
501
|
+
| cpe | [string](#string) | optional | |
|
|
502
|
+
| catalog_software | [CatalogSoftware](#com-lansweeper-dp-outboundapi-v1-CatalogSoftware) | optional | |
|
|
503
|
+
| raw | [RawSoftware](#com-lansweeper-dp-outboundapi-v1-RawSoftware) | | |
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
<a name="com-lansweeper-dp-outboundapi-v1-SoftwareInventory"></a>
|
|
511
|
+
|
|
512
|
+
### SoftwareInventory
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
| Field | Type | Label | Description |
|
|
517
|
+
| ----- | ---- | ----- | ----------- |
|
|
518
|
+
| timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
|
|
519
|
+
| software | [Software](#com-lansweeper-dp-outboundapi-v1-Software) | repeated | |
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
<a name="com-lansweeper-dp-outboundapi-v1-WindowsRawOperatingSystemInfo"></a>
|
|
527
|
+
|
|
528
|
+
### WindowsRawOperatingSystemInfo
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
| Field | Type | Label | Description |
|
|
533
|
+
| ----- | ---- | ----- | ----------- |
|
|
534
|
+
| version | [string](#string) | optional | |
|
|
535
|
+
| service_pack | [int32](#int32) | optional | |
|
|
536
|
+
| build | [string](#string) | optional | "WindowsVersion": "10.0.19045" |
|
|
537
|
+
| version_name | [string](#string) | optional | OsVersion": "22H2", |
|
|
538
|
+
| build_number | [string](#string) | optional | "OsBuildNumber": "2486", |
|
|
539
|
+
| product_type | [int32](#int32) | optional | WindowsProductType: 1 |
|
|
540
|
+
| is_domain_controller | [bool](#bool) | optional | |
|
|
541
|
+
| part_of_domain | [bool](#bool) | optional | |
|
|
542
|
+
| is_azure_ad_joined | [bool](#bool) | optional | |
|
|
543
|
+
| os_code | [string](#string) | optional | "OsCode": "10.0.19045" - with S if server |
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<a name="com-lansweeper-dp-outboundapi-v1-DataCoreOutboundService"></a>
|
|
557
|
+
|
|
558
|
+
### DataCoreOutboundService
|
|
559
|
+
GRPC Service. Currently supported operation:
|
|
560
|
+
- Get Entity
|
|
561
|
+
- Stream Entities
|
|
562
|
+
|
|
563
|
+
| Method Name | Request Type | Response Type | Description |
|
|
564
|
+
| ----------- | ------------ | ------------- | ------------|
|
|
565
|
+
| GetEntity | [GetEntityRequest](#com-lansweeper-dp-outboundapi-v1-GetEntityRequest) | [GetEntityResponse](#com-lansweeper-dp-outboundapi-v1-GetEntityResponse) | Retrieve a single entity by site/inst-id/type/id |
|
|
566
|
+
| ListEntities | [ListEntityRequest](#com-lansweeper-dp-outboundapi-v1-ListEntityRequest) | [ListEntityResponse](#com-lansweeper-dp-outboundapi-v1-ListEntityResponse) stream | lists entities for a site or site/type |
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
## Scalar Value Types
|
|
573
|
+
|
|
574
|
+
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|
|
575
|
+
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
|
|
576
|
+
| <a name="double" /> double | | double | double | float | float64 | double | float | Float |
|
|
577
|
+
| <a name="float" /> float | | float | float | float | float32 | float | float | Float |
|
|
578
|
+
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
|
|
579
|
+
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
|
|
580
|
+
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
|
|
581
|
+
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
|
|
582
|
+
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
|
|
583
|
+
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
|
|
584
|
+
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
|
|
585
|
+
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
|
|
586
|
+
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
|
|
587
|
+
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
|
|
588
|
+
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
|
|
589
|
+
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
|
|
590
|
+
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
|
|
591
|
+
|