Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / d9cae980e80021dfad0bc9366d32d2cf996cfa90 / . / docs / offeredapis.rst
blob: 5a2d9c7ddf7a87ac7ecfdab413b56f221d8407c8 [file] [log] [blame]
Rich Bennett4b001932017-10-16 09:25:01 -0400[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]4============
Idan Amit248b9b72017-11-05 11:56:11 +0200[diff] [blame]5Offered APIs
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]6============
Rich Bennett4b001932017-10-16 09:25:01 -0400[diff] [blame]7
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]8:Date: 2017-12-25
Rich Bennett4b001932017-10-16 09:25:01 -0400[diff] [blame]9
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]10.. contents::
Idan Amit248b9b72017-11-05 11:56:11 +0200[diff] [blame]11 :depth: 3
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]12..
13
14Overview
15========
16
17Version information
18-------------------
19
Idan Amitdbfbc632017-10-29 17:03:42 +0200[diff] [blame]20*Version* : 1.1.0
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]21
22URI scheme
23----------
24
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]25*BasePath* : /sdc
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]26
27Tags
28----
29
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]30- Artifact External Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]31
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]32- Asset Metadata External Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]33
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]34- CRUD External Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]35
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]36- Distribution Catalog Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]37
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]38- Distribution Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]39
40Paths
41=====
42
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]43Artifact types list
44-------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]45
46::
47
48 GET /v1/artifactTypes
49
50Description
51~~~~~~~~~~~
52
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]53Fetches available artifact types list
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]54
55Parameters
56~~~~~~~~~~
57
58+----------+-------------+--------------------------------------+------------------+
59| Type | Name | Description | Schema |
60+==========+=============+======================================+==================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]61| **Header | **Accept**\ | The username and password | string |
62| ** | *required* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]63+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]64| **Header | **Authoriza | The username and password | string |
65| ** | tion**\ *re | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]66| | quired* | | |
67+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]68| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
69| ** | nstanceID** | | |
70| | \ *required | | |
71| | * | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]72+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]73| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
74| ** | equestID**\ | | |
75| | *optional* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]76+----------+-------------+--------------------------------------+------------------+
77
78Responses
79~~~~~~~~~
80
81+---------+----------------------------------------------------+----------------+
82| HTTP | Description | Schema |
83| Code | | |
84+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]85| **200** | Artifact types list fetched successfully | string |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]86+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]87| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]88+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]89| **401** | ECOMP component should authenticate itself and to | No Content |
90| | re-send again HTTP request with its Basic | |
91| | Authentication credentials - POL5002 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]92+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]93| **403** | ECOMP component is not authorized - POL5003 | No Content |
94+---------+----------------------------------------------------+----------------+
95| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
96| | to register for distribution ( POST,PUT,DELETE | |
97| | will be rejected) - POL4050 | |
98+---------+----------------------------------------------------+----------------+
99| **500** | The registration failed due to internal SDC | No Content |
100| | problem or Cambria Service failure ECOMP Component | |
101| | should continue the attempts to register for | |
102| | distribution - POL5000 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]103+---------+----------------------------------------------------+----------------+
104
105Consumes
106~~~~~~~~
107
108- ``application/json``
109
110Produces
111~~~~~~~~
112
113- ``application/json``
114
115Tags
116~~~~
117
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]118- Distribution Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]119
120Download service artifact
121-------------------------
122
123::
124
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]125 GET /v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]126
127Description
128~~~~~~~~~~~
129
130Returns downloaded artifact
131
132Parameters
133~~~~~~~~~~
134
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]135+----------+-------------+--------------------------------------+------------------+
136| Type | Name | Description | Schema |
137+==========+=============+======================================+==================+
138| **Header | **Accept**\ | Determines the format of the body of | string |
139| ** | *optional* | the response | |
140+----------+-------------+--------------------------------------+------------------+
141| **Header | **Authoriza | The username and password | string |
142| ** | tion**\ *re | | |
143| | quired* | | |
144+----------+-------------+--------------------------------------+------------------+
145| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
146| ** | nstanceID** | | |
147| | \ *required | | |
148| | * | | |
149+----------+-------------+--------------------------------------+------------------+
150| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
151| ** | equestID**\ | | |
152| | *optional* | | |
153+----------+-------------+--------------------------------------+------------------+
154| **Path** | **artifactN | | string |
155| | ame**\ *req | | |
156| | uired* | | |
157+----------+-------------+--------------------------------------+------------------+
158| **Path** | **serviceNa | | string |
159| | me**\ *requ | | |
160| | ired* | | |
161+----------+-------------+--------------------------------------+------------------+
162| **Path** | **serviceVe | | string |
163| | rsion**\ *r | | |
164| | equired* | | |
165+----------+-------------+--------------------------------------+------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]166
167Responses
168~~~~~~~~~
169
170+---------+----------------------------------------------------+----------------+
171| HTTP | Description | Schema |
172| Code | | |
173+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]174| **200** | The artifact is found and streamed. | string |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]175+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]176| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]177+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]178| **401** | ECOMP component should authenticate itself and to | No Content |
179| | re-send again HTTP request with its Basic | |
180| | Authentication credentials - POL5002 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]181+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]182| **403** | ECOMP component is not authorized - POL5003 | No Content |
183+---------+----------------------------------------------------+----------------+
184| **404** | Specified artifact is not found - SVC4505 | No Content |
185+---------+----------------------------------------------------+----------------+
186| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
187| | (PUT,DELETE,POST will be rejected) - POL4050 | |
188+---------+----------------------------------------------------+----------------+
189| **500** | The GET request failed either due to internal SDC | No Content |
190| | problem or Cambria Service failure. ECOMP | |
191| | Component should continue the attempts to get the | |
192| | needed information - POL5000 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]193+---------+----------------------------------------------------+----------------+
194
195Consumes
196~~~~~~~~
197
198- ``application/json``
199
200Produces
201~~~~~~~~
202
203- ``application/octet-stream``
204
205Tags
206~~~~
207
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]208- Distribution Catalog Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]209
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]210Download resource instance artifact by artifact name
211----------------------------------------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]212
213::
214
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]215 GET /v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]216
217Description
218~~~~~~~~~~~
219
220Returns downloaded artifact
221
222Parameters
223~~~~~~~~~~
224
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]225+----------+-------------+--------------------------------------+------------------+
226| Type | Name | Description | Schema |
227+==========+=============+======================================+==================+
228| **Header | **Accept**\ | Determines the format of the body of | string |
229| ** | *optional* | the response | |
230+----------+-------------+--------------------------------------+------------------+
231| **Header | **Authoriza | The username and password | string |
232| ** | tion**\ *re | | |
233| | quired* | | |
234+----------+-------------+--------------------------------------+------------------+
235| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
236| ** | nstanceID** | | |
237| | \ *required | | |
238| | * | | |
239+----------+-------------+--------------------------------------+------------------+
240| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
241| ** | equestID**\ | | |
242| | *optional* | | |
243+----------+-------------+--------------------------------------+------------------+
244| **Path** | **artifactN | | string |
245| | ame**\ *req | | |
246| | uired* | | |
247+----------+-------------+--------------------------------------+------------------+
248| **Path** | **resourceI | | string |
249| | nstanceName | | |
250| | **\ *requir | | |
251| | ed* | | |
252+----------+-------------+--------------------------------------+------------------+
253| **Path** | **serviceNa | | string |
254| | me**\ *requ | | |
255| | ired* | | |
256+----------+-------------+--------------------------------------+------------------+
257| **Path** | **serviceVe | | string |
258| | rsion**\ *r | | |
259| | equired* | | |
260+----------+-------------+--------------------------------------+------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]261
262Responses
263~~~~~~~~~
264
265+---------+----------------------------------------------------+----------------+
266| HTTP | Description | Schema |
267| Code | | |
268+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]269| **200** | The artifact is found and streamed. | string |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]270+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]271| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
272+---------+----------------------------------------------------+----------------+
273| **401** | ECOMP component should authenticate itself and to | No Content |
274| | re-send again HTTP request with its Basic | |
275| | Authentication credentials - POL5002 | |
276+---------+----------------------------------------------------+----------------+
277| **403** | ECOMP component is not authorized - POL5003 | No Content |
278+---------+----------------------------------------------------+----------------+
279| **404** | Specified artifact is not found - SVC4505 | No Content |
280+---------+----------------------------------------------------+----------------+
281| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
282| | (PUT,DELETE,POST will be rejected) - POL4050 | |
283+---------+----------------------------------------------------+----------------+
284| **500** | The GET request failed either due to internal SDC | No Content |
285| | problem or Cambria Service failure. ECOMP | |
286| | Component should continue the attempts to get the | |
287| | needed information - POL5000 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]288+---------+----------------------------------------------------+----------------+
289
290Consumes
291~~~~~~~~
292
293- ``application/json``
294
295Produces
296~~~~~~~~
297
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]298- ``application/octet-stream``
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]299
300Tags
301~~~~
302
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]303- Distribution Catalog Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]304
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]305Download resource artifact
306--------------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]307
308::
309
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]310 GET /v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]311
312Description
313~~~~~~~~~~~
314
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]315Returns downloaded artifact
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]316
317Parameters
318~~~~~~~~~~
319
320+----------+-------------+--------------------------------------+------------------+
321| Type | Name | Description | Schema |
322+==========+=============+======================================+==================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]323| **Header | **Accept**\ | Determines the format of the body of | string |
324| ** | *optional* | the response | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]325+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]326| **Header | **Authoriza | The username and password | string |
327| ** | tion**\ *re | | |
328| | quired* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]329+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]330| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
331| ** | nstanceID** | | |
332| | \ *required | | |
333| | * | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]334+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]335| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
336| ** | equestID**\ | | |
337| | *optional* | | |
338+----------+-------------+--------------------------------------+------------------+
339| **Path** | **artifactN | | string |
340| | ame**\ *req | | |
341| | uired* | | |
342+----------+-------------+--------------------------------------+------------------+
343| **Path** | **resourceN | | string |
344| | ame**\ *req | | |
345| | uired* | | |
346+----------+-------------+--------------------------------------+------------------+
347| **Path** | **resourceV | | string |
348| | ersion**\ * | | |
349| | required* | | |
350+----------+-------------+--------------------------------------+------------------+
351| **Path** | **serviceNa | | string |
352| | me**\ *requ | | |
353| | ired* | | |
354+----------+-------------+--------------------------------------+------------------+
355| **Path** | **serviceVe | | string |
356| | rsion**\ *r | | |
357| | equired* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]358+----------+-------------+--------------------------------------+------------------+
359
360Responses
361~~~~~~~~~
362
363+---------+----------------------------------------------------+----------------+
364| HTTP | Description | Schema |
365| Code | | |
366+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]367| **200** | The artifact is found and streamed. | string |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]368+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]369| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]370+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]371| **401** | ECOMP component should authenticate itself and to | No Content |
372| | re-send again HTTP request with its Basic | |
373| | Authentication credentials - POL5002 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]374+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]375| **403** | ECOMP component is not authorized - POL5003 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]376+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]377| **404** | Specified artifact is not found - SVC4505 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]378+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]379| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
380| | (PUT,DELETE,POST will be rejected) - POL4050 | |
381+---------+----------------------------------------------------+----------------+
382| **500** | The GET request failed either due to internal SDC | No Content |
383| | problem or Cambria Service failure. ECOMP | |
384| | Component should continue the attempts to get the | |
385| | needed information - POL5000 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]386+---------+----------------------------------------------------+----------------+
387
388Consumes
389~~~~~~~~
390
391- ``application/json``
392
393Produces
394~~~~~~~~
395
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]396- ``application/octet-stream``
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]397
398Tags
399~~~~
400
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]401- Distribution Catalog Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]402
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]403creates a resource
404------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]405
406::
407
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]408 POST /v1/catalog/{assetType}
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]409
410Description
411~~~~~~~~~~~
412
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]413Creates a resource
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]414
415Parameters
416~~~~~~~~~~
417
418+----------+-------------+--------------------------------------+------------------+
419| Type | Name | Description | Schema |
420+==========+=============+======================================+==================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]421| **Header | **Accept**\ | Determines the format of the body of | string |
422| ** | *optional* | the response | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]423+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]424| **Header | **Authoriza | The username and password | string |
425| ** | tion**\ *re | | |
426| | quired* | | |
427+----------+-------------+--------------------------------------+------------------+
428| **Header | **Content-T | Determines the format of the body of | string |
429| ** | ype**\ *req | the request | |
430| | uired* | | |
431+----------+-------------+--------------------------------------+------------------+
432| **Header | **USER\_ID* | The user id | string |
433| ** | *\ *require | | |
434| | d* | | |
435+----------+-------------+--------------------------------------+------------------+
436| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
437| ** | nstanceID** | | |
438| | \ *required | | |
439| | * | | |
440+----------+-------------+--------------------------------------+------------------+
441| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
442| ** | equestID**\ | | |
443| | *optional* | | |
444+----------+-------------+--------------------------------------+------------------+
445| **Path** | **assetType | The requested asset type | enum (resources, |
446| | **\ *requir | | services) |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]447| | ed* | | |
448+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]449| **Body** | **body**\ * | | string |
450| | optional* | | |
451+----------+-------------+--------------------------------------+------------------+
452
453Responses
454~~~~~~~~~
455
456+---------+----------------------------------------------------+----------------+
457| HTTP | Description | Schema |
458| Code | | |
459+=========+====================================================+================+
460| **200** | ECOMP component is authenticated and Asset created | `Resource <#_r |
461| | | esource>`__ |
462+---------+----------------------------------------------------+----------------+
463| **400** | Create VFCMT request: VFCMT name exceeds character | No Content |
464| | limit - SVC4073 | |
465+---------+----------------------------------------------------+----------------+
466| **401** | ECOMP component should authenticate itself and to | No Content |
467| | re-send again HTTP request with its Basic | |
468| | Authentication credentials - POL5002 | |
469+---------+----------------------------------------------------+----------------+
470| **403** | ECOMP component is not authorized - POL5003 | No Content |
471+---------+----------------------------------------------------+----------------+
472| **404** | Error: Requested *%1* (uuid) resource was not | No Content |
473| | found - SVC4063 | |
474+---------+----------------------------------------------------+----------------+
475| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
476| | ( PUT,DELETE,POST will be rejected) - POL4050 | |
477+---------+----------------------------------------------------+----------------+
478| **500** | The GET request failed either due to internal SDC | No Content |
479| | problem. ECOMP Component should continue the | |
480| | attempts to get the needed information - POL5000 | |
481+---------+----------------------------------------------------+----------------+
482
483Consumes
484~~~~~~~~
485
486- ``application/json``
487
488Produces
489~~~~~~~~
490
491- ``application/json``
492
493Tags
494~~~~
495
496- CRUD External Servlet
497
498Fetch list of assets
499--------------------
500
501::
502
503 GET /v1/catalog/{assetType}
504
505Description
506~~~~~~~~~~~
507
508Returns list of assets
509
510Parameters
511~~~~~~~~~~
512
513+----------+-------------+--------------------------------------+------------------+
514| Type | Name | Description | Schema |
515+==========+=============+======================================+==================+
516| **Header | **Accept**\ | Determines the format of the body of | string |
517| ** | *optional* | the response | |
518+----------+-------------+--------------------------------------+------------------+
519| **Header | **Authoriza | The username and password | string |
520| ** | tion**\ *re | | |
521| | quired* | | |
522+----------+-------------+--------------------------------------+------------------+
523| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
524| ** | nstanceID** | | |
525| | \ *required | | |
526| | * | | |
527+----------+-------------+--------------------------------------+------------------+
528| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
529| ** | equestID**\ | | |
530| | *optional* | | |
531+----------+-------------+--------------------------------------+------------------+
532| **Path** | **assetType | The requested asset type | enum (resources, |
533| | **\ *requir | | services) |
534| | ed* | | |
535+----------+-------------+--------------------------------------+------------------+
536| **Query* | **category* | The filter key (resourceType only | string |
537| * | *\ *optiona | for resources) | |
538| | l* | | |
539+----------+-------------+--------------------------------------+------------------+
540| **Query* | **distribut | The filter key (resourceType only | string |
541| * | ionStatus** | for resources) | |
542| | \ *optional | | |
543| | * | | |
544+----------+-------------+--------------------------------------+------------------+
545| **Query* | **resourceT | The filter key (resourceType only | string |
546| * | ype**\ *opt | for resources) | |
547| | ional* | | |
548+----------+-------------+--------------------------------------+------------------+
549| **Query* | **subCatego | The filter key (resourceType only | string |
550| * | ry**\ *opti | for resources) | |
551| | onal* | | |
552+----------+-------------+--------------------------------------+------------------+
553
554Responses
555~~~~~~~~~
556
557+---------+----------------------------------------------------+----------------+
558| HTTP | Description | Schema |
559| Code | | |
560+=========+====================================================+================+
561| **200** | ECOMP component is authenticated and list of | < |
562| | Catalog Assets Metadata is returned | `AssetMetadata |
563| | | <#_assetmetad |
564| | | ata>`__ |
565| | | > array |
566+---------+----------------------------------------------------+----------------+
567| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
568+---------+----------------------------------------------------+----------------+
569| **401** | ECOMP component should authenticate itself and to | No Content |
570| | re-send again HTTP request with its Basic | |
571| | Authentication credentials - POL5002 | |
572+---------+----------------------------------------------------+----------------+
573| **403** | ECOMP component is not authorized - POL5003 | No Content |
574+---------+----------------------------------------------------+----------------+
575| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
576| | ( PUT,DELETE,POST will be rejected) - POL4050 | |
577+---------+----------------------------------------------------+----------------+
578| **500** | The GET request failed either due to internal SDC | No Content |
579| | problem. ECOMP Component should continue the | |
580| | attempts to get the needed information - POL5000 | |
581+---------+----------------------------------------------------+----------------+
582
583Produces
584~~~~~~~~
585
586- ``application/json``
587
588Tags
589~~~~
590
591- Asset Metadata External Servlet
592
593uploads of artifact to a resource or service
594--------------------------------------------
595
596::
597
598 POST /v1/catalog/{assetType}/{uuid}/artifacts
599
600Description
601~~~~~~~~~~~
602
603uploads of artifact to a resource or service
604
605Parameters
606~~~~~~~~~~
607
608+----------+-------------+--------------------------------------+------------------+
609| Type | Name | Description | Schema |
610+==========+=============+======================================+==================+
611| **Header | **Accept**\ | Determines the format of the body of | string |
612| ** | *optional* | the response | |
613+----------+-------------+--------------------------------------+------------------+
614| **Header | **Authoriza | The username and password | string |
615| ** | tion**\ *re | | |
616| | quired* | | |
617+----------+-------------+--------------------------------------+------------------+
618| **Header | **Content-M | The value for this header must be | string |
619| ** | D5**\ *requ | the MD5 checksum over the whole json | |
620| | ired* | body | |
621+----------+-------------+--------------------------------------+------------------+
622| **Header | **Content-T | Determines the format of the body of | string |
623| ** | ype**\ *req | the request | |
624| | uired* | | |
625+----------+-------------+--------------------------------------+------------------+
626| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
627| ** | *\ *require | This user must also have Designer | |
628| | d* | role in SDC | |
629+----------+-------------+--------------------------------------+------------------+
630| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
631| ** | nstanceID** | | |
632| | \ *required | | |
633| | * | | |
634+----------+-------------+--------------------------------------+------------------+
635| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
636| ** | equestID**\ | | |
637| | *optional* | | |
638+----------+-------------+--------------------------------------+------------------+
639| **Path** | **assetType | The requested asset type | enum (resources, |
640| | **\ *requir | | services) |
641| | ed* | | |
642+----------+-------------+--------------------------------------+------------------+
643| **Path** | **uuid**\ * | The uuid of the asset as published | string |
644| | required* | in the metadata | |
645+----------+-------------+--------------------------------------+------------------+
646| **Body** | **body**\ * | | string |
647| | optional* | | |
648+----------+-------------+--------------------------------------+------------------+
649
650Responses
651~~~~~~~~~
652
653+---------+----------------------------------------------------+----------------+
654| HTTP | Description | Schema |
655| Code | | |
656+=========+====================================================+================+
657| **200** | Artifact uploaded | `ArtifactDefin |
658| | | ition <#_artif |
659| | | actdefinition> |
660| | | `__ |
661+---------+----------------------------------------------------+----------------+
662| **400** | Restricted Operation – the user provided does not | No Content |
663| | have role of Designer or the asset is being used | |
664| | by another designer - SVC4301 | |
665+---------+----------------------------------------------------+----------------+
666| **401** | ECOMP component should authenticate itself and to | No Content |
667| | re-send again HTTP request with its Basic | |
668| | Authentication credentials - POL5002 | |
669+---------+----------------------------------------------------+----------------+
670| **403** | ECOMP component is not authorized - POL5003 | No Content |
671+---------+----------------------------------------------------+----------------+
672| **404** | Specified resource is not found - SVC4063 | No Content |
673+---------+----------------------------------------------------+----------------+
674| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
675| | (PUT,DELETE,POST will be rejected) - POL4050 | |
676+---------+----------------------------------------------------+----------------+
677| **500** | The GET request failed either due to internal SDC | No Content |
678| | problem or Cambria Service failure. ECOMP | |
679| | Component should continue the attempts to get the | |
680| | needed information - POL5000 | |
681+---------+----------------------------------------------------+----------------+
682
683Produces
684~~~~~~~~
685
686- ``application/json``
687
688Tags
689~~~~
690
691- Artifact External Servlet
692
693updates an artifact on a resource or service
694--------------------------------------------
695
696::
697
698 POST /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
699
700Description
701~~~~~~~~~~~
702
703uploads of artifact to a resource or service
704
705Parameters
706~~~~~~~~~~
707
708+----------+-------------+--------------------------------------+------------------+
709| Type | Name | Description | Schema |
710+==========+=============+======================================+==================+
711| **Header | **Accept**\ | Determines the format of the body of | string |
712| ** | *optional* | the response | |
713+----------+-------------+--------------------------------------+------------------+
714| **Header | **Authoriza | The username and password | string |
715| ** | tion**\ *re | | |
716| | quired* | | |
717+----------+-------------+--------------------------------------+------------------+
718| **Header | **Content-M | The value for this header must be | string |
719| ** | D5**\ *requ | the MD5 checksum over the whole json | |
720| | ired* | body | |
721+----------+-------------+--------------------------------------+------------------+
722| **Header | **Content-T | Determines the format of the body of | string |
723| ** | ype**\ *req | the request | |
724| | uired* | | |
725+----------+-------------+--------------------------------------+------------------+
726| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
727| ** | *\ *require | This user must also have Designer | |
728| | d* | role in SDC | |
729+----------+-------------+--------------------------------------+------------------+
730| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
731| ** | nstanceID** | | |
732| | \ *required | | |
733| | * | | |
734+----------+-------------+--------------------------------------+------------------+
735| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
736| ** | equestID**\ | | |
737| | *optional* | | |
738+----------+-------------+--------------------------------------+------------------+
739| **Path** | **artifactU | The uuid of the artifact as | string |
740| | UID**\ *req | published in the asset detailed | |
741| | uired* | metadata or in the response of the | |
742| | | upload / update operation | |
743+----------+-------------+--------------------------------------+------------------+
744| **Path** | **assetType | The requested asset type | enum (resources, |
745| | **\ *requir | | services) |
746| | ed* | | |
747+----------+-------------+--------------------------------------+------------------+
748| **Path** | **uuid**\ * | The uuid of the asset as published | string |
749| | required* | in the metadata | |
750+----------+-------------+--------------------------------------+------------------+
751| **Body** | **body**\ * | | string |
752| | optional* | | |
753+----------+-------------+--------------------------------------+------------------+
754
755Responses
756~~~~~~~~~
757
758+---------+----------------------------------------------------+----------------+
759| HTTP | Description | Schema |
760| Code | | |
761+=========+====================================================+================+
762| **200** | Artifact updated | `ArtifactDefin |
763| | | ition <#_artif |
764| | | actdefinition> |
765| | | `__ |
766+---------+----------------------------------------------------+----------------+
767| **400** | Artifact name is missing in input - SVC4128 | No Content |
768+---------+----------------------------------------------------+----------------+
769| **401** | ECOMP component should authenticate itself and to | No Content |
770| | re-send again HTTP request with its Basic | |
771| | Authentication credentials - POL5002 | |
772+---------+----------------------------------------------------+----------------+
773| **403** | Asset is being edited by different user. Only one | No Content |
774| | user can checkout and edit an asset on given time. | |
775| | The asset will be available for checkout after the | |
776| | other user will checkin the asset - SVC4086 | |
777+---------+----------------------------------------------------+----------------+
778| **404** | Specified resource is not found - SVC4063 | No Content |
779+---------+----------------------------------------------------+----------------+
780| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
781| | (PUT,DELETE,POST will be rejected) - POL4050 | |
782+---------+----------------------------------------------------+----------------+
783| **409** | Restricted Operation – the user provided does not | No Content |
784| | have role of Designer or the asset is being used | |
785| | by another designer - SVC4301 | |
786+---------+----------------------------------------------------+----------------+
787| **500** | The GET request failed either due to internal SDC | No Content |
788| | problem or Cambria Service failure. ECOMP | |
789| | Component should continue the attempts to get the | |
790| | needed information - POL5000 | |
791+---------+----------------------------------------------------+----------------+
792
793Produces
794~~~~~~~~
795
796- ``application/json``
797
798Tags
799~~~~
800
801- Artifact External Servlet
802
803Download component artifact
804---------------------------
805
806::
807
808 GET /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
809
810Description
811~~~~~~~~~~~
812
813Returns downloaded artifact
814
815Parameters
816~~~~~~~~~~
817
818+----------+-------------+--------------------------------------+------------------+
819| Type | Name | Description | Schema |
820+==========+=============+======================================+==================+
821| **Header | **Accept**\ | Determines the format of the body of | string |
822| ** | *optional* | the response | |
823+----------+-------------+--------------------------------------+------------------+
824| **Header | **Authoriza | The username and password | string |
825| ** | tion**\ *re | | |
826| | quired* | | |
827+----------+-------------+--------------------------------------+------------------+
828| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
829| ** | *\ *require | This user must also have Designer | |
830| | d* | role in SDC | |
831+----------+-------------+--------------------------------------+------------------+
832| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
833| ** | nstanceID** | | |
834| | \ *required | | |
835| | * | | |
836+----------+-------------+--------------------------------------+------------------+
837| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
838| ** | equestID**\ | | |
839| | *optional* | | |
840+----------+-------------+--------------------------------------+------------------+
841| **Path** | **artifactU | The uuid of the artifact as | string |
842| | UID**\ *req | published in the asset detailed | |
843| | uired* | metadata or in the response of the | |
844| | | upload / update operation | |
845+----------+-------------+--------------------------------------+------------------+
846| **Path** | **assetType | The requested asset type | enum (resources, |
847| | **\ *requir | | services) |
848| | ed* | | |
849+----------+-------------+--------------------------------------+------------------+
850| **Path** | **uuid**\ * | The uuid of the asset as published | string |
851| | required* | in the metadata | |
852+----------+-------------+--------------------------------------+------------------+
853
854Responses
855~~~~~~~~~
856
857+---------+----------------------------------------------------+----------------+
858| HTTP | Description | Schema |
859| Code | | |
860+=========+====================================================+================+
861| **200** | Artifact downloaded | string |
862+---------+----------------------------------------------------+----------------+
863| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
864+---------+----------------------------------------------------+----------------+
865| **401** | ECOMP component should authenticate itself and to | No Content |
866| | re-send again HTTP request with its Basic | |
867| | Authentication credentials - POL5002 | |
868+---------+----------------------------------------------------+----------------+
869| **403** | ECOMP component is not authorized - POL5003 | No Content |
870+---------+----------------------------------------------------+----------------+
871| **404** | Artifact was not found - SVC4505 | No Content |
872+---------+----------------------------------------------------+----------------+
873| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
874| | (PUT,DELETE,POST will be rejected) - POL4050 | |
875+---------+----------------------------------------------------+----------------+
876| **500** | The GET request failed either due to internal SDC | No Content |
877| | problem or Cambria Service failure. ECOMP | |
878| | Component should continue the attempts to get the | |
879| | needed information - POL5000 | |
880+---------+----------------------------------------------------+----------------+
881
882Produces
883~~~~~~~~
884
885- ``application/octet-stream``
886
887Tags
888~~~~
889
890- Artifact External Servlet
891
892deletes an artifact of a resource or service
893--------------------------------------------
894
895::
896
897 DELETE /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
898
899Description
900~~~~~~~~~~~
901
902deletes an artifact of a resource or service
903
904Parameters
905~~~~~~~~~~
906
907+----------+-------------+--------------------------------------+------------------+
908| Type | Name | Description | Schema |
909+==========+=============+======================================+==================+
910| **Header | **Accept**\ | Determines the format of the body of | string |
911| ** | *optional* | the response | |
912+----------+-------------+--------------------------------------+------------------+
913| **Header | **Authoriza | The username and password | string |
914| ** | tion**\ *re | | |
915| | quired* | | |
916+----------+-------------+--------------------------------------+------------------+
917| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
918| ** | *\ *require | This user must also have Designer | |
919| | d* | role in SDC | |
920+----------+-------------+--------------------------------------+------------------+
921| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
922| ** | nstanceID** | | |
923| | \ *required | | |
924| | * | | |
925+----------+-------------+--------------------------------------+------------------+
926| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
927| ** | equestID**\ | | |
928| | *optional* | | |
929+----------+-------------+--------------------------------------+------------------+
930| **Path** | **artifactU | The uuid of the artifact as | string |
931| | UID**\ *req | published in the asset detailed | |
932| | uired* | metadata or in the response of the | |
933| | | upload / update operation | |
934+----------+-------------+--------------------------------------+------------------+
935| **Path** | **assetType | The requested asset type | enum (resources, |
936| | **\ *requir | | services) |
937| | ed* | | |
938+----------+-------------+--------------------------------------+------------------+
939| **Path** | **uuid**\ * | The uuid of the asset as published | string |
940| | required* | in the metadata | |
941+----------+-------------+--------------------------------------+------------------+
942
943Responses
944~~~~~~~~~
945
946+---------+----------------------------------------------------+----------------+
947| HTTP | Description | Schema |
948| Code | | |
949+=========+====================================================+================+
950| **200** | Artifact deleted | `ArtifactDefin |
951| | | ition <#_artif |
952| | | actdefinition> |
953| | | `__ |
954+---------+----------------------------------------------------+----------------+
955| **400** | Artifact name is missing in input - SVC4128 | No Content |
956+---------+----------------------------------------------------+----------------+
957| **401** | ECOMP component should authenticate itself and to | No Content |
958| | re-send again HTTP request with its Basic | |
959| | Authentication credentials - POL5002 | |
960+---------+----------------------------------------------------+----------------+
961| **403** | Asset is being edited by different user. Only one | No Content |
962| | user can checkout and edit an asset on given time. | |
963| | The asset will be available for checkout after the | |
964| | other user will checkin the asset - SVC4086 | |
965+---------+----------------------------------------------------+----------------+
966| **404** | Specified resource is not found - SVC4063 | No Content |
967+---------+----------------------------------------------------+----------------+
968| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
969| | (PUT,DELETE,POST will be rejected) - POL4050 | |
970+---------+----------------------------------------------------+----------------+
971| **409** | Restricted Operation – the user provided does not | No Content |
972| | have role of Designer or the asset is being used | |
973| | by another designer - SVC4301 | |
974+---------+----------------------------------------------------+----------------+
975| **500** | The GET request failed either due to internal SDC | No Content |
976| | problem or Cambria Service failure. ECOMP | |
977| | Component should continue the attempts to get the | |
978| | needed information - POL5000 | |
979+---------+----------------------------------------------------+----------------+
980
981Produces
982~~~~~~~~
983
984- ``application/json``
985
986Tags
987~~~~
988
989- Artifact External Servlet
990
991Change Resource lifecycle State
992-------------------------------
993
994::
995
996 POST /v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}
997
998Parameters
999~~~~~~~~~~
1000
1001+----------+-------------+--------------------------------------+------------------+
1002| Type | Name | Description | Schema |
1003+==========+=============+======================================+==================+
1004| **Header | **Accept**\ | Determines the format of the body of | string |
1005| ** | *optional* | the response | |
1006+----------+-------------+--------------------------------------+------------------+
1007| **Header | **Authoriza | The username and password | string |
1008| ** | tion**\ *re | | |
1009| | quired* | | |
1010+----------+-------------+--------------------------------------+------------------+
1011| **Header | **Content-T | Determines the format of the body of | string |
1012| ** | ype**\ *req | the request | |
1013| | uired* | | |
1014+----------+-------------+--------------------------------------+------------------+
1015| **Header | **USER\_ID* | The user id | string |
1016| ** | *\ *require | | |
1017| | d* | | |
1018+----------+-------------+--------------------------------------+------------------+
1019| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1020| ** | nstanceID** | | |
1021| | \ *required | | |
1022| | * | | |
1023+----------+-------------+--------------------------------------+------------------+
1024| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1025| ** | equestID**\ | | |
1026| | *optional* | | |
1027+----------+-------------+--------------------------------------+------------------+
1028| **Path** | **assetType | validValues: resources / services | enum (resources, |
1029| | **\ *requir | | services) |
1030| | ed* | | |
1031+----------+-------------+--------------------------------------+------------------+
1032| **Path** | **lifecycle | | enum (checkout, |
1033| | Operation** | | checkin) |
1034| | \ *required | | |
1035| | * | | |
1036+----------+-------------+--------------------------------------+------------------+
1037| **Path** | **uuid**\ * | id of component to be changed | string |
1038| | required* | | |
1039+----------+-------------+--------------------------------------+------------------+
1040| **Body** | **body**\ * | | string |
1041| | optional* | | |
1042+----------+-------------+--------------------------------------+------------------+
1043
1044Responses
1045~~~~~~~~~
1046
1047+---------+----------------------------------------------------+----------------+
1048| HTTP | Description | Schema |
1049| Code | | |
1050+=========+====================================================+================+
1051| **200** | Resource state changed | `AssetMetadata |
1052| | | <#_assetmetad |
1053| | | ata>`__ |
1054+---------+----------------------------------------------------+----------------+
1055| **400** | Missing X-ECOMP-InstanceID HTTP header - POL5001 | No Content |
1056+---------+----------------------------------------------------+----------------+
1057| **401** | ECOMP component should authenticate itself and to | No Content |
1058| | re-send again HTTP request with its Basic | |
1059| | Authentication credentials - POL5002 | |
1060+---------+----------------------------------------------------+----------------+
1061| **403** | Asset is being edited by different user. Only one | No Content |
1062| | user can checkout and edit an asset on given time. | |
1063| | The asset will be available for checkout after the | |
1064| | other user will checkin the asset - SVC4080 | |
1065+---------+----------------------------------------------------+----------------+
1066| **404** | Error: Requested *%1* (uuid) resource was not | No Content |
1067| | found - SVC4063 | |
1068+---------+----------------------------------------------------+----------------+
1069| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
1070| | ( PUT,DELETE,POST will be rejected) - POL4050 | |
1071+---------+----------------------------------------------------+----------------+
1072| **500** | The GET request failed either due to internal SDC | No Content |
1073| | problem. ECOMP Component should continue the | |
1074| | attempts to get the needed information - POL5000 | |
1075+---------+----------------------------------------------------+----------------+
1076
1077Consumes
1078~~~~~~~~
1079
1080- ``application/json``
1081
1082Produces
1083~~~~~~~~
1084
1085- ``application/json``
1086
1087Tags
1088~~~~
1089
1090- CRUD External Servlet
1091
1092Detailed metadata of asset by uuid
1093----------------------------------
1094
1095::
1096
1097 GET /v1/catalog/{assetType}/{uuid}/metadata
1098
1099Description
1100~~~~~~~~~~~
1101
1102Returns detailed metadata of an asset by uuid
1103
1104Parameters
1105~~~~~~~~~~
1106
1107+----------+-------------+--------------------------------------+------------------+
1108| Type | Name | Description | Schema |
1109+==========+=============+======================================+==================+
1110| **Header | **Accept**\ | Determines the format of the body of | string |
1111| ** | *optional* | the response | |
1112+----------+-------------+--------------------------------------+------------------+
1113| **Header | **Authoriza | The username and password | string |
1114| ** | tion**\ *re | | |
1115| | quired* | | |
1116+----------+-------------+--------------------------------------+------------------+
1117| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1118| ** | nstanceID** | | |
1119| | \ *required | | |
1120| | * | | |
1121+----------+-------------+--------------------------------------+------------------+
1122| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1123| ** | equestID**\ | | |
1124| | *optional* | | |
1125+----------+-------------+--------------------------------------+------------------+
1126| **Path** | **assetType | The requested asset type | enum (resources, |
1127| | **\ *requir | | services) |
1128| | ed* | | |
1129+----------+-------------+--------------------------------------+------------------+
1130| **Path** | **uuid**\ * | The requested asset uuid | string |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1131| | required* | | |
1132+----------+-------------+--------------------------------------+------------------+
1133
1134Responses
1135~~~~~~~~~
1136
1137+---------+----------------------------------------------------+----------------+
1138| HTTP | Description | Schema |
1139| Code | | |
1140+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1141| **200** | ECOMP component is authenticated and list of | < |
1142| | Catalog Assets Metadata is returned | `AssetMetadata |
1143| | | <#_assetmetad |
1144| | | ata>`__ |
1145| | | > array |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1146+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1147| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1148+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1149| **401** | ECOMP component should authenticate itself and to | No Content |
1150| | re-send again HTTP request with its Basic | |
1151| | Authentication credentials - POL5002 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1152+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1153| **403** | ECOMP component is not authorized - POL5003 | No Content |
1154+---------+----------------------------------------------------+----------------+
1155| **404** | Error: Requested *%1* (uuid) resource was not | No Content |
1156| | found - SVC4063 | |
1157+---------+----------------------------------------------------+----------------+
1158| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
1159| | ( PUT,DELETE,POST will be rejected) - POL4050 | |
1160+---------+----------------------------------------------------+----------------+
1161| **500** | The GET request failed either due to internal SDC | No Content |
1162| | problem. ECOMP Component should continue the | |
1163| | attempts to get the needed information - POL5000 | |
1164+---------+----------------------------------------------------+----------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1165
1166Produces
1167~~~~~~~~
1168
1169- ``application/json``
1170
1171Tags
1172~~~~
1173
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1174- Asset Metadata External Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1175
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1176uploads an artifact to a resource instance
1177------------------------------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1178
1179::
1180
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1181 POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1182
1183Description
1184~~~~~~~~~~~
1185
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1186uploads an artifact to a resource instance
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1187
1188Parameters
1189~~~~~~~~~~
1190
1191+----------+-------------+--------------------------------------+------------------+
1192| Type | Name | Description | Schema |
1193+==========+=============+======================================+==================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1194| **Header | **Accept**\ | Determines the format of the body of | string |
1195| ** | *optional* | the response | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1196+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1197| **Header | **Authoriza | The username and password | string |
1198| ** | tion**\ *re | | |
1199| | quired* | | |
1200+----------+-------------+--------------------------------------+------------------+
1201| **Header | **Content-M | The value for this header must be | string |
1202| ** | D5**\ *requ | the MD5 checksum over the whole json | |
1203| | ired* | body | |
1204+----------+-------------+--------------------------------------+------------------+
1205| **Header | **Content-T | Determines the format of the body of | string |
1206| ** | ype**\ *req | the request | |
1207| | uired* | | |
1208+----------+-------------+--------------------------------------+------------------+
1209| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
1210| ** | *\ *require | This user must also have Designer | |
1211| | d* | role in SDC | |
1212+----------+-------------+--------------------------------------+------------------+
1213| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1214| ** | nstanceID** | | |
1215| | \ *required | | |
1216| | * | | |
1217+----------+-------------+--------------------------------------+------------------+
1218| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1219| ** | equestID**\ | | |
1220| | *optional* | | |
1221+----------+-------------+--------------------------------------+------------------+
1222| **Path** | **assetType | The requested asset type | enum (resources, |
1223| | **\ *requir | | services) |
1224| | ed* | | |
1225+----------+-------------+--------------------------------------+------------------+
1226| **Path** | **resourceI | The component instance name (as | string |
1227| | nstanceName | publishedin the response of the | |
1228| | **\ *requir | detailed query) | |
1229| | ed* | | |
1230+----------+-------------+--------------------------------------+------------------+
1231| **Path** | **uuid**\ * | The uuid of the asset as published | string |
1232| | required* | in the metadata | |
1233+----------+-------------+--------------------------------------+------------------+
1234| **Body** | **body**\ * | | string |
1235| | optional* | | |
1236+----------+-------------+--------------------------------------+------------------+
1237
1238Responses
1239~~~~~~~~~
1240
1241+---------+----------------------------------------------------+----------------+
1242| HTTP | Description | Schema |
1243| Code | | |
1244+=========+====================================================+================+
1245| **200** | Artifact uploaded | `ArtifactDefin |
1246| | | ition <#_artif |
1247| | | actdefinition> |
1248| | | `__ |
1249+---------+----------------------------------------------------+----------------+
1250| **400** | Restricted Operation – the user provided does not | No Content |
1251| | have role of Designer or the asset is being used | |
1252| | by another designer - SVC4301 | |
1253+---------+----------------------------------------------------+----------------+
1254| **401** | ECOMP component should authenticate itself and to | No Content |
1255| | re-send again HTTP request with its Basic | |
1256| | Authentication credentials - POL5002 | |
1257+---------+----------------------------------------------------+----------------+
1258| **403** | ECOMP component is not authorized - POL5003 | No Content |
1259+---------+----------------------------------------------------+----------------+
1260| **404** | Specified resource is not found - SVC4063 | No Content |
1261+---------+----------------------------------------------------+----------------+
1262| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
1263| | (PUT,DELETE,POST will be rejected) - POL4050 | |
1264+---------+----------------------------------------------------+----------------+
1265| **500** | The GET request failed either due to internal SDC | No Content |
1266| | problem or Cambria Service failure. ECOMP | |
1267| | Component should continue the attempts to get the | |
1268| | needed information - POL5000 | |
1269+---------+----------------------------------------------------+----------------+
1270
1271Produces
1272~~~~~~~~
1273
1274- ``application/json``
1275
1276Tags
1277~~~~
1278
1279- Artifact External Servlet
1280
1281updates an artifact on a resource instance
1282------------------------------------------
1283
1284::
1285
1286 POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
1287
1288Description
1289~~~~~~~~~~~
1290
1291uploads of artifact to a resource or service
1292
1293Parameters
1294~~~~~~~~~~
1295
1296+----------+-------------+--------------------------------------+------------------+
1297| Type | Name | Description | Schema |
1298+==========+=============+======================================+==================+
1299| **Header | **Accept**\ | Determines the format of the body of | string |
1300| ** | *optional* | the response | |
1301+----------+-------------+--------------------------------------+------------------+
1302| **Header | **Authoriza | The username and password | string |
1303| ** | tion**\ *re | | |
1304| | quired* | | |
1305+----------+-------------+--------------------------------------+------------------+
1306| **Header | **Content-M | The value for this header must be | string |
1307| ** | D5**\ *requ | the MD5 checksum over the whole json | |
1308| | ired* | body | |
1309+----------+-------------+--------------------------------------+------------------+
1310| **Header | **Content-T | Determines the format of the body of | string |
1311| ** | ype**\ *req | the request | |
1312| | uired* | | |
1313+----------+-------------+--------------------------------------+------------------+
1314| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
1315| ** | *\ *require | This user must also have Designer | |
1316| | d* | role in SDC | |
1317+----------+-------------+--------------------------------------+------------------+
1318| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1319| ** | nstanceID** | | |
1320| | \ *required | | |
1321| | * | | |
1322+----------+-------------+--------------------------------------+------------------+
1323| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1324| ** | equestID**\ | | |
1325| | *optional* | | |
1326+----------+-------------+--------------------------------------+------------------+
1327| **Path** | **artifactU | The uuid of the artifact as | string |
1328| | UID**\ *req | published in the asset detailed | |
1329| | uired* | metadata or in the response of the | |
1330| | | upload / update operation | |
1331+----------+-------------+--------------------------------------+------------------+
1332| **Path** | **assetType | The requested asset type | enum (resources, |
1333| | **\ *requir | | services) |
1334| | ed* | | |
1335+----------+-------------+--------------------------------------+------------------+
1336| **Path** | **resourceI | The component instance name (as | string |
1337| | nstanceName | publishedin the response of the | |
1338| | **\ *requir | detailed query) | |
1339| | ed* | | |
1340+----------+-------------+--------------------------------------+------------------+
1341| **Path** | **uuid**\ * | The uuid of the asset as published | string |
1342| | required* | in the metadata | |
1343+----------+-------------+--------------------------------------+------------------+
1344| **Body** | **body**\ * | | string |
1345| | optional* | | |
1346+----------+-------------+--------------------------------------+------------------+
1347
1348Responses
1349~~~~~~~~~
1350
1351+---------+----------------------------------------------------+----------------+
1352| HTTP | Description | Schema |
1353| Code | | |
1354+=========+====================================================+================+
1355| **200** | Artifact updated | `ArtifactDefin |
1356| | | ition <#_artif |
1357| | | actdefinition> |
1358| | | `__ |
1359+---------+----------------------------------------------------+----------------+
1360| **400** | Artifact name is missing in input - SVC4128 | No Content |
1361+---------+----------------------------------------------------+----------------+
1362| **401** | ECOMP component should authenticate itself and to | No Content |
1363| | re-send again HTTP request with its Basic | |
1364| | Authentication credentials - POL5002 | |
1365+---------+----------------------------------------------------+----------------+
1366| **403** | Asset is being edited by different user. Only one | No Content |
1367| | user can checkout and edit an asset on given time. | |
1368| | The asset will be available for checkout after the | |
1369| | other user will checkin the asset - SVC4086 | |
1370+---------+----------------------------------------------------+----------------+
1371| **404** | Specified resource is not found - SVC4063 | No Content |
1372+---------+----------------------------------------------------+----------------+
1373| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
1374| | (PUT,DELETE,POST will be rejected) - POL4050 | |
1375+---------+----------------------------------------------------+----------------+
1376| **409** | Restricted Operation – the user provided does not | No Content |
1377| | have role of Designer or the asset is being used | |
1378| | by another designer - SVC4301 | |
1379+---------+----------------------------------------------------+----------------+
1380| **500** | The GET request failed either due to internal SDC | No Content |
1381| | problem or Cambria Service failure. ECOMP | |
1382| | Component should continue the attempts to get the | |
1383| | needed information - POL5000 | |
1384+---------+----------------------------------------------------+----------------+
1385
1386Produces
1387~~~~~~~~
1388
1389- ``application/json``
1390
1391Tags
1392~~~~
1393
1394- Artifact External Servlet
1395
1396Download resource instance artifact by artifact UUID
1397----------------------------------------------------
1398
1399::
1400
1401 GET /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
1402
1403Description
1404~~~~~~~~~~~
1405
1406Returns downloaded artifact
1407
1408Parameters
1409~~~~~~~~~~
1410
1411+----------+-------------+--------------------------------------+------------------+
1412| Type | Name | Description | Schema |
1413+==========+=============+======================================+==================+
1414| **Header | **Accept**\ | Determines the format of the body of | string |
1415| ** | *optional* | the response | |
1416+----------+-------------+--------------------------------------+------------------+
1417| **Header | **Authoriza | The username and password | string |
1418| ** | tion**\ *re | | |
1419| | quired* | | |
1420+----------+-------------+--------------------------------------+------------------+
1421| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
1422| ** | *\ *require | This user must also have Designer | |
1423| | d* | role in SDC | |
1424+----------+-------------+--------------------------------------+------------------+
1425| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1426| ** | nstanceID** | | |
1427| | \ *required | | |
1428| | * | | |
1429+----------+-------------+--------------------------------------+------------------+
1430| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1431| ** | equestID**\ | | |
1432| | *optional* | | |
1433+----------+-------------+--------------------------------------+------------------+
1434| **Path** | **artifactU | The uuid of the artifact as | string |
1435| | UID**\ *req | published in the asset detailed | |
1436| | uired* | metadata or in the response of the | |
1437| | | upload / update operation | |
1438+----------+-------------+--------------------------------------+------------------+
1439| **Path** | **assetType | The requested asset type | enum (resources, |
1440| | **\ *requir | | services) |
1441| | ed* | | |
1442+----------+-------------+--------------------------------------+------------------+
1443| **Path** | **resourceI | The component instance name (as | string |
1444| | nstanceName | publishedin the response of the | |
1445| | **\ *requir | detailed query) | |
1446| | ed* | | |
1447+----------+-------------+--------------------------------------+------------------+
1448| **Path** | **uuid**\ * | The uuid of the asset as published | string |
1449| | required* | in the metadata | |
1450+----------+-------------+--------------------------------------+------------------+
1451
1452Responses
1453~~~~~~~~~
1454
1455+---------+----------------------------------------------------+----------------+
1456| HTTP | Description | Schema |
1457| Code | | |
1458+=========+====================================================+================+
1459| **200** | Artifact downloaded | string |
1460+---------+----------------------------------------------------+----------------+
1461| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
1462+---------+----------------------------------------------------+----------------+
1463| **401** | ECOMP component should authenticate itself and to | No Content |
1464| | re-send again HTTP request with its Basic | |
1465| | Authentication credentials - POL5002 | |
1466+---------+----------------------------------------------------+----------------+
1467| **403** | ECOMP component is not authorized - POL5003 | No Content |
1468+---------+----------------------------------------------------+----------------+
1469| **404** | Artifact was not found - SVC4505 | No Content |
1470+---------+----------------------------------------------------+----------------+
1471| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
1472| | (PUT,DELETE,POST will be rejected) - POL4050 | |
1473+---------+----------------------------------------------------+----------------+
1474| **500** | The GET request failed either due to internal SDC | No Content |
1475| | problem or Cambria Service failure. ECOMP | |
1476| | Component should continue the attempts to get the | |
1477| | needed information - POL5000 | |
1478+---------+----------------------------------------------------+----------------+
1479
1480Produces
1481~~~~~~~~
1482
1483- ``application/octet-stream``
1484
1485Tags
1486~~~~
1487
1488- Artifact External Servlet
1489
1490deletes an artifact of a resource insatnce
1491------------------------------------------
1492
1493::
1494
1495 DELETE /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
1496
1497Description
1498~~~~~~~~~~~
1499
1500deletes an artifact of a resource insatnce
1501
1502Parameters
1503~~~~~~~~~~
1504
1505+----------+-------------+--------------------------------------+------------------+
1506| Type | Name | Description | Schema |
1507+==========+=============+======================================+==================+
1508| **Header | **Accept**\ | Determines the format of the body of | string |
1509| ** | *optional* | the response | |
1510+----------+-------------+--------------------------------------+------------------+
1511| **Header | **Authoriza | The username and password | string |
1512| ** | tion**\ *re | | |
1513| | quired* | | |
1514+----------+-------------+--------------------------------------+------------------+
1515| **Header | **USER\_ID* | The user ID of the DCAE Designer. | string |
1516| ** | *\ *require | This user must also have Designer | |
1517| | d* | role in SDC | |
1518+----------+-------------+--------------------------------------+------------------+
1519| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1520| ** | nstanceID** | | |
1521| | \ *required | | |
1522| | * | | |
1523+----------+-------------+--------------------------------------+------------------+
1524| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1525| ** | equestID**\ | | |
1526| | *optional* | | |
1527+----------+-------------+--------------------------------------+------------------+
1528| **Path** | **artifactU | The uuid of the artifact as | string |
1529| | UID**\ *req | published in the asset detailed | |
1530| | uired* | metadata or in the response of the | |
1531| | | upload / update operation | |
1532+----------+-------------+--------------------------------------+------------------+
1533| **Path** | **assetType | The requested asset type | enum (resources, |
1534| | **\ *requir | | services) |
1535| | ed* | | |
1536+----------+-------------+--------------------------------------+------------------+
1537| **Path** | **resourceI | The component instance name (as | string |
1538| | nstanceName | publishedin the response of the | |
1539| | **\ *requir | detailed query) | |
1540| | ed* | | |
1541+----------+-------------+--------------------------------------+------------------+
1542| **Path** | **uuid**\ * | The uuid of the asset as published | string |
1543| | required* | in the metadata | |
1544+----------+-------------+--------------------------------------+------------------+
1545
1546Responses
1547~~~~~~~~~
1548
1549+---------+----------------------------------------------------+----------------+
1550| HTTP | Description | Schema |
1551| Code | | |
1552+=========+====================================================+================+
1553| **200** | Artifact deleted | `ArtifactDefin |
1554| | | ition <#_artif |
1555| | | actdefinition> |
1556| | | `__ |
1557+---------+----------------------------------------------------+----------------+
1558| **400** | Artifact name is missing in input - SVC4128 | No Content |
1559+---------+----------------------------------------------------+----------------+
1560| **401** | ECOMP component should authenticate itself and to | No Content |
1561| | re-send again HTTP request with its Basic | |
1562| | Authentication credentials - POL5002 | |
1563+---------+----------------------------------------------------+----------------+
1564| **403** | Asset is being edited by different user. Only one | No Content |
1565| | user can checkout and edit an asset on given time. | |
1566| | The asset will be available for checkout after the | |
1567| | other user will checkin the asset - SVC4086 | |
1568+---------+----------------------------------------------------+----------------+
1569| **404** | Specified resource is not found - SVC4063 | No Content |
1570+---------+----------------------------------------------------+----------------+
1571| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
1572| | (PUT,DELETE,POST will be rejected) - POL4050 | |
1573+---------+----------------------------------------------------+----------------+
1574| **409** | Restricted Operation – the user provided does not | No Content |
1575| | have role of Designer or the asset is being used | |
1576| | by another designer - SVC4301 | |
1577+---------+----------------------------------------------------+----------------+
1578| **500** | The GET request failed either due to internal SDC | No Content |
1579| | problem or Cambria Service failure. ECOMP | |
1580| | Component should continue the attempts to get the | |
1581| | needed information - POL5000 | |
1582+---------+----------------------------------------------------+----------------+
1583
1584Produces
1585~~~~~~~~
1586
1587- ``application/json``
1588
1589Tags
1590~~~~
1591
1592- Artifact External Servlet
1593
1594Fetch assets CSAR
1595-----------------
1596
1597::
1598
1599 GET /v1/catalog/{assetType}/{uuid}/toscaModel
1600
1601Description
1602~~~~~~~~~~~
1603
1604Returns asset csar
1605
1606Parameters
1607~~~~~~~~~~
1608
1609+----------+-------------+--------------------------------------+------------------+
1610| Type | Name | Description | Schema |
1611+==========+=============+======================================+==================+
1612| **Header | **Accept**\ | Determines the format of the body of | string |
1613| ** | *optional* | the response | |
1614+----------+-------------+--------------------------------------+------------------+
1615| **Header | **Authoriza | The username and password | string |
1616| ** | tion**\ *re | | |
1617| | quired* | | |
1618+----------+-------------+--------------------------------------+------------------+
1619| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1620| ** | nstanceID** | | |
1621| | \ *required | | |
1622| | * | | |
1623+----------+-------------+--------------------------------------+------------------+
1624| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1625| ** | equestID**\ | | |
1626| | *optional* | | |
1627+----------+-------------+--------------------------------------+------------------+
1628| **Path** | **assetType | The requested asset type | enum (resources, |
1629| | **\ *requir | | services) |
1630| | ed* | | |
1631+----------+-------------+--------------------------------------+------------------+
1632| **Path** | **uuid**\ * | The requested asset uuid | string |
1633| | required* | | |
1634+----------+-------------+--------------------------------------+------------------+
1635
1636Responses
1637~~~~~~~~~
1638
1639+---------+----------------------------------------------------+----------------+
1640| HTTP | Description | Schema |
1641| Code | | |
1642+=========+====================================================+================+
1643| **200** | ECOMP component is authenticated and list of | string |
1644| | Catalog Assets Metadata is returned | |
1645+---------+----------------------------------------------------+----------------+
1646| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
1647+---------+----------------------------------------------------+----------------+
1648| **401** | ECOMP component should authenticate itself and to | No Content |
1649| | re-send again HTTP request with its Basic | |
1650| | Authentication credentials - POL5002 | |
1651+---------+----------------------------------------------------+----------------+
1652| **403** | ECOMP component is not authorized - POL5003 | No Content |
1653+---------+----------------------------------------------------+----------------+
1654| **404** | Error: Requested *%1* (uuid) resource was not | No Content |
1655| | found - SVC4063 | |
1656+---------+----------------------------------------------------+----------------+
1657| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
1658| | ( PUT,DELETE,POST will be rejected) - POL4050 | |
1659+---------+----------------------------------------------------+----------------+
1660| **500** | The GET request failed either due to internal SDC | No Content |
1661| | problem. ECOMP Component should continue the | |
1662| | attempts to get the needed information - POL5000 | |
1663+---------+----------------------------------------------------+----------------+
1664
1665Produces
1666~~~~~~~~
1667
1668- ``application/octet-stream``
1669
1670Tags
1671~~~~
1672
1673- Asset Metadata External Servlet
1674
1675UEB Server List
1676---------------
1677
1678::
1679
1680 GET /v1/distributionUebCluster
1681
1682Description
1683~~~~~~~~~~~
1684
1685return the available UEB Server List
1686
1687Parameters
1688~~~~~~~~~~
1689
1690+----------+-------------+--------------------------------------+------------------+
1691| Type | Name | Description | Schema |
1692+==========+=============+======================================+==================+
1693| **Header | **Accept**\ | Determines the format of the body of | string |
1694| ** | *optional* | the response | |
1695+----------+-------------+--------------------------------------+------------------+
1696| **Header | **Authoriza | The username and password | string |
1697| ** | tion**\ *re | | |
1698| | quired* | | |
1699+----------+-------------+--------------------------------------+------------------+
1700| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1701| ** | nstanceID** | | |
1702| | \ *required | | |
1703| | * | | |
1704+----------+-------------+--------------------------------------+------------------+
1705| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1706| ** | equestID**\ | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1707| | *optional* | | |
1708+----------+-------------+--------------------------------------+------------------+
1709
1710Responses
1711~~~~~~~~~
1712
1713+---------+----------------------------------------------------+----------------+
1714| HTTP | Description | Schema |
1715| Code | | |
1716+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1717| **200** | ECOMP component is authenticated and list of | `ServerListRes |
1718| | Cambria API server’s FQDNs is returned | ponse <#_serve |
1719| | | rlistresponse> |
1720| | | `__ |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1721+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1722| **400** | Missing *X-ECOMP-InstanceID* HTTP header - POL5001 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1723+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1724| **401** | ECOMP component should authenticate itself and to | No Content |
1725| | re-send again HTTP request with its credentials | |
1726| | for Basic Authentication - POL5002 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1727+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1728| **403** | ECOMP component is not authorized - POL5003 | No Content |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1729+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1730| **405** | Method Not Allowed: Invalid HTTP method type used | No Content |
1731| | ( PUT,DELETE,POST will be rejected) - POL4050 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1732+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1733| **500** | The GET request failed either due to internal SDC | No Content |
1734| | problem or Cambria Service failure. ECOMP | |
1735| | Component should continue the attempts to get the | |
1736| | needed information - POL5000 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1737+---------+----------------------------------------------------+----------------+
1738
1739Consumes
1740~~~~~~~~
1741
1742- ``application/json``
1743
1744Produces
1745~~~~~~~~
1746
1747- ``application/json``
1748
1749Tags
1750~~~~
1751
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1752- Distribution Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1753
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1754Subscription status
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1755-------------------
1756
1757::
1758
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1759 POST /v1/registerForDistribution
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1760
1761Description
1762~~~~~~~~~~~
1763
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1764Subscribes for distribution notifications
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1765
1766Parameters
1767~~~~~~~~~~
1768
1769+----------+-------------+--------------------------------------+------------------+
1770| Type | Name | Description | Schema |
1771+==========+=============+======================================+==================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1772| **Header | **Accept**\ | Determines the format of the body of | string |
1773| ** | *optional* | the response | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1774+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1775| **Header | **Authoriza | The username and password | string |
1776| ** | tion**\ *re | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1777| | quired* | | |
1778+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1779| **Header | **Content-L | Length of the request body | string |
1780| ** | ength**\ *r | | |
1781| | equired* | | |
1782+----------+-------------+--------------------------------------+------------------+
1783| **Header | **Content-T | Determines the format of the body of | string |
1784| ** | ype**\ *req | the request | |
1785| | uired* | | |
1786+----------+-------------+--------------------------------------+------------------+
1787| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1788| ** | nstanceID** | | |
1789| | \ *required | | |
1790| | * | | |
1791+----------+-------------+--------------------------------------+------------------+
1792| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1793| ** | equestID**\ | | |
1794| | *optional* | | |
1795+----------+-------------+--------------------------------------+------------------+
1796| **Body** | **body**\ * | | string |
1797| | optional* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1798+----------+-------------+--------------------------------------+------------------+
1799
1800Responses
1801~~~~~~~~~
1802
1803+---------+----------------------------------------------------+----------------+
1804| HTTP | Description | Schema |
1805| Code | | |
1806+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1807| **200** | ECOMP component is successfully registered for | `TopicRegistra |
1808| | distribution | tionResponse < |
1809| | | #_topicregistr |
1810| | | ationresponse> |
1811| | | `__ |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1812+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1813| **400** | Invalid Body : Specified *distrEnvName* doesn’t | No Content |
1814| | exist - POL4137 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1815+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1816| **401** | ECOMP component should authenticate itself and to | No Content |
1817| | re-send again HTTP request with its Basic | |
1818| | Authentication credentials - POL5002 | |
1819+---------+----------------------------------------------------+----------------+
1820| **403** | ECOMP component is not authorized - POL5003 | No Content |
1821+---------+----------------------------------------------------+----------------+
1822| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
1823| | to register for distribution ( PUT,DELETE,GET will | |
1824| | be rejected) - POL4050 | |
1825+---------+----------------------------------------------------+----------------+
1826| **500** | The registration failed due to internal SDC | No Content |
1827| | problem or Cambria Service failure ECOMP Component | |
1828| | should continue the attempts to register for | |
1829| | distribution - POL5000 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1830+---------+----------------------------------------------------+----------------+
1831
1832Consumes
1833~~~~~~~~
1834
1835- ``application/json``
1836
1837Produces
1838~~~~~~~~
1839
1840- ``application/json``
1841
1842Tags
1843~~~~
1844
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1845- Distribution Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1846
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1847Subscription status
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1848-------------------
1849
1850::
1851
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1852 POST /v1/unRegisterForDistribution
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1853
1854Description
1855~~~~~~~~~~~
1856
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1857Removes from subscription for distribution notifications
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1858
1859Parameters
1860~~~~~~~~~~
1861
1862+----------+-------------+--------------------------------------+------------------+
1863| Type | Name | Description | Schema |
1864+==========+=============+======================================+==================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1865| **Header | **Accept**\ | Determines the format of the body of | string |
1866| ** | *optional* | the response | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1867+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1868| **Header | **Authoriza | The username and password | string |
1869| ** | tion**\ *re | | |
1870| | quired* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1871+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1872| **Header | **Content-L | Length of the request body | string |
1873| ** | ength**\ *r | | |
1874| | equired* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1875+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1876| **Header | **Content-T | Determines the format of the body of | string |
1877| ** | ype**\ *req | the request | |
1878| | uired* | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1879+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1880| **Header | **X-ECOMP-I | X-ECOMP-InstanceID header | string |
1881| ** | nstanceID** | | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1882| | \ *required | | |
1883| | * | | |
1884+----------+-------------+--------------------------------------+------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1885| **Header | **X-ECOMP-R | X-ECOMP-RequestID header | string |
1886| ** | equestID**\ | | |
1887| | *optional* | | |
1888+----------+-------------+--------------------------------------+------------------+
1889| **Body** | **body**\ * | | string |
1890| | optional* | | |
1891+----------+-------------+--------------------------------------+------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1892
1893Responses
1894~~~~~~~~~
1895
1896+---------+----------------------------------------------------+----------------+
1897| HTTP | Description | Schema |
1898| Code | | |
1899+=========+====================================================+================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1900| **204** | ECOMP component is successfully unregistered | `TopicUnregist |
1901| | | rationResponse |
1902| | | <#_topicunreg |
1903| | | istrationrespo |
1904| | | nse>`__ |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1905+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1906| **400** | Invalid Body : Specified *distrEnvName* doesn’t | No Content |
1907| | exist - POL4137 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1908+---------+----------------------------------------------------+----------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1909| **401** | ECOMP component should authenticate itself and to | No Content |
1910| | re-send again HTTP request with its Basic | |
1911| | Authentication credentials - POL5002 | |
1912+---------+----------------------------------------------------+----------------+
1913| **403** | ECOMP component is not authorized - POL5003 | No Content |
1914+---------+----------------------------------------------------+----------------+
1915| **405** | Method Not Allowed : Invalid HTTP method type used | No Content |
1916| | to register for distribution ( PUT,DELETE,GET will | |
1917| | be rejected) - POL4050 | |
1918+---------+----------------------------------------------------+----------------+
1919| **500** | The registration failed due to internal SDC | No Content |
1920| | problem or Cambria Service failure ECOMP Component | |
1921| | should continue the attempts to register for | |
1922| | distribution - POL5000 | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1923+---------+----------------------------------------------------+----------------+
1924
1925Consumes
1926~~~~~~~~
1927
1928- ``application/json``
1929
1930Produces
1931~~~~~~~~
1932
1933- ``application/json``
1934
1935Tags
1936~~~~
1937
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1938- Distribution Servlet
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1939
1940Definitions
1941===========
1942
1943AdditionalInfoParameterInfo
1944---------------------------
1945
1946+--------------------------------+-------------------------------------------+
1947| Name | Schema |
1948+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1949| **empty**\ *optional* | boolean |
1950+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1951| **key**\ *optional* | string |
1952+--------------------------------+-------------------------------------------+
1953| **ownerId**\ *optional* | string |
1954+--------------------------------+-------------------------------------------+
1955| **uniqueId**\ *optional* | string |
1956+--------------------------------+-------------------------------------------+
1957| **value**\ *optional* | string |
1958+--------------------------------+-------------------------------------------+
1959
1960AdditionalInformationDefinition
1961-------------------------------
1962
1963+--------------------------------+-------------------------------------------+
1964| Name | Schema |
1965+================================+===========================================+
1966| **creationTime**\ *optional* | integer (int64) |
1967+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]1968| **empty**\ *optional* | boolean |
1969+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]1970| **lastCreatedCounter**\ *optio | integer (int32) |
1971| nal* | |
1972+--------------------------------+-------------------------------------------+
1973| **modificationTime**\ *optiona | integer (int64) |
1974| l* | |
1975+--------------------------------+-------------------------------------------+
1976| **ownerId**\ *optional* | string |
1977+--------------------------------+-------------------------------------------+
1978| **parameters**\ *optional* | < |
1979| | `AdditionalInfoParameterInfo <#_additiona |
1980| | linfoparameterinfo>`__ |
1981| | > array |
1982+--------------------------------+-------------------------------------------+
1983| **parentUniqueId**\ *optional* | string |
1984+--------------------------------+-------------------------------------------+
1985| **uniqueId**\ *optional* | string |
1986+--------------------------------+-------------------------------------------+
1987
1988ArtifactDataDefinition
1989----------------------
1990
1991+--------------------------------+-------------------------------------------+
1992| Name | Schema |
1993+================================+===========================================+
1994| **apiUrl**\ *optional* | string |
1995+--------------------------------+-------------------------------------------+
1996| **artifactChecksum**\ *optiona | string |
1997| l* | |
1998+--------------------------------+-------------------------------------------+
1999| **artifactCreator**\ *optional | string |
2000| * | |
2001+--------------------------------+-------------------------------------------+
2002| **artifactDisplayName**\ *opti | string |
2003| onal* | |
2004+--------------------------------+-------------------------------------------+
2005| **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT, |
2006| al* | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER) |
2007+--------------------------------+-------------------------------------------+
2008| **artifactLabel**\ *optional* | string |
2009+--------------------------------+-------------------------------------------+
2010| **artifactName**\ *optional* | string |
2011+--------------------------------+-------------------------------------------+
2012| **artifactRef**\ *optional* | string |
2013+--------------------------------+-------------------------------------------+
2014| **artifactRepository**\ *optio | string |
2015| nal* | |
2016+--------------------------------+-------------------------------------------+
2017| **artifactType**\ *optional* | string |
2018+--------------------------------+-------------------------------------------+
2019| **artifactUUID**\ *optional* | string |
2020+--------------------------------+-------------------------------------------+
2021| **artifactVersion**\ *optional | string |
2022| * | |
2023+--------------------------------+-------------------------------------------+
2024| **creationDate**\ *optional* | integer (int64) |
2025+--------------------------------+-------------------------------------------+
2026| **creatorFullName**\ *optional | string |
2027| * | |
2028+--------------------------------+-------------------------------------------+
2029| **description**\ *optional* | string |
2030+--------------------------------+-------------------------------------------+
2031| **duplicated**\ *optional* | boolean |
2032+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2033| **empty**\ *optional* | boolean |
2034+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2035| **esId**\ *optional* | string |
2036+--------------------------------+-------------------------------------------+
2037| **generated**\ *optional* | boolean |
2038+--------------------------------+-------------------------------------------+
2039| **generatedFromId**\ *optional | string |
2040| * | |
2041+--------------------------------+-------------------------------------------+
2042| **heatParameters**\ *optional* | < |
2043| | `HeatParameterDataDefinition <#_heatparam |
2044| | eterdatadefinition>`__ |
2045| | > array |
2046+--------------------------------+-------------------------------------------+
2047| **heatParamsUpdateDate**\ *opt | integer (int64) |
2048| ional* | |
2049+--------------------------------+-------------------------------------------+
2050| **lastUpdateDate**\ *optional* | integer (int64) |
2051+--------------------------------+-------------------------------------------+
2052| **mandatory**\ *optional* | boolean |
2053+--------------------------------+-------------------------------------------+
2054| **ownerId**\ *optional* | string |
2055+--------------------------------+-------------------------------------------+
2056| **payloadUpdateDate**\ *option | integer (int64) |
2057| al* | |
2058+--------------------------------+-------------------------------------------+
2059| **requiredArtifacts**\ *option | < string > array |
2060| al* | |
2061+--------------------------------+-------------------------------------------+
2062| **serviceApi**\ *optional* | boolean |
2063+--------------------------------+-------------------------------------------+
2064| **timeout**\ *optional* | integer (int32) |
2065+--------------------------------+-------------------------------------------+
2066| **uniqueId**\ *optional* | string |
2067+--------------------------------+-------------------------------------------+
2068| **updaterFullName**\ *optional | string |
2069| * | |
2070+--------------------------------+-------------------------------------------+
2071| **userIdCreator**\ *optional* | string |
2072+--------------------------------+-------------------------------------------+
2073| **userIdLastUpdater**\ *option | string |
2074| al* | |
2075+--------------------------------+-------------------------------------------+
2076
2077ArtifactDefinition
2078------------------
2079
2080+--------------------------------+-------------------------------------------+
2081| Name | Schema |
2082+================================+===========================================+
2083| **apiUrl**\ *optional* | string |
2084+--------------------------------+-------------------------------------------+
2085| **artifactChecksum**\ *optiona | string |
2086| l* | |
2087+--------------------------------+-------------------------------------------+
2088| **artifactCreator**\ *optional | string |
2089| * | |
2090+--------------------------------+-------------------------------------------+
2091| **artifactDisplayName**\ *opti | string |
2092| onal* | |
2093+--------------------------------+-------------------------------------------+
2094| **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT, |
2095| al* | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER) |
2096+--------------------------------+-------------------------------------------+
2097| **artifactLabel**\ *optional* | string |
2098+--------------------------------+-------------------------------------------+
2099| **artifactName**\ *optional* | string |
2100+--------------------------------+-------------------------------------------+
2101| **artifactRef**\ *optional* | string |
2102+--------------------------------+-------------------------------------------+
2103| **artifactRepository**\ *optio | string |
2104| nal* | |
2105+--------------------------------+-------------------------------------------+
2106| **artifactType**\ *optional* | string |
2107+--------------------------------+-------------------------------------------+
2108| **artifactUUID**\ *optional* | string |
2109+--------------------------------+-------------------------------------------+
2110| **artifactVersion**\ *optional | string |
2111| * | |
2112+--------------------------------+-------------------------------------------+
2113| **creationDate**\ *optional* | integer (int64) |
2114+--------------------------------+-------------------------------------------+
2115| **creatorFullName**\ *optional | string |
2116| * | |
2117+--------------------------------+-------------------------------------------+
2118| **description**\ *optional* | string |
2119+--------------------------------+-------------------------------------------+
2120| **duplicated**\ *optional* | boolean |
2121+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2122| **empty**\ *optional* | boolean |
2123+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2124| **esId**\ *optional* | string |
2125+--------------------------------+-------------------------------------------+
2126| **generated**\ *optional* | boolean |
2127+--------------------------------+-------------------------------------------+
2128| **generatedFromId**\ *optional | string |
2129| * | |
2130+--------------------------------+-------------------------------------------+
2131| **heatParameters**\ *optional* | < |
2132| | `HeatParameterDataDefinition <#_heatparam |
2133| | eterdatadefinition>`__ |
2134| | > array |
2135+--------------------------------+-------------------------------------------+
2136| **heatParamsUpdateDate**\ *opt | integer (int64) |
2137| ional* | |
2138+--------------------------------+-------------------------------------------+
2139| **lastUpdateDate**\ *optional* | integer (int64) |
2140+--------------------------------+-------------------------------------------+
2141| **listHeatParameters**\ *optio | < |
2142| nal* | `HeatParameterDefinition <#_heatparameter |
2143| | definition>`__ |
2144| | > array |
2145+--------------------------------+-------------------------------------------+
2146| **mandatory**\ *optional* | boolean |
2147+--------------------------------+-------------------------------------------+
2148| **ownerId**\ *optional* | string |
2149+--------------------------------+-------------------------------------------+
2150| **payloadData**\ *optional* | < string (byte) > array |
2151+--------------------------------+-------------------------------------------+
2152| **payloadUpdateDate**\ *option | integer (int64) |
2153| al* | |
2154+--------------------------------+-------------------------------------------+
2155| **requiredArtifacts**\ *option | < string > array |
2156| al* | |
2157+--------------------------------+-------------------------------------------+
2158| **serviceApi**\ *optional* | boolean |
2159+--------------------------------+-------------------------------------------+
2160| **timeout**\ *optional* | integer (int32) |
2161+--------------------------------+-------------------------------------------+
2162| **uniqueId**\ *optional* | string |
2163+--------------------------------+-------------------------------------------+
2164| **updaterFullName**\ *optional | string |
2165| * | |
2166+--------------------------------+-------------------------------------------+
2167| **userIdCreator**\ *optional* | string |
2168+--------------------------------+-------------------------------------------+
2169| **userIdLastUpdater**\ *option | string |
2170| al* | |
2171+--------------------------------+-------------------------------------------+
2172
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2173AssetMetadata
2174-------------
2175
2176+--------------------------------+-------------------------------------------+
2177| Name | Schema |
2178+================================+===========================================+
2179| **invariantUUID**\ *optional* | string |
2180+--------------------------------+-------------------------------------------+
2181| **name**\ *optional* | string |
2182+--------------------------------+-------------------------------------------+
2183| **toscaModelURL**\ *optional* | string |
2184+--------------------------------+-------------------------------------------+
2185| **uuid**\ *optional* | string |
2186+--------------------------------+-------------------------------------------+
2187| **version**\ *optional* | string |
2188+--------------------------------+-------------------------------------------+
2189
2190CapabilityDataDefinition
2191------------------------
2192
2193+--------------------------------+-------------------------------------------+
2194| Name | Schema |
2195+================================+===========================================+
2196| **capabilitySources**\ *option | < string > array |
2197| al* | |
2198+--------------------------------+-------------------------------------------+
2199| **description**\ *optional* | string |
2200+--------------------------------+-------------------------------------------+
2201| **empty**\ *optional* | boolean |
2202+--------------------------------+-------------------------------------------+
2203| **leftOccurrences**\ *optional | string |
2204| * | |
2205+--------------------------------+-------------------------------------------+
2206| **maxOccurrences**\ *optional* | string |
2207+--------------------------------+-------------------------------------------+
2208| **minOccurrences**\ *optional* | string |
2209+--------------------------------+-------------------------------------------+
2210| **name**\ *optional* | string |
2211+--------------------------------+-------------------------------------------+
2212| **ownerId**\ *optional* | string |
2213+--------------------------------+-------------------------------------------+
2214| **ownerName**\ *optional* | string |
2215+--------------------------------+-------------------------------------------+
2216| **parentName**\ *optional* | string |
2217+--------------------------------+-------------------------------------------+
2218| **path**\ *optional* | < string > array |
2219+--------------------------------+-------------------------------------------+
2220| **source**\ *optional* | string |
2221+--------------------------------+-------------------------------------------+
2222| **type**\ *optional* | string |
2223+--------------------------------+-------------------------------------------+
2224| **uniqueId**\ *optional* | string |
2225+--------------------------------+-------------------------------------------+
2226| **validSourceTypes**\ *optiona | < string > array |
2227| l* | |
2228+--------------------------------+-------------------------------------------+
2229
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2230CapabilityDefinition
2231--------------------
2232
2233+--------------------------------+-------------------------------------------+
2234| Name | Schema |
2235+================================+===========================================+
2236| **capabilitySources**\ *option | < string > array |
2237| al* | |
2238+--------------------------------+-------------------------------------------+
2239| **description**\ *optional* | string |
2240+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2241| **empty**\ *optional* | boolean |
2242+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2243| **leftOccurrences**\ *optional | string |
2244| * | |
2245+--------------------------------+-------------------------------------------+
2246| **maxOccurrences**\ *optional* | string |
2247+--------------------------------+-------------------------------------------+
2248| **minOccurrences**\ *optional* | string |
2249+--------------------------------+-------------------------------------------+
2250| **name**\ *optional* | string |
2251+--------------------------------+-------------------------------------------+
2252| **ownerId**\ *optional* | string |
2253+--------------------------------+-------------------------------------------+
2254| **ownerName**\ *optional* | string |
2255+--------------------------------+-------------------------------------------+
2256| **parentName**\ *optional* | string |
2257+--------------------------------+-------------------------------------------+
2258| **path**\ *optional* | < string > array |
2259+--------------------------------+-------------------------------------------+
2260| **properties**\ *optional* | < |
2261| | `ComponentInstanceProperty <#_componentin |
2262| | stanceproperty>`__ |
2263| | > array |
2264+--------------------------------+-------------------------------------------+
2265| **source**\ *optional* | string |
2266+--------------------------------+-------------------------------------------+
2267| **type**\ *optional* | string |
2268+--------------------------------+-------------------------------------------+
2269| **uniqueId**\ *optional* | string |
2270+--------------------------------+-------------------------------------------+
2271| **validSourceTypes**\ *optiona | < string > array |
2272| l* | |
2273+--------------------------------+-------------------------------------------+
2274
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2275CapabilityRequirementRelationship
2276---------------------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2277
2278+--------------------------------+-------------------------------------------+
2279| Name | Schema |
2280+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2281| **capability**\ *optional* | `CapabilityDataDefinition <#_capabilityda |
2282| | tadefinition>`__ |
2283+--------------------------------+-------------------------------------------+
2284| **relation**\ *optional* | `RelationshipInfo <#_relationshipinfo>`__ |
2285+--------------------------------+-------------------------------------------+
2286| **requirement**\ *optional* | `RequirementDataDefinition <#_requirement |
2287| | datadefinition>`__ |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2288+--------------------------------+-------------------------------------------+
2289
2290CategoryDefinition
2291------------------
2292
2293+--------------------------------+-------------------------------------------+
2294| Name | Schema |
2295+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2296| **empty**\ *optional* | boolean |
2297+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2298| **icons**\ *optional* | < string > array |
2299+--------------------------------+-------------------------------------------+
2300| **name**\ *optional* | string |
2301+--------------------------------+-------------------------------------------+
2302| **normalizedName**\ *optional* | string |
2303+--------------------------------+-------------------------------------------+
2304| **ownerId**\ *optional* | string |
2305+--------------------------------+-------------------------------------------+
2306| **subcategories**\ *optional* | < |
2307| | `SubCategoryDefinition <#_subcategorydefi |
2308| | nition>`__ |
2309| | > array |
2310+--------------------------------+-------------------------------------------+
2311| **uniqueId**\ *optional* | string |
2312+--------------------------------+-------------------------------------------+
2313
2314ComponentInstance
2315-----------------
2316
2317+--------------------------------+-------------------------------------------+
2318| Name | Schema |
2319+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2320| **actualComponentUid**\ *optio | string |
2321| nal* | |
2322+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2323| **artifacts**\ *optional* | < string, |
2324| | `ArtifactDefinition <#_artifactdefinition |
2325| | >`__ |
2326| | > map |
2327+--------------------------------+-------------------------------------------+
2328| **attributeValueCounter**\ *op | integer (int32) |
2329| tional* | |
2330+--------------------------------+-------------------------------------------+
2331| **capabilities**\ *optional* | < string, < |
2332| | `CapabilityDefinition <#_capabilitydefini |
2333| | tion>`__ |
2334| | > array > map |
2335+--------------------------------+-------------------------------------------+
2336| **componentName**\ *optional* | string |
2337+--------------------------------+-------------------------------------------+
2338| **componentUid**\ *optional* | string |
2339+--------------------------------+-------------------------------------------+
2340| **componentVersion**\ *optiona | string |
2341| l* | |
2342+--------------------------------+-------------------------------------------+
2343| **creationTime**\ *optional* | integer (int64) |
2344+--------------------------------+-------------------------------------------+
2345| **customizationUUID**\ *option | string |
2346| al* | |
2347+--------------------------------+-------------------------------------------+
2348| **deploymentArtifacts**\ *opti | < string, |
2349| onal* | `ArtifactDefinition <#_artifactdefinition |
2350| | >`__ |
2351| | > map |
2352+--------------------------------+-------------------------------------------+
2353| **description**\ *optional* | string |
2354+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2355| **empty**\ *optional* | boolean |
2356+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2357| **groupInstances**\ *optional* | < `GroupInstance <#_groupinstance>`__ > |
2358| | array |
2359+--------------------------------+-------------------------------------------+
2360| **icon**\ *optional* | string |
2361+--------------------------------+-------------------------------------------+
2362| **inputValueCounter**\ *option | integer (int32) |
2363| al* | |
2364+--------------------------------+-------------------------------------------+
2365| **invariantName**\ *optional* | string |
2366+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2367| **isProxy**\ *optional* | boolean |
2368+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2369| **modificationTime**\ *optiona | integer (int64) |
2370| l* | |
2371+--------------------------------+-------------------------------------------+
2372| **name**\ *optional* | string |
2373+--------------------------------+-------------------------------------------+
2374| **normalizedName**\ *optional* | string |
2375+--------------------------------+-------------------------------------------+
2376| **originType**\ *optional* | enum (PRODUCT, SERVICE, VF, VFC, CP, VL, |
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2377| | Configuration, VFCMT, CVFC, PNF, |
2378| | ServiceProxy) |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2379+--------------------------------+-------------------------------------------+
2380| **ownerId**\ *optional* | string |
2381+--------------------------------+-------------------------------------------+
2382| **posX**\ *optional* | string |
2383+--------------------------------+-------------------------------------------+
2384| **posY**\ *optional* | string |
2385+--------------------------------+-------------------------------------------+
2386| **propertyValueCounter**\ *opt | integer (int32) |
2387| ional* | |
2388+--------------------------------+-------------------------------------------+
2389| **requirements**\ *optional* | < string, < |
2390| | `RequirementDefinition <#_requirementdefi |
2391| | nition>`__ |
2392| | > array > map |
2393+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2394| **sourceModelInvariant**\ *opt | string |
2395| ional* | |
2396+--------------------------------+-------------------------------------------+
2397| **sourceModelName**\ *optional | string |
2398| * | |
2399+--------------------------------+-------------------------------------------+
2400| **sourceModelUid**\ *optional* | string |
2401+--------------------------------+-------------------------------------------+
2402| **sourceModelUuid**\ *optional | string |
2403| * | |
2404+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2405| **toscaComponentName**\ *optio | string |
2406| nal* | |
2407+--------------------------------+-------------------------------------------+
2408| **uniqueId**\ *optional* | string |
2409+--------------------------------+-------------------------------------------+
2410
2411ComponentInstanceInput
2412----------------------
2413
2414+--------------------------------+-------------------------------------------+
2415| Name | Schema |
2416+================================+===========================================+
2417| **componentInstanceId**\ *opti | string |
2418| onal* | |
2419+--------------------------------+-------------------------------------------+
2420| **componentInstanceName**\ *op | string |
2421| tional* | |
2422+--------------------------------+-------------------------------------------+
2423| **constraints**\ *optional* | < |
2424| | `PropertyConstraint <#_propertyconstraint |
2425| | >`__ |
2426| | > array |
2427+--------------------------------+-------------------------------------------+
2428| **defaultValue**\ *optional* | string |
2429+--------------------------------+-------------------------------------------+
2430| **definition**\ *optional* | boolean |
2431+--------------------------------+-------------------------------------------+
2432| **description**\ *optional* | string |
2433+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2434| **empty**\ *optional* | boolean |
2435+--------------------------------+-------------------------------------------+
2436| **getInputProperty**\ *optiona | boolean |
2437| l* | |
2438+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2439| **getInputValues**\ *optional* | < |
2440| | `GetInputValueDataDefinition <#_getinputv |
2441| | aluedatadefinition>`__ |
2442| | > array |
2443+--------------------------------+-------------------------------------------+
2444| **hidden**\ *optional* | boolean |
2445+--------------------------------+-------------------------------------------+
2446| **immutable**\ *optional* | boolean |
2447+--------------------------------+-------------------------------------------+
2448| **inputId**\ *optional* | string |
2449+--------------------------------+-------------------------------------------+
2450| **inputPath**\ *optional* | string |
2451+--------------------------------+-------------------------------------------+
2452| **inputs**\ *optional* | < |
2453| | `ComponentInstanceInput <#_componentinsta |
2454| | nceinput>`__ |
2455| | > array |
2456+--------------------------------+-------------------------------------------+
2457| **instanceUniqueId**\ *optiona | string |
2458| l* | |
2459+--------------------------------+-------------------------------------------+
2460| **label**\ *optional* | string |
2461+--------------------------------+-------------------------------------------+
2462| **name**\ *optional* | string |
2463+--------------------------------+-------------------------------------------+
2464| **ownerId**\ *optional* | string |
2465+--------------------------------+-------------------------------------------+
2466| **parentUniqueId**\ *optional* | string |
2467+--------------------------------+-------------------------------------------+
2468| **password**\ *optional* | boolean |
2469+--------------------------------+-------------------------------------------+
2470| **path**\ *optional* | < string > array |
2471+--------------------------------+-------------------------------------------+
2472| **properties**\ *optional* | < |
2473| | `ComponentInstanceProperty <#_componentin |
2474| | stanceproperty>`__ |
2475| | > array |
2476+--------------------------------+-------------------------------------------+
2477| **propertyId**\ *optional* | string |
2478+--------------------------------+-------------------------------------------+
2479| **required**\ *optional* | boolean |
2480+--------------------------------+-------------------------------------------+
2481| **rules**\ *optional* | < `PropertyRule <#_propertyrule>`__ > |
2482| | array |
2483+--------------------------------+-------------------------------------------+
2484| **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
2485+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2486| **schemaType**\ *optional* | string |
2487+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2488| **status**\ *optional* | string |
2489+--------------------------------+-------------------------------------------+
2490| **type**\ *optional* | string |
2491+--------------------------------+-------------------------------------------+
2492| **uniqueId**\ *optional* | string |
2493+--------------------------------+-------------------------------------------+
2494| **value**\ *optional* | string |
2495+--------------------------------+-------------------------------------------+
2496| **valueUniqueUid**\ *optional* | string |
2497+--------------------------------+-------------------------------------------+
2498
2499ComponentInstanceProperty
2500-------------------------
2501
2502+--------------------------------+-------------------------------------------+
2503| Name | Schema |
2504+================================+===========================================+
2505| **componentInstanceId**\ *opti | string |
2506| onal* | |
2507+--------------------------------+-------------------------------------------+
2508| **componentInstanceName**\ *op | string |
2509| tional* | |
2510+--------------------------------+-------------------------------------------+
2511| **constraints**\ *optional* | < |
2512| | `PropertyConstraint <#_propertyconstraint |
2513| | >`__ |
2514| | > array |
2515+--------------------------------+-------------------------------------------+
2516| **defaultValue**\ *optional* | string |
2517+--------------------------------+-------------------------------------------+
2518| **definition**\ *optional* | boolean |
2519+--------------------------------+-------------------------------------------+
2520| **description**\ *optional* | string |
2521+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2522| **empty**\ *optional* | boolean |
2523+--------------------------------+-------------------------------------------+
2524| **getInputProperty**\ *optiona | boolean |
2525| l* | |
2526+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2527| **getInputValues**\ *optional* | < |
2528| | `GetInputValueDataDefinition <#_getinputv |
2529| | aluedatadefinition>`__ |
2530| | > array |
2531+--------------------------------+-------------------------------------------+
2532| **hidden**\ *optional* | boolean |
2533+--------------------------------+-------------------------------------------+
2534| **immutable**\ *optional* | boolean |
2535+--------------------------------+-------------------------------------------+
2536| **inputId**\ *optional* | string |
2537+--------------------------------+-------------------------------------------+
2538| **inputPath**\ *optional* | string |
2539+--------------------------------+-------------------------------------------+
2540| **instanceUniqueId**\ *optiona | string |
2541| l* | |
2542+--------------------------------+-------------------------------------------+
2543| **label**\ *optional* | string |
2544+--------------------------------+-------------------------------------------+
2545| **name**\ *optional* | string |
2546+--------------------------------+-------------------------------------------+
2547| **ownerId**\ *optional* | string |
2548+--------------------------------+-------------------------------------------+
2549| **parentUniqueId**\ *optional* | string |
2550+--------------------------------+-------------------------------------------+
2551| **password**\ *optional* | boolean |
2552+--------------------------------+-------------------------------------------+
2553| **path**\ *optional* | < string > array |
2554+--------------------------------+-------------------------------------------+
2555| **propertyId**\ *optional* | string |
2556+--------------------------------+-------------------------------------------+
2557| **required**\ *optional* | boolean |
2558+--------------------------------+-------------------------------------------+
2559| **rules**\ *optional* | < `PropertyRule <#_propertyrule>`__ > |
2560| | array |
2561+--------------------------------+-------------------------------------------+
2562| **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
2563+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2564| **schemaType**\ *optional* | string |
2565+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2566| **status**\ *optional* | string |
2567+--------------------------------+-------------------------------------------+
2568| **type**\ *optional* | string |
2569+--------------------------------+-------------------------------------------+
2570| **uniqueId**\ *optional* | string |
2571+--------------------------------+-------------------------------------------+
2572| **value**\ *optional* | string |
2573+--------------------------------+-------------------------------------------+
2574| **valueUniqueUid**\ *optional* | string |
2575+--------------------------------+-------------------------------------------+
2576
2577ComponentMetadataDataDefinition
2578-------------------------------
2579
2580+--------------------------------+-------------------------------------------+
2581| Name | Schema |
2582+================================+===========================================+
2583| **allVersions**\ *optional* | < string, string > map |
2584+--------------------------------+-------------------------------------------+
2585| **componentType**\ *optional* | enum (RESOURCE, SERVICE, |
2586| | RESOURCE\_INSTANCE, PRODUCT, |
2587| | SERVICE\_INSTANCE) |
2588+--------------------------------+-------------------------------------------+
2589| **conformanceLevel**\ *optiona | string |
2590| l* | |
2591+--------------------------------+-------------------------------------------+
2592| **contactId**\ *optional* | string |
2593+--------------------------------+-------------------------------------------+
2594| **creationDate**\ *optional* | integer (int64) |
2595+--------------------------------+-------------------------------------------+
2596| **creatorFullName**\ *optional | string |
2597| * | |
2598+--------------------------------+-------------------------------------------+
2599| **creatorUserId**\ *optional* | string |
2600+--------------------------------+-------------------------------------------+
2601| **csarUUID**\ *optional* | string |
2602+--------------------------------+-------------------------------------------+
2603| **csarVersion**\ *optional* | string |
2604+--------------------------------+-------------------------------------------+
2605| **deleted**\ *optional* | boolean |
2606+--------------------------------+-------------------------------------------+
2607| **description**\ *optional* | string |
2608+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2609| **empty**\ *optional* | boolean |
2610+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2611| **highestVersion**\ *optional* | boolean |
2612+--------------------------------+-------------------------------------------+
2613| **icon**\ *optional* | string |
2614+--------------------------------+-------------------------------------------+
2615| **importedToscaChecksum**\ *op | string |
2616| tional* | |
2617+--------------------------------+-------------------------------------------+
2618| **invariantUUID**\ *optional* | string |
2619+--------------------------------+-------------------------------------------+
2620| **isDeleted**\ *optional* | boolean |
2621+--------------------------------+-------------------------------------------+
2622| **isHighestVersion**\ *optiona | boolean |
2623| l* | |
2624+--------------------------------+-------------------------------------------+
2625| **lastUpdateDate**\ *optional* | integer (int64) |
2626+--------------------------------+-------------------------------------------+
2627| **lastUpdaterFullName**\ *opti | string |
2628| onal* | |
2629+--------------------------------+-------------------------------------------+
2630| **lastUpdaterUserId**\ *option | string |
2631| al* | |
2632+--------------------------------+-------------------------------------------+
2633| **lifecycleState**\ *optional* | string |
2634+--------------------------------+-------------------------------------------+
2635| **name**\ *optional* | string |
2636+--------------------------------+-------------------------------------------+
2637| **normalizedName**\ *optional* | string |
2638+--------------------------------+-------------------------------------------+
2639| **ownerId**\ *optional* | string |
2640+--------------------------------+-------------------------------------------+
2641| **projectCode**\ *optional* | string |
2642+--------------------------------+-------------------------------------------+
2643| **state**\ *optional* | string |
2644+--------------------------------+-------------------------------------------+
2645| **systemName**\ *optional* | string |
2646+--------------------------------+-------------------------------------------+
2647| **tags**\ *optional* | < string > array |
2648+--------------------------------+-------------------------------------------+
2649| **uniqueId**\ *optional* | string |
2650+--------------------------------+-------------------------------------------+
2651| **uuid**\ *optional* | string |
2652+--------------------------------+-------------------------------------------+
2653| **version**\ *optional* | string |
2654+--------------------------------+-------------------------------------------+
2655
2656ComponentMetadataDefinition
2657---------------------------
2658
2659+--------------------------------+-------------------------------------------+
2660| Name | Schema |
2661+================================+===========================================+
2662| **metadataDataDefinition**\ *o | `ComponentMetadataDataDefinition <#_compo |
2663| ptional* | nentmetadatadatadefinition>`__ |
2664+--------------------------------+-------------------------------------------+
2665
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2666GetInputValueDataDefinition
2667---------------------------
2668
2669+--------------------------------+-------------------------------------------+
2670| Name | Schema |
2671+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2672| **empty**\ *optional* | boolean |
2673+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2674| **getInputIndex**\ *optional* | `GetInputValueDataDefinition <#_getinputv |
2675| | aluedatadefinition>`__ |
2676+--------------------------------+-------------------------------------------+
2677| **indexValue**\ *optional* | integer (int32) |
2678+--------------------------------+-------------------------------------------+
2679| **inputId**\ *optional* | string |
2680+--------------------------------+-------------------------------------------+
2681| **inputName**\ *optional* | string |
2682+--------------------------------+-------------------------------------------+
2683| **list**\ *optional* | boolean |
2684+--------------------------------+-------------------------------------------+
2685| **ownerId**\ *optional* | string |
2686+--------------------------------+-------------------------------------------+
2687| **propName**\ *optional* | string |
2688+--------------------------------+-------------------------------------------+
2689
2690GroupDefinition
2691---------------
2692
2693+--------------------------------+-------------------------------------------+
2694| Name | Schema |
2695+================================+===========================================+
2696| **artifacts**\ *optional* | < string > array |
2697+--------------------------------+-------------------------------------------+
2698| **artifactsUuid**\ *optional* | < string > array |
2699+--------------------------------+-------------------------------------------+
2700| **description**\ *optional* | string |
2701+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2702| **empty**\ *optional* | boolean |
2703+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2704| **groupUUID**\ *optional* | string |
2705+--------------------------------+-------------------------------------------+
2706| **invariantUUID**\ *optional* | string |
2707+--------------------------------+-------------------------------------------+
2708| **members**\ *optional* | < string, string > map |
2709+--------------------------------+-------------------------------------------+
2710| **name**\ *optional* | string |
2711+--------------------------------+-------------------------------------------+
2712| **ownerId**\ *optional* | string |
2713+--------------------------------+-------------------------------------------+
2714| **properties**\ *optional* | < |
2715| | `PropertyDataDefinition <#_propertydatade |
2716| | finition>`__ |
2717| | > array |
2718+--------------------------------+-------------------------------------------+
2719| **propertyValueCounter**\ *opt | integer (int32) |
2720| ional* | |
2721+--------------------------------+-------------------------------------------+
2722| **type**\ *optional* | string |
2723+--------------------------------+-------------------------------------------+
2724| **typeUid**\ *optional* | string |
2725+--------------------------------+-------------------------------------------+
2726| **uniqueId**\ *optional* | string |
2727+--------------------------------+-------------------------------------------+
2728| **version**\ *optional* | string |
2729+--------------------------------+-------------------------------------------+
2730
2731GroupInstance
2732-------------
2733
2734+--------------------------------+-------------------------------------------+
2735| Name | Schema |
2736+================================+===========================================+
2737| **artifacts**\ *optional* | < string > array |
2738+--------------------------------+-------------------------------------------+
2739| **artifactsUuid**\ *optional* | < string > array |
2740+--------------------------------+-------------------------------------------+
2741| **creationTime**\ *optional* | integer (int64) |
2742+--------------------------------+-------------------------------------------+
2743| **customizationUUID**\ *option | string |
2744| al* | |
2745+--------------------------------+-------------------------------------------+
2746| **description**\ *optional* | string |
2747+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2748| **empty**\ *optional* | boolean |
2749+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2750| **groupInstanceArtifacts**\ *o | < string > array |
2751| ptional* | |
2752+--------------------------------+-------------------------------------------+
2753| **groupInstanceArtifactsUuid** | < string > array |
2754| \ *optional* | |
2755+--------------------------------+-------------------------------------------+
2756| **groupName**\ *optional* | string |
2757+--------------------------------+-------------------------------------------+
2758| **groupUUID**\ *optional* | string |
2759+--------------------------------+-------------------------------------------+
2760| **groupUid**\ *optional* | string |
2761+--------------------------------+-------------------------------------------+
2762| **invariantUUID**\ *optional* | string |
2763+--------------------------------+-------------------------------------------+
2764| **modificationTime**\ *optiona | integer (int64) |
2765| l* | |
2766+--------------------------------+-------------------------------------------+
2767| **name**\ *optional* | string |
2768+--------------------------------+-------------------------------------------+
2769| **normalizedName**\ *optional* | string |
2770+--------------------------------+-------------------------------------------+
2771| **ownerId**\ *optional* | string |
2772+--------------------------------+-------------------------------------------+
2773| **posX**\ *optional* | string |
2774+--------------------------------+-------------------------------------------+
2775| **posY**\ *optional* | string |
2776+--------------------------------+-------------------------------------------+
2777| **properties**\ *optional* | < |
2778| | `PropertyDataDefinition <#_propertydatade |
2779| | finition>`__ |
2780| | > array |
2781+--------------------------------+-------------------------------------------+
2782| **propertyValueCounter**\ *opt | integer (int32) |
2783| ional* | |
2784+--------------------------------+-------------------------------------------+
2785| **type**\ *optional* | string |
2786+--------------------------------+-------------------------------------------+
2787| **uniqueId**\ *optional* | string |
2788+--------------------------------+-------------------------------------------+
2789| **version**\ *optional* | string |
2790+--------------------------------+-------------------------------------------+
2791
2792GroupingDefinition
2793------------------
2794
2795+--------------------------------+-------------------------------------------+
2796| Name | Schema |
2797+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2798| **empty**\ *optional* | boolean |
2799+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2800| **name**\ *optional* | string |
2801+--------------------------------+-------------------------------------------+
2802| **normalizedName**\ *optional* | string |
2803+--------------------------------+-------------------------------------------+
2804| **ownerId**\ *optional* | string |
2805+--------------------------------+-------------------------------------------+
2806| **uniqueId**\ *optional* | string |
2807+--------------------------------+-------------------------------------------+
2808
2809HeatParameterDataDefinition
2810---------------------------
2811
2812+--------------------------------+-------------------------------------------+
2813| Name | Schema |
2814+================================+===========================================+
2815| **currentValue**\ *optional* | string |
2816+--------------------------------+-------------------------------------------+
2817| **defaultValue**\ *optional* | string |
2818+--------------------------------+-------------------------------------------+
2819| **description**\ *optional* | string |
2820+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2821| **empty**\ *optional* | boolean |
2822+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2823| **name**\ *optional* | string |
2824+--------------------------------+-------------------------------------------+
2825| **ownerId**\ *optional* | string |
2826+--------------------------------+-------------------------------------------+
2827| **type**\ *optional* | string |
2828+--------------------------------+-------------------------------------------+
2829| **uniqueId**\ *optional* | string |
2830+--------------------------------+-------------------------------------------+
2831
2832HeatParameterDefinition
2833-----------------------
2834
2835+--------------------------------+-------------------------------------------+
2836| Name | Schema |
2837+================================+===========================================+
2838| **currentValue**\ *optional* | string |
2839+--------------------------------+-------------------------------------------+
2840| **defaultValue**\ *optional* | string |
2841+--------------------------------+-------------------------------------------+
2842| **description**\ *optional* | string |
2843+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2844| **empty**\ *optional* | boolean |
2845+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2846| **name**\ *optional* | string |
2847+--------------------------------+-------------------------------------------+
2848| **ownerId**\ *optional* | string |
2849+--------------------------------+-------------------------------------------+
2850| **type**\ *optional* | string |
2851+--------------------------------+-------------------------------------------+
2852| **uniqueId**\ *optional* | string |
2853+--------------------------------+-------------------------------------------+
2854
2855InputDefinition
2856---------------
2857
2858+--------------------------------+-------------------------------------------+
2859| Name | Schema |
2860+================================+===========================================+
2861| **constraints**\ *optional* | < |
2862| | `PropertyConstraint <#_propertyconstraint |
2863| | >`__ |
2864| | > array |
2865+--------------------------------+-------------------------------------------+
2866| **defaultValue**\ *optional* | string |
2867+--------------------------------+-------------------------------------------+
2868| **definition**\ *optional* | boolean |
2869+--------------------------------+-------------------------------------------+
2870| **description**\ *optional* | string |
2871+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2872| **empty**\ *optional* | boolean |
2873+--------------------------------+-------------------------------------------+
2874| **getInputProperty**\ *optiona | boolean |
2875| l* | |
2876+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2877| **getInputValues**\ *optional* | < |
2878| | `GetInputValueDataDefinition <#_getinputv |
2879| | aluedatadefinition>`__ |
2880| | > array |
2881+--------------------------------+-------------------------------------------+
2882| **hidden**\ *optional* | boolean |
2883+--------------------------------+-------------------------------------------+
2884| **immutable**\ *optional* | boolean |
2885+--------------------------------+-------------------------------------------+
2886| **inputId**\ *optional* | string |
2887+--------------------------------+-------------------------------------------+
2888| **inputPath**\ *optional* | string |
2889+--------------------------------+-------------------------------------------+
2890| **inputs**\ *optional* | < |
2891| | `ComponentInstanceInput <#_componentinsta |
2892| | nceinput>`__ |
2893| | > array |
2894+--------------------------------+-------------------------------------------+
2895| **instanceUniqueId**\ *optiona | string |
2896| l* | |
2897+--------------------------------+-------------------------------------------+
2898| **label**\ *optional* | string |
2899+--------------------------------+-------------------------------------------+
2900| **name**\ *optional* | string |
2901+--------------------------------+-------------------------------------------+
2902| **ownerId**\ *optional* | string |
2903+--------------------------------+-------------------------------------------+
2904| **parentUniqueId**\ *optional* | string |
2905+--------------------------------+-------------------------------------------+
2906| **password**\ *optional* | boolean |
2907+--------------------------------+-------------------------------------------+
2908| **properties**\ *optional* | < |
2909| | `ComponentInstanceProperty <#_componentin |
2910| | stanceproperty>`__ |
2911| | > array |
2912+--------------------------------+-------------------------------------------+
2913| **propertyId**\ *optional* | string |
2914+--------------------------------+-------------------------------------------+
2915| **required**\ *optional* | boolean |
2916+--------------------------------+-------------------------------------------+
2917| **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
2918+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2919| **schemaType**\ *optional* | string |
2920+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2921| **status**\ *optional* | string |
2922+--------------------------------+-------------------------------------------+
2923| **type**\ *optional* | string |
2924+--------------------------------+-------------------------------------------+
2925| **uniqueId**\ *optional* | string |
2926+--------------------------------+-------------------------------------------+
2927| **value**\ *optional* | string |
2928+--------------------------------+-------------------------------------------+
2929
2930InterfaceDefinition
2931-------------------
2932
2933+--------------------------------+-------------------------------------------+
2934| Name | Schema |
2935+================================+===========================================+
2936| **creationDate**\ *optional* | integer (int64) |
2937+--------------------------------+-------------------------------------------+
2938| **definition**\ *optional* | boolean |
2939+--------------------------------+-------------------------------------------+
2940| **description**\ *optional* | string |
2941+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2942| **empty**\ *optional* | boolean |
2943+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2944| **lastUpdateDate**\ *optional* | integer (int64) |
2945+--------------------------------+-------------------------------------------+
2946| **operations**\ *optional* | < string, |
2947| | `OperationDataDefinition <#_operationdata |
2948| | definition>`__ |
2949| | > map |
2950+--------------------------------+-------------------------------------------+
2951| **operationsMap**\ *optional* | < string, `Operation <#_operation>`__ > |
2952| | map |
2953+--------------------------------+-------------------------------------------+
2954| **ownerId**\ *optional* | string |
2955+--------------------------------+-------------------------------------------+
2956| **type**\ *optional* | string |
2957+--------------------------------+-------------------------------------------+
2958| **uniqueId**\ *optional* | string |
2959+--------------------------------+-------------------------------------------+
2960
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2961Operation
2962---------
2963
2964+--------------------------------+-------------------------------------------+
2965| Name | Schema |
2966+================================+===========================================+
2967| **creationDate**\ *optional* | integer (int64) |
2968+--------------------------------+-------------------------------------------+
2969| **definition**\ *optional* | boolean |
2970+--------------------------------+-------------------------------------------+
2971| **description**\ *optional* | string |
2972+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]2973| **empty**\ *optional* | boolean |
2974+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]2975| **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade |
2976| | finition>`__ |
2977+--------------------------------+-------------------------------------------+
2978| **implementationArtifact**\ *o | `ArtifactDefinition <#_artifactdefinition |
2979| ptional* | >`__ |
2980+--------------------------------+-------------------------------------------+
2981| **inputs**\ *optional* | < string, |
2982| | `PropertyDataDefinition <#_propertydatade |
2983| | finition>`__ |
2984| | > map |
2985+--------------------------------+-------------------------------------------+
2986| **lastUpdateDate**\ *optional* | integer (int64) |
2987+--------------------------------+-------------------------------------------+
2988| **ownerId**\ *optional* | string |
2989+--------------------------------+-------------------------------------------+
2990| **uniqueId**\ *optional* | string |
2991+--------------------------------+-------------------------------------------+
2992
2993OperationDataDefinition
2994-----------------------
2995
2996+--------------------------------+-------------------------------------------+
2997| Name | Schema |
2998+================================+===========================================+
2999| **creationDate**\ *optional* | integer (int64) |
3000+--------------------------------+-------------------------------------------+
3001| **description**\ *optional* | string |
3002+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3003| **empty**\ *optional* | boolean |
3004+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3005| **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade |
3006| | finition>`__ |
3007+--------------------------------+-------------------------------------------+
3008| **inputs**\ *optional* | < string, |
3009| | `PropertyDataDefinition <#_propertydatade |
3010| | finition>`__ |
3011| | > map |
3012+--------------------------------+-------------------------------------------+
3013| **lastUpdateDate**\ *optional* | integer (int64) |
3014+--------------------------------+-------------------------------------------+
3015| **ownerId**\ *optional* | string |
3016+--------------------------------+-------------------------------------------+
3017| **uniqueId**\ *optional* | string |
3018+--------------------------------+-------------------------------------------+
3019
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3020PropertyConstraint
3021------------------
3022
3023*Type* : object
3024
3025PropertyDataDefinition
3026----------------------
3027
3028+--------------------------------+-------------------------------------------+
3029| Name | Schema |
3030+================================+===========================================+
3031| **defaultValue**\ *optional* | string |
3032+--------------------------------+-------------------------------------------+
3033| **definition**\ *optional* | boolean |
3034+--------------------------------+-------------------------------------------+
3035| **description**\ *optional* | string |
3036+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3037| **empty**\ *optional* | boolean |
3038+--------------------------------+-------------------------------------------+
3039| **getInputProperty**\ *optiona | boolean |
3040| l* | |
3041+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3042| **getInputValues**\ *optional* | < |
3043| | `GetInputValueDataDefinition <#_getinputv |
3044| | aluedatadefinition>`__ |
3045| | > array |
3046+--------------------------------+-------------------------------------------+
3047| **hidden**\ *optional* | boolean |
3048+--------------------------------+-------------------------------------------+
3049| **immutable**\ *optional* | boolean |
3050+--------------------------------+-------------------------------------------+
3051| **inputId**\ *optional* | string |
3052+--------------------------------+-------------------------------------------+
3053| **inputPath**\ *optional* | string |
3054+--------------------------------+-------------------------------------------+
3055| **instanceUniqueId**\ *optiona | string |
3056| l* | |
3057+--------------------------------+-------------------------------------------+
3058| **label**\ *optional* | string |
3059+--------------------------------+-------------------------------------------+
3060| **name**\ *optional* | string |
3061+--------------------------------+-------------------------------------------+
3062| **ownerId**\ *optional* | string |
3063+--------------------------------+-------------------------------------------+
3064| **parentUniqueId**\ *optional* | string |
3065+--------------------------------+-------------------------------------------+
3066| **password**\ *optional* | boolean |
3067+--------------------------------+-------------------------------------------+
3068| **propertyId**\ *optional* | string |
3069+--------------------------------+-------------------------------------------+
3070| **required**\ *optional* | boolean |
3071+--------------------------------+-------------------------------------------+
3072| **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
3073+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3074| **schemaType**\ *optional* | string |
3075+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3076| **status**\ *optional* | string |
3077+--------------------------------+-------------------------------------------+
3078| **type**\ *optional* | string |
3079+--------------------------------+-------------------------------------------+
3080| **uniqueId**\ *optional* | string |
3081+--------------------------------+-------------------------------------------+
3082| **value**\ *optional* | string |
3083+--------------------------------+-------------------------------------------+
3084
3085PropertyDefinition
3086------------------
3087
3088+--------------------------------+-------------------------------------------+
3089| Name | Schema |
3090+================================+===========================================+
3091| **constraints**\ *optional* | < |
3092| | `PropertyConstraint <#_propertyconstraint |
3093| | >`__ |
3094| | > array |
3095+--------------------------------+-------------------------------------------+
3096| **defaultValue**\ *optional* | string |
3097+--------------------------------+-------------------------------------------+
3098| **definition**\ *optional* | boolean |
3099+--------------------------------+-------------------------------------------+
3100| **description**\ *optional* | string |
3101+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3102| **empty**\ *optional* | boolean |
3103+--------------------------------+-------------------------------------------+
3104| **getInputProperty**\ *optiona | boolean |
3105| l* | |
3106+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3107| **getInputValues**\ *optional* | < |
3108| | `GetInputValueDataDefinition <#_getinputv |
3109| | aluedatadefinition>`__ |
3110| | > array |
3111+--------------------------------+-------------------------------------------+
3112| **hidden**\ *optional* | boolean |
3113+--------------------------------+-------------------------------------------+
3114| **immutable**\ *optional* | boolean |
3115+--------------------------------+-------------------------------------------+
3116| **inputId**\ *optional* | string |
3117+--------------------------------+-------------------------------------------+
3118| **inputPath**\ *optional* | string |
3119+--------------------------------+-------------------------------------------+
3120| **instanceUniqueId**\ *optiona | string |
3121| l* | |
3122+--------------------------------+-------------------------------------------+
3123| **label**\ *optional* | string |
3124+--------------------------------+-------------------------------------------+
3125| **name**\ *optional* | string |
3126+--------------------------------+-------------------------------------------+
3127| **ownerId**\ *optional* | string |
3128+--------------------------------+-------------------------------------------+
3129| **parentUniqueId**\ *optional* | string |
3130+--------------------------------+-------------------------------------------+
3131| **password**\ *optional* | boolean |
3132+--------------------------------+-------------------------------------------+
3133| **propertyId**\ *optional* | string |
3134+--------------------------------+-------------------------------------------+
3135| **required**\ *optional* | boolean |
3136+--------------------------------+-------------------------------------------+
3137| **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
3138+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3139| **schemaType**\ *optional* | string |
3140+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3141| **status**\ *optional* | string |
3142+--------------------------------+-------------------------------------------+
3143| **type**\ *optional* | string |
3144+--------------------------------+-------------------------------------------+
3145| **uniqueId**\ *optional* | string |
3146+--------------------------------+-------------------------------------------+
3147| **value**\ *optional* | string |
3148+--------------------------------+-------------------------------------------+
3149
3150PropertyRule
3151------------
3152
3153+--------------------------------+-------------------------------------------+
3154| Name | Schema |
3155+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3156| **empty**\ *optional* | boolean |
3157+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3158| **firstToken**\ *optional* | string |
3159+--------------------------------+-------------------------------------------+
3160| **ownerId**\ *optional* | string |
3161+--------------------------------+-------------------------------------------+
3162| **rule**\ *optional* | < string > array |
3163+--------------------------------+-------------------------------------------+
3164| **ruleSize**\ *optional* | integer (int32) |
3165+--------------------------------+-------------------------------------------+
3166| **value**\ *optional* | string |
3167+--------------------------------+-------------------------------------------+
3168
3169RelationshipImpl
3170----------------
3171
3172+--------------------------------+-------------------------------------------+
3173| Name | Schema |
3174+================================+===========================================+
3175| **type**\ *optional* | string |
3176+--------------------------------+-------------------------------------------+
3177
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3178RelationshipInfo
3179----------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3180
3181+--------------------------------+-------------------------------------------+
3182| Name | Schema |
3183+================================+===========================================+
3184| **capability**\ *optional* | string |
3185+--------------------------------+-------------------------------------------+
3186| **capabilityOwnerId**\ *option | string |
3187| al* | |
3188+--------------------------------+-------------------------------------------+
3189| **capabilityUid**\ *optional* | string |
3190+--------------------------------+-------------------------------------------+
3191| **id**\ *optional* | string |
3192+--------------------------------+-------------------------------------------+
3193| **relationship**\ *optional* | `RelationshipImpl <#_relationshipimpl>`__ |
3194+--------------------------------+-------------------------------------------+
3195| **requirement**\ *optional* | string |
3196+--------------------------------+-------------------------------------------+
3197| **requirementOwnerId**\ *optio | string |
3198| nal* | |
3199+--------------------------------+-------------------------------------------+
3200| **requirementUid**\ *optional* | string |
3201+--------------------------------+-------------------------------------------+
3202
3203RequirementCapabilityRelDef
3204---------------------------
3205
3206+--------------------------------+-------------------------------------------+
3207| Name | Schema |
3208+================================+===========================================+
3209| **fromNode**\ *optional* | string |
3210+--------------------------------+-------------------------------------------+
3211| **relationships**\ *optional* | < |
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3212| | `CapabilityRequirementRelationship <#_cap |
3213| | abilityrequirementrelationship>`__ |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3214| | > array |
3215+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3216| **singleRelationship**\ *optio | `CapabilityRequirementRelationship <#_cap |
3217| nal* | abilityrequirementrelationship>`__ |
3218+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3219| **toNode**\ *optional* | string |
3220+--------------------------------+-------------------------------------------+
3221| **uid**\ *optional* | string |
3222+--------------------------------+-------------------------------------------+
3223
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3224RequirementDataDefinition
3225-------------------------
3226
3227+--------------------------------+-------------------------------------------+
3228| Name | Schema |
3229+================================+===========================================+
3230| **capability**\ *optional* | string |
3231+--------------------------------+-------------------------------------------+
3232| **empty**\ *optional* | boolean |
3233+--------------------------------+-------------------------------------------+
3234| **leftOccurrences**\ *optional | string |
3235| * | |
3236+--------------------------------+-------------------------------------------+
3237| **maxOccurrences**\ *optional* | string |
3238+--------------------------------+-------------------------------------------+
3239| **minOccurrences**\ *optional* | string |
3240+--------------------------------+-------------------------------------------+
3241| **name**\ *optional* | string |
3242+--------------------------------+-------------------------------------------+
3243| **node**\ *optional* | string |
3244+--------------------------------+-------------------------------------------+
3245| **ownerId**\ *optional* | string |
3246+--------------------------------+-------------------------------------------+
3247| **ownerName**\ *optional* | string |
3248+--------------------------------+-------------------------------------------+
3249| **parentName**\ *optional* | string |
3250+--------------------------------+-------------------------------------------+
3251| **path**\ *optional* | < string > array |
3252+--------------------------------+-------------------------------------------+
3253| **relationship**\ *optional* | string |
3254+--------------------------------+-------------------------------------------+
3255| **source**\ *optional* | string |
3256+--------------------------------+-------------------------------------------+
3257| **uniqueId**\ *optional* | string |
3258+--------------------------------+-------------------------------------------+
3259
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3260RequirementDefinition
3261---------------------
3262
3263+--------------------------------+-------------------------------------------+
3264| Name | Schema |
3265+================================+===========================================+
3266| **capability**\ *optional* | string |
3267+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3268| **empty**\ *optional* | boolean |
3269+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3270| **leftOccurrences**\ *optional | string |
3271| * | |
3272+--------------------------------+-------------------------------------------+
3273| **maxOccurrences**\ *optional* | string |
3274+--------------------------------+-------------------------------------------+
3275| **minOccurrences**\ *optional* | string |
3276+--------------------------------+-------------------------------------------+
3277| **name**\ *optional* | string |
3278+--------------------------------+-------------------------------------------+
3279| **node**\ *optional* | string |
3280+--------------------------------+-------------------------------------------+
3281| **ownerId**\ *optional* | string |
3282+--------------------------------+-------------------------------------------+
3283| **ownerName**\ *optional* | string |
3284+--------------------------------+-------------------------------------------+
3285| **parentName**\ *optional* | string |
3286+--------------------------------+-------------------------------------------+
3287| **path**\ *optional* | < string > array |
3288+--------------------------------+-------------------------------------------+
3289| **relationship**\ *optional* | string |
3290+--------------------------------+-------------------------------------------+
3291| **source**\ *optional* | string |
3292+--------------------------------+-------------------------------------------+
3293| **uniqueId**\ *optional* | string |
3294+--------------------------------+-------------------------------------------+
3295
3296Resource
3297--------
3298
3299+--------------------------------+-------------------------------------------+
3300| Name | Schema |
3301+================================+===========================================+
3302| **abstract**\ *optional* | boolean |
3303+--------------------------------+-------------------------------------------+
3304| **additionalInformation**\ *op | < |
3305| tional* | `AdditionalInformationDefinition <#_addit |
3306| | ionalinformationdefinition>`__ |
3307| | > array |
3308+--------------------------------+-------------------------------------------+
3309| **allArtifacts**\ *optional* | < string, |
3310| | `ArtifactDefinition <#_artifactdefinition |
3311| | >`__ |
3312| | > map |
3313+--------------------------------+-------------------------------------------+
3314| **allVersions**\ *optional* | < string, string > map |
3315+--------------------------------+-------------------------------------------+
3316| **artifacts**\ *optional* | < string, |
3317| | `ArtifactDefinition <#_artifactdefinition |
3318| | >`__ |
3319| | > map |
3320+--------------------------------+-------------------------------------------+
3321| **attributes**\ *optional* | < |
3322| | `PropertyDefinition <#_propertydefinition |
3323| | >`__ |
3324| | > array |
3325+--------------------------------+-------------------------------------------+
3326| **capabilities**\ *optional* | < string, < |
3327| | `CapabilityDefinition <#_capabilitydefini |
3328| | tion>`__ |
3329| | > array > map |
3330+--------------------------------+-------------------------------------------+
3331| **categories**\ *optional* | < |
3332| | `CategoryDefinition <#_categorydefinition |
3333| | >`__ |
3334| | > array |
3335+--------------------------------+-------------------------------------------+
3336| **componentInstances**\ *optio | < |
3337| nal* | `ComponentInstance <#_componentinstance>` |
3338| | __ |
3339| | > array |
3340+--------------------------------+-------------------------------------------+
3341| **componentInstancesAttributes | < string, < |
3342| **\ *optional* | `ComponentInstanceProperty <#_componentin |
3343| | stanceproperty>`__ |
3344| | > array > map |
3345+--------------------------------+-------------------------------------------+
3346| **componentInstancesInputs**\ | < string, < |
3347| *optional* | `ComponentInstanceInput <#_componentinsta |
3348| | nceinput>`__ |
3349| | > array > map |
3350+--------------------------------+-------------------------------------------+
3351| **componentInstancesProperties | < string, < |
3352| **\ *optional* | `ComponentInstanceProperty <#_componentin |
3353| | stanceproperty>`__ |
3354| | > array > map |
3355+--------------------------------+-------------------------------------------+
3356| **componentInstancesRelations* | < |
3357| *\ *optional* | `RequirementCapabilityRelDef <#_requireme |
3358| | ntcapabilityreldef>`__ |
3359| | > array |
3360+--------------------------------+-------------------------------------------+
3361| **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component |
3362| *\ *optional* | metadatadefinition>`__ |
3363+--------------------------------+-------------------------------------------+
3364| **componentType**\ *optional* | enum (RESOURCE, SERVICE, |
3365| | RESOURCE\_INSTANCE, PRODUCT, |
3366| | SERVICE\_INSTANCE) |
3367+--------------------------------+-------------------------------------------+
3368| **conformanceLevel**\ *optiona | string |
3369| l* | |
3370+--------------------------------+-------------------------------------------+
3371| **contactId**\ *optional* | string |
3372+--------------------------------+-------------------------------------------+
3373| **cost**\ *optional* | string |
3374+--------------------------------+-------------------------------------------+
3375| **creationDate**\ *optional* | integer (int64) |
3376+--------------------------------+-------------------------------------------+
3377| **creatorFullName**\ *optional | string |
3378| * | |
3379+--------------------------------+-------------------------------------------+
3380| **creatorUserId**\ *optional* | string |
3381+--------------------------------+-------------------------------------------+
3382| **csarUUID**\ *optional* | string |
3383+--------------------------------+-------------------------------------------+
3384| **csarVersion**\ *optional* | string |
3385+--------------------------------+-------------------------------------------+
3386| **defaultCapabilities**\ *opti | < string > array |
3387| onal* | |
3388+--------------------------------+-------------------------------------------+
3389| **deploymentArtifacts**\ *opti | < string, |
3390| onal* | `ArtifactDefinition <#_artifactdefinition |
3391| | >`__ |
3392| | > map |
3393+--------------------------------+-------------------------------------------+
3394| **derivedFrom**\ *optional* | < string > array |
3395+--------------------------------+-------------------------------------------+
3396| **derivedFromGenericType**\ *o | string |
3397| ptional* | |
3398+--------------------------------+-------------------------------------------+
3399| **derivedFromGenericVersion**\ | string |
3400| *optional* | |
3401+--------------------------------+-------------------------------------------+
3402| **derivedList**\ *optional* | < string > array |
3403+--------------------------------+-------------------------------------------+
3404| **description**\ *optional* | string |
3405+--------------------------------+-------------------------------------------+
3406| **groups**\ *optional* | < `GroupDefinition <#_groupdefinition>`__ |
3407| | > array |
3408+--------------------------------+-------------------------------------------+
3409| **highestVersion**\ *optional* | boolean |
3410+--------------------------------+-------------------------------------------+
3411| **icon**\ *optional* | string |
3412+--------------------------------+-------------------------------------------+
3413| **importedToscaChecksum**\ *op | string |
3414| tional* | |
3415+--------------------------------+-------------------------------------------+
3416| **inputs**\ *optional* | < `InputDefinition <#_inputdefinition>`__ |
3417| | > array |
3418+--------------------------------+-------------------------------------------+
3419| **interfaces**\ *optional* | < string, |
3420| | `InterfaceDefinition <#_interfacedefiniti |
3421| | on>`__ |
3422| | > map |
3423+--------------------------------+-------------------------------------------+
3424| **invariantUUID**\ *optional* | string |
3425+--------------------------------+-------------------------------------------+
3426| **isDeleted**\ *optional* | boolean |
3427+--------------------------------+-------------------------------------------+
3428| **lastUpdateDate**\ *optional* | integer (int64) |
3429+--------------------------------+-------------------------------------------+
3430| **lastUpdaterFullName**\ *opti | string |
3431| onal* | |
3432+--------------------------------+-------------------------------------------+
3433| **lastUpdaterUserId**\ *option | string |
3434| al* | |
3435+--------------------------------+-------------------------------------------+
3436| **licenseType**\ *optional* | string |
3437+--------------------------------+-------------------------------------------+
3438| **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION, |
3439| | CERTIFICATION\_IN\_PROGRESS, CERTIFIED, |
3440| | NOT\_CERTIFIED\_CHECKIN, |
3441| | NOT\_CERTIFIED\_CHECKOUT) |
3442+--------------------------------+-------------------------------------------+
3443| **name**\ *optional* | string |
3444+--------------------------------+-------------------------------------------+
3445| **normalizedName**\ *optional* | string |
3446+--------------------------------+-------------------------------------------+
3447| **projectCode**\ *optional* | string |
3448+--------------------------------+-------------------------------------------+
3449| **properties**\ *optional* | < |
3450| | `PropertyDefinition <#_propertydefinition |
3451| | >`__ |
3452| | > array |
3453+--------------------------------+-------------------------------------------+
3454| **requirements**\ *optional* | < string, < |
3455| | `RequirementDefinition <#_requirementdefi |
3456| | nition>`__ |
3457| | > array > map |
3458+--------------------------------+-------------------------------------------+
3459| **resourceType**\ *optional* | enum (VFC, VF, CP, PNF, CVFC, VL, VFCMT, |
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3460| | Configuration, ServiceProxy, ABSTRACT) |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3461+--------------------------------+-------------------------------------------+
3462| **resourceVendorModelNumber**\ | string |
3463| *optional* | |
3464+--------------------------------+-------------------------------------------+
3465| **systemName**\ *optional* | string |
3466+--------------------------------+-------------------------------------------+
3467| **tags**\ *optional* | < string > array |
3468+--------------------------------+-------------------------------------------+
3469| **toscaArtifacts**\ *optional* | < string, |
3470| | `ArtifactDefinition <#_artifactdefinition |
3471| | >`__ |
3472| | > map |
3473+--------------------------------+-------------------------------------------+
3474| **toscaResourceName**\ *option | string |
3475| al* | |
3476+--------------------------------+-------------------------------------------+
3477| **toscaType**\ *optional* | string |
3478+--------------------------------+-------------------------------------------+
3479| **uniqueId**\ *optional* | string |
3480+--------------------------------+-------------------------------------------+
3481| **uuid**\ *optional* | string |
3482+--------------------------------+-------------------------------------------+
3483| **vendorName**\ *optional* | string |
3484+--------------------------------+-------------------------------------------+
3485| **vendorRelease**\ *optional* | string |
3486+--------------------------------+-------------------------------------------+
3487| **version**\ *optional* | string |
3488+--------------------------------+-------------------------------------------+
3489
3490SchemaDefinition
3491----------------
3492
3493+--------------------------------+-------------------------------------------+
3494| Name | Schema |
3495+================================+===========================================+
3496| **constraints**\ *optional* | < string > array |
3497+--------------------------------+-------------------------------------------+
3498| **derivedFrom**\ *optional* | string |
3499+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3500| **empty**\ *optional* | boolean |
3501+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3502| **ownerId**\ *optional* | string |
3503+--------------------------------+-------------------------------------------+
3504| **properties**\ *optional* | < string, |
3505| | `PropertyDataDefinition <#_propertydatade |
3506| | finition>`__ |
3507| | > map |
3508+--------------------------------+-------------------------------------------+
3509| **property**\ *optional* | `PropertyDataDefinition <#_propertydatade |
3510| | finition>`__ |
3511+--------------------------------+-------------------------------------------+
3512
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3513ServerListResponse
3514------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3515
3516+--------------------------------+-------------------------------------------+
3517| Name | Schema |
3518+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3519| **uebServerList**\ *optional* | < string > array |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3520+--------------------------------+-------------------------------------------+
3521
3522SubCategoryDefinition
3523---------------------
3524
3525+--------------------------------+-------------------------------------------+
3526| Name | Schema |
3527+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3528| **empty**\ *optional* | boolean |
3529+--------------------------------+-------------------------------------------+
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3530| **groupings**\ *optional* | < |
3531| | `GroupingDefinition <#_groupingdefinition |
3532| | >`__ |
3533| | > array |
3534+--------------------------------+-------------------------------------------+
3535| **icons**\ *optional* | < string > array |
3536+--------------------------------+-------------------------------------------+
3537| **name**\ *optional* | string |
3538+--------------------------------+-------------------------------------------+
3539| **normalizedName**\ *optional* | string |
3540+--------------------------------+-------------------------------------------+
3541| **ownerId**\ *optional* | string |
3542+--------------------------------+-------------------------------------------+
3543| **uniqueId**\ *optional* | string |
3544+--------------------------------+-------------------------------------------+
3545
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3546TopicRegistrationResponse
3547-------------------------
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3548
3549+--------------------------------+-------------------------------------------+
3550| Name | Schema |
3551+================================+===========================================+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3552| **distrNotificationTopicName** | string |
3553| \ *optional* | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3554+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3555| **distrStatusTopicName**\ *opt | string |
3556| ional* | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3557+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3558
3559TopicUnregistrationResponse
3560---------------------------
3561
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3562+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3563| Name | Schema |
3564+================================+===========================================+
3565| **distrNotificationTopicName** | string |
3566| \ *optional* | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3567+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3568| **distrStatusTopicName**\ *opt | string |
3569| ional* | |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3570+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3571| **notificationUnregisterResult | enum (OK, CONNNECTION\_ERROR, NOT\_FOUND, |
3572| **\ *optional* | TOPIC\_ALREADY\_EXIST, |
3573| | OBJECT\_NOT\_FOUND, |
3574| | INTERNAL\_SERVER\_ERROR, |
3575| | AUTHENTICATION\_ERROR, |
3576| | UNKNOWN\_HOST\_ERROR) |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3577+--------------------------------+-------------------------------------------+
Idan Amit32a53df2017-12-26 18:01:01 +0200[diff] [blame]3578| **statusUnregisterResult**\ *o | enum (OK, CONNNECTION\_ERROR, NOT\_FOUND, |
3579| ptional* | TOPIC\_ALREADY\_EXIST, |
3580| | OBJECT\_NOT\_FOUND, |
3581| | INTERNAL\_SERVER\_ERROR, |
3582| | AUTHENTICATION\_ERROR, |
3583| | UNKNOWN\_HOST\_ERROR) |
Idan Amit6e30a1b2017-10-18 09:51:10 +0300[diff] [blame]3584+--------------------------------+-------------------------------------------+