Gitiles
Code Review Sign In
gerrit.nordix.org / onap / policy / api / 478ac7c72dba1c26e7a79a08d50b6fd14441bf2a / . / postman / lifecycle-api-collection.json
blob: 4f240885c11b0ed1f0c4318ca7d1cb52eba15f56 [file] [log] [blame]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]1{
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]2 "info": {
3 "_postman_id": "50c9900b-7fbc-42f6-8d84-f3761824b96b",
4 "name": "Policy Framework Lifecycle API",
5 "description": "This collection lists all the Lifecycle API's supported by ONAP Policy Framework. These API's are used to perform CRUD operations for Policy, Policy Type & Data Type for all supported PDP engines.",
6 "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
7 },
8 "item": [
9 {
10 "name": "Lifecycle Api Healthcheck",
11 "request": {
12 "method": "GET",
13 "header": [
14 {
15 "key": "Content-Type",
16 "type": "text",
17 "value": "application/json"
18 },
19 {
20 "key": "Accept",
21 "type": "text",
22 "value": "application/json"
23 }
24 ],
25 "url": {
26 "raw": "{{POLICY-API-URL}}/policy/api/v1/healthcheck",
27 "host": [
28 "{{POLICY-API-URL}}"
29 ],
30 "path": [
31 "policy",
32 "api",
33 "v1",
34 "healthcheck"
35 ]
36 },
37 "description": "This is an API to fetch current healthcheck information for the policy-api component."
38 },
39 "response": []
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]40 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]41 {
42 "name": "Lifecycle Api Statistics",
43 "request": {
44 "method": "GET",
45 "header": [
46 {
47 "key": "Content-Type",
48 "type": "text",
49 "value": "application/json"
50 },
51 {
52 "key": "Accept",
53 "type": "text",
54 "value": "application/json"
55 }
56 ],
57 "url": {
58 "raw": "{{POLICY-API-URL}}/policy/api/v1/statistics",
59 "host": [
60 "{{POLICY-API-URL}}"
61 ],
62 "path": [
63 "policy",
64 "api",
65 "v1",
66 "statistics"
67 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]68 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]69 "description": "This is an API to fetch current statistics information for the policy-api component."
70 },
71 "response": []
72 },
73 {
74 "name": "Create Policy Type",
75 "request": {
76 "method": "POST",
77 "header": [
78 {
79 "key": "Accept",
80 "type": "text",
81 "value": "application/yaml"
82 },
83 {
84 "key": "Content-Type",
85 "type": "text",
86 "value": "application/yaml"
87 }
88 ],
89 "body": {
90 "mode": "raw",
91 "raw": "tosca_definitions_version: tosca_simple_yaml_1_1_0\npolicy_types:\n onap.policies.controlloop.operational.Common:\n derived_from: tosca.policies.Root\n version: 1.0.0\n description: |\n Operational Policy for Control Loop execution. Originated in Frankfurt to support TOSCA Compliant\n Policy Types. This does NOT support the legacy Policy YAML policy type.\n properties:\n id:\n type: string\n description: The unique control loop id.\n required: true\n timeout:\n type: integer\n description: |\n Overall timeout for executing all the operations. This timeout should equal or exceed the total\n timeout for each operation listed.\n required: true\n abatement:\n type: boolean\n description: Whether an abatement event message will be expected for the control loop from DCAE.\n required: true\n default: false\n trigger:\n type: string\n description: Initial operation to execute upon receiving an Onset event message for the Control Loop.\n required: true\n operations:\n type: list\n description: List of operations to be performed when Control Loop is triggered.\n required: true\n entry_schema:\n type: onap.datatype.controlloop.Operation\n\n onap.policies.controlloop.operational.common.Drools:\n derived_from: onap.policies.controlloop.operational.Common\n type_version: 1.0.0\n version: 1.0.0\n description: Operational policies for Drools PDP\n properties:\n controllerName:\n type: string\n description: Drools controller properties\n required: false\n\ndata_types:\n onap.datatype.controlloop.Target:\n derived_from: tosca.datatypes.Root\n description: Definition for a entity in A&AI to perform a control loop operation on\n properties:\n targetType:\n type: string\n description: Category for the target type\n required: true\n constraints:\n - valid_values: [VNF, VM, VFMODULE, PNF]\n entityIds:\n type: map\n description: |\n Map of values that identify the resource. If none are provided, it is assumed that the\n entity that generated the ONSET event will be the target.\n required: false\n metadata:\n clamp_possible_values: ClampExecution:CSAR_RESOURCES\n entry_schema:\n type: string\n\n onap.datatype.controlloop.Actor:\n derived_from: tosca.datatypes.Root\n description: An actor/operation/target definition\n properties:\n actor:\n type: string\n description: The actor performing the operation.\n required: true\n metadata:\n clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor\n operation:\n type: string\n description: The operation the actor is performing.\n metadata:\n clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation\n required: true\n target:\n type: onap.datatype.controlloop.Target\n description: The resource the operation should be performed on.\n required: true\n payload:\n type: map\n description: Name/value pairs of payload information passed by Policy to the actor\n required: false\n metadata:\n clamp_possible_values: ClampExecution:CDS/payload\n entry_schema:\n type: string\n\n onap.datatype.controlloop.Operation:\n derived_from: tosca.datatypes.Root\n description: An operation supported by an actor\n properties:\n id:\n type: string\n description: Unique identifier for the operation\n required: true\n description:\n type: string\n description: A user-friendly description of the intent for the operation\n required: false\n operation:\n type: onap.datatype.controlloop.Actor\n description: The definition of the operation to be performed.\n required: true\n timeout:\n type: integer\n description: The amount of time for the actor to perform the operation.\n required: true\n retries:\n type: integer\n description: The number of retries the actor should attempt to perform the operation.\n required: true\n default: 0\n success:\n type: string\n description: Points to the operation to invoke on success. A value of \"final_success\" indicates and end to the operation.\n required: false\n default: final_success\n failure:\n type: string\n description: Points to the operation to invoke on Actor operation failure.\n required: false\n default: final_failure\n failure_timeout:\n type: string\n description: Points to the operation to invoke when the time out for the operation occurs.\n required: false\n default: final_failure_timeout\n failure_retries:\n type: string\n description: Points to the operation to invoke when the current operation has exceeded its max retries.\n required: false\n default: final_failure_retries\n failure_exception:\n type: string\n description: Points to the operation to invoke when the current operation causes an exception.\n required: false\n default: final_failure_exception\n failure_guard:\n type: string\n description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.\n required: false\n default: final_failure_guard"
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]92 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]93 "url": {
94 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes",
95 "host": [
96 "{{POLICY-API-URL}}"
97 ],
98 "path": [
99 "policy",
100 "api",
101 "v1",
102 "policytypes"
103 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]104 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]105 "description": "This is a generic API to create one or more policy types together in a single API call."
106 },
107 "response": []
108 },
109 {
110 "name": "Fetch Policy Type",
111 "request": {
112 "method": "GET",
113 "header": [
114 {
115 "key": "Accept",
116 "type": "text",
117 "value": "application/json"
118 },
119 {
120 "key": "Content-Type",
121 "type": "text",
122 "value": "application/json"
123 }
124 ],
125 "url": {
126 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0",
127 "host": [
128 "{{POLICY-API-URL}}"
129 ],
130 "path": [
131 "policy",
132 "api",
133 "v1",
134 "policytypes",
135 "onap.policies.controlloop.operational.common.Drools",
136 "versions",
137 "1.0.0"
138 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]139 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]140 "description": "This is an API to fetch a specific policy type (example - \"onap.policies.controlloop.operational.common.Drools\") currently available in Policy DB."
141 },
142 "response": []
143 },
144 {
145 "name": "Fetch All Policy Types",
146 "request": {
147 "method": "GET",
148 "header": [
149 {
150 "key": "Accept",
151 "type": "text",
152 "value": "application/json"
153 },
154 {
155 "key": "Content-Type",
156 "type": "text",
157 "value": "application/json"
158 }
159 ],
160 "url": {
161 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes",
162 "host": [
163 "{{POLICY-API-URL}}"
164 ],
165 "path": [
166 "policy",
167 "api",
168 "v1",
169 "policytypes"
170 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]171 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]172 "description": "This is a generic API to fetch all policy types currently available in Policy DB."
173 },
174 "response": []
175 },
176 {
177 "name": "Fetch All Versions of Policy Type",
178 "request": {
179 "method": "GET",
180 "header": [
181 {
182 "key": "Accept",
183 "type": "text",
184 "value": "application/json"
185 },
186 {
187 "key": "Content-Type",
188 "type": "text",
189 "value": "application/json"
190 }
191 ],
192 "url": {
193 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools",
194 "host": [
195 "{{POLICY-API-URL}}"
196 ],
197 "path": [
198 "policy",
199 "api",
200 "v1",
201 "policytypes",
202 "onap.policies.controlloop.operational.common.Drools"
203 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]204 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]205 "description": "This is an API to fetch all versions of a specific policy type (example - \"onap.policies.controlloop.operational.common.Drools\") currently available in Policy DB."
206 },
207 "response": []
208 },
209 {
210 "name": "Fetch Latest Version of Policy Type",
211 "request": {
212 "method": "GET",
213 "header": [
214 {
215 "key": "Accept",
216 "type": "text",
217 "value": "application/json"
218 },
219 {
220 "key": "Content-Type",
221 "type": "text",
222 "value": "application/json"
223 }
224 ],
225 "url": {
226 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/latest",
227 "host": [
228 "{{POLICY-API-URL}}"
229 ],
230 "path": [
231 "policy",
232 "api",
233 "v1",
234 "policytypes",
235 "onap.policies.controlloop.operational.common.Drools",
236 "versions",
237 "latest"
238 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]239 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]240 "description": "This is an API to fetch latest versions of a specific policy type (example - \"onap.policies.controlloop.operational.common.Drools\") currently available in Policy DB."
241 },
242 "response": []
243 },
244 {
245 "name": "Delete Policy Type",
246 "request": {
247 "method": "DELETE",
248 "header": [
249 {
250 "key": "Accept",
251 "type": "text",
252 "value": "application/json"
253 },
254 {
255 "key": "Content-Type",
256 "type": "text",
257 "value": "application/json"
258 }
259 ],
260 "url": {
261 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0",
262 "host": [
263 "{{POLICY-API-URL}}"
264 ],
265 "path": [
266 "policy",
267 "api",
268 "v1",
269 "policytypes",
270 "onap.policies.controlloop.operational.common.Drools",
271 "versions",
272 "1.0.0"
273 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]274 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]275 "description": "This is an API to delete a specific policy type (example - \"onap.policies.controlloop.operational.common.Drools\") currently available in Policy DB."
276 },
277 "response": []
278 },
279 {
280 "name": "Create Policy (Generic)",
281 "request": {
282 "method": "POST",
283 "header": [
284 {
285 "key": "Accept",
286 "type": "text",
287 "value": "application/json"
288 },
289 {
290 "key": "Content-Type",
291 "type": "text",
292 "value": "application/json"
293 }
294 ],
295 "body": {
296 "mode": "raw",
297 "raw": "{\n \"tosca_definitions_version\": \"tosca_simple_yaml_1_1_0\",\n \"topology_template\": {\n \"policies\": [\n {\n \"operational.modifyconfig\": {\n \"type\": \"onap.policies.controlloop.operational.common.Drools\",\n \"type_version\": \"1.0.0\",\n \"version\": \"1.0.0\",\n \"metadata\": {\n \"policy-id\": \"operational.modifyconfig\"\n },\n \"properties\": {\n \"id\": \"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\",\n \"timeout\": 1200,\n \"abatement\": false,\n \"trigger\": \"unique-policy-id-1-modifyConfig\",\n \"operations\": [\n {\n \"id\": \"unique-policy-id-1-modifyConfig\",\n \"description\": \"Modify the packet generator\",\n \"operation\": {\n \"actor\": \"CDS\",\n \"operation\": \"modify-config\",\n \"target\": {\n \"targetType\": \"VNF\",\n \"entityIds\": {\n \"resourceID\": \"37b008b9-b367-4359-93fd-74d3ce0ee1a0\"\n }\n },\n \"payload\":{\n \"artifact_name\": \"vFW-CDS\",\n \"artifact_version\": \"1.0.0\",\n \"data\": \"{\\\"active-streams\\\": \\\"7\\\"}\"\n }\n },\n \"timeout\": 300,\n \"retries\": 0,\n \"success\": \"final_success\",\n \"failure\": \"final_failure\",\n \"failure_timeout\": \"final_failure_timeout\",\n \"failure_retries\": \"final_failure_retries\",\n \"failure_exception\": \"final_failure_exception\",\n \"failure_guard\": \"final_failure_guard\"\n }\n ],\n \"controllerName\": \"frankfurt\"\n }\n }\n }\n ]\n }\n}"
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]298 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]299 "url": {
300 "raw": "{{POLICY-API-URL}}/policy/api/v1/policies",
301 "host": [
302 "{{POLICY-API-URL}}"
303 ],
304 "path": [
305 "policy",
306 "api",
307 "v1",
308 "policies"
309 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]310 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]311 "description": "This is a generic API to create multiple policies together in a single API call. The individual policies can refer to same policy type or different policy types."
312 },
313 "response": []
314 },
315 {
316 "name": "Create Policy (Specific)",
317 "request": {
318 "method": "POST",
319 "header": [
320 {
321 "key": "Accept",
322 "type": "text",
323 "value": "application/json"
324 },
325 {
326 "key": "Content-Type",
327 "type": "text",
328 "value": "application/json"
329 }
330 ],
331 "body": {
332 "mode": "raw",
333 "raw": "{\n \"tosca_definitions_version\": \"tosca_simple_yaml_1_1_0\",\n \"topology_template\": {\n \"policies\": [\n {\n \"operational.modifyconfig\": {\n \"type\": \"onap.policies.controlloop.operational.common.Drools\",\n \"type_version\": \"1.0.0\",\n \"version\": \"1.0.0\",\n \"metadata\": {\n \"policy-id\": \"operational.modifyconfig\"\n },\n \"properties\": {\n \"id\": \"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\",\n \"timeout\": 1200,\n \"abatement\": false,\n \"trigger\": \"unique-policy-id-1-modifyConfig\",\n \"operations\": [\n {\n \"id\": \"unique-policy-id-1-modifyConfig\",\n \"description\": \"Modify the packet generator\",\n \"operation\": {\n \"actor\": \"CDS\",\n \"operation\": \"modify-config\",\n \"target\": {\n \"targetType\": \"VNF\",\n \"entityIds\": {\n \"resourceID\": \"37b008b9-b367-4359-93fd-74d3ce0ee1a0\"\n }\n },\n \"payload\":{\n \"artifact_name\": \"vFW-CDS\",\n \"artifact_version\": \"1.0.0\",\n \"data\": \"{\\\"active-streams\\\": \\\"7\\\"}\"\n }\n },\n \"timeout\": 300,\n \"retries\": 0,\n \"success\": \"final_success\",\n \"failure\": \"final_failure\",\n \"failure_timeout\": \"final_failure_timeout\",\n \"failure_retries\": \"final_failure_retries\",\n \"failure_exception\": \"final_failure_exception\",\n \"failure_guard\": \"final_failure_guard\"\n }\n ],\n \"controllerName\": \"frankfurt\"\n }\n }\n }\n ]\n }\n}"
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]334 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]335 "url": {
336 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies",
337 "host": [
338 "{{POLICY-API-URL}}"
339 ],
340 "path": [
341 "policy",
342 "api",
343 "v1",
344 "policytypes",
345 "onap.policies.controlloop.operational.common.Drools",
346 "versions",
347 "1.0.0",
348 "policies"
349 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]350 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]351 "description": "This is a specific API to create a policy referring to the given policy type (example - \"onap.policies.controlloop.operational.common.Drools\"). The same API can be used to create policy for any policy type to be deployed in any supported PDP engine."
352 },
353 "response": []
354 },
355 {
356 "name": "Create Policy (Legacy)",
357 "request": {
358 "method": "POST",
359 "header": [
360 {
361 "key": "Accept",
362 "type": "text",
363 "value": "application/yaml"
364 },
365 {
366 "key": "Content-Type",
367 "type": "text",
368 "value": "application/yaml"
369 }
370 ],
371 "body": {
372 "mode": "raw",
373 "raw": "{\n \"policy-id\" : \"operational.modifyconfiglegacy\",\n \"content\" : \"controlLoop%3A%0A%20%20version%3A%202.0.0%0A%20%20controlLoopName%3A%20ControlLoop-vFirewall-7e4fbe9c-d612-4ec5-bbf8-605aeabdb677%0A%20%20trigger_policy%3A%20unique-policy-id-1-modifyConfig%0A%20%20timeout%3A%2060%0A%20%20abatement%3A%20false%0Apolicies%3A%0A%20%20-%20id%3A%20unique-policy-id-1-modifyConfig%0A%20%20%20%20name%3A%20modifyconfig-cds-actor%0A%20%20%20%20description%3A%0A%20%20%20%20actor%3A%20CDS%0A%20%20%20%20recipe%3A%20modify-config%0A%20%20%20%20target%3A%0A%20%20%20%20%20%20resourceID%3A%2037b008b9-b367-4359-93fd-74d3ce0ee1a0%0A%20%20%20%20%20%20type%3A%20VNF%0A%20%20%20%20payload%3A%0A%20%20%20%20%20%20artifact_name%3A%20vFW-CDS%0A%20%20%20%20%20%20artifact_version%3A%201.0.0%0A%20%20%20%20%20%20data%3A%20%27%7B%22active-streams%22%3A%227%22%7D%27%0A%20%20%20%20retry%3A%200%0A%20%20%20%20timeout%3A%2030%0A%20%20%20%20success%3A%20final_success%0A%20%20%20%20failure%3A%20final_failure%0A%20%20%20%20failure_timeout%3A%20final_failure_timeout%0A%20%20%20%20failure_retries%3A%20final_failure_retries%0A%20%20%20%20failure_exception%3A%20final_failure_exception%0A%20%20%20%20failure_guard%3A%20final_failure_guard\"\n}"
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]374 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]375 "url": {
376 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies",
377 "host": [
378 "{{POLICY-API-URL}}"
379 ],
380 "path": [
381 "policy",
382 "api",
383 "v1",
384 "policytypes",
385 "onap.policies.controlloop.Operational",
386 "versions",
387 "1.0.0",
388 "policies"
389 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]390 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]391 "description": "This is a specific API to create a policy of type \"onap.policies.controlloop.Operational\", used to create legacy control loop operational policy aimed to be deployed in drools-pdp engine."
392 },
393 "response": []
394 },
395 {
396 "name": "Fetch Policy (Specific)",
397 "request": {
398 "method": "GET",
399 "header": [
400 {
401 "key": "Accept",
402 "type": "text",
403 "value": "application/json"
404 },
405 {
406 "key": "Content-Type",
407 "type": "text",
408 "value": "application/json"
409 }
410 ],
411 "url": {
412 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/1.0.0",
413 "host": [
414 "{{POLICY-API-URL}}"
415 ],
416 "path": [
417 "policy",
418 "api",
419 "v1",
420 "policytypes",
421 "onap.policies.controlloop.operational.common.Drools",
422 "versions",
423 "1.0.0",
424 "policies",
425 "operational.modifyconfig",
426 "versions",
427 "1.0.0"
428 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]429 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]430 "description": "This is a specific API to fetch a policy (example - operational.modifyconfig) referring to the given policy type (example - \"onap.policies.controlloop.operational.common.Drools\"). The same API can be used to fetch a policy referring to any policy type currently available in Policy DB."
431 },
432 "response": []
433 },
434 {
435 "name": "Fetch All Policies without specifying policyType",
436 "request": {
437 "method": "GET",
438 "header": [
439 {
440 "key": "Accept",
441 "type": "text",
442 "value": "application/json"
443 },
444 {
445 "key": "Content-Type",
446 "type": "text",
447 "value": "application/json"
448 }
449 ],
450 "url": {
451 "raw": "{{POLICY-API-URL}}/policy/api/v1/policies",
452 "host": [
453 "{{POLICY-API-URL}}"
454 ],
455 "path": [
456 "policy",
457 "api",
458 "v1",
459 "policies"
460 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]461 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]462 "description": "This is a specific API to fetch all policies currently available in Policy DB."
463 },
464 "response": []
465 },
466 {
467 "name": "Fetch Policy without specifying policyType (Specific)",
468 "request": {
469 "method": "GET",
470 "header": [
471 {
472 "key": "Accept",
473 "type": "text",
474 "value": "application/json"
475 },
476 {
477 "key": "Content-Type",
478 "type": "text",
479 "value": "application/json"
480 }
481 ],
482 "url": {
483 "raw": "{{POLICY-API-URL}}/policy/api/v1/policies/operational.modifyconfig/versions/1.0.0",
484 "host": [
485 "{{POLICY-API-URL}}"
486 ],
487 "path": [
488 "policy",
489 "api",
490 "v1",
491 "policies",
492 "operational.modifyconfig",
493 "versions",
494 "1.0.0"
495 ]
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]496 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]497 "description": "This is a specific API to fetch a policy (example - operational.modifyconfig). The same API can be used to fetch a policy without referring to any policy type currently available in Policy DB."
498 },
499 "response": []
500 },
501 {
502 "name": "Fetch Policy (Legacy)",
503 "request": {
504 "method": "GET",
505 "header": [
506 {
507 "key": "Accept",
508 "type": "text",
509 "value": "application/json"
510 },
511 {
512 "key": "Content-Type",
513 "type": "text",
514 "value": "application/json"
515 }
516 ],
517 "url": {
518 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/operational.modifyconfiglegacy/versions/1",
519 "host": [
520 "{{POLICY-API-URL}}"
521 ],
522 "path": [
523 "policy",
524 "api",
525 "v1",
526 "policytypes",
527 "onap.policies.controlloop.Operational",
528 "versions",
529 "1.0.0",
530 "policies",
531 "operational.modifyconfiglegacy",
532 "versions",
533 "1"
534 ]
535 },
536 "description": "This is a specific API to fetch a policy (example - operational.modifyconfig) referring to the specific policy type \"onap.policies.controlloop.Operational\" currently available in Policy DB."
537 },
538 "response": []
539 },
540 {
541 "name": "Fetch All Policies (Specific)",
542 "request": {
543 "method": "GET",
544 "header": [
545 {
546 "key": "Accept",
547 "type": "text",
548 "value": "application/json"
549 },
550 {
551 "key": "Content-Type",
552 "type": "text",
553 "value": "application/json"
554 }
555 ],
556 "url": {
557 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies",
558 "host": [
559 "{{POLICY-API-URL}}"
560 ],
561 "path": [
562 "policy",
563 "api",
564 "v1",
565 "policytypes",
566 "onap.policies.controlloop.operational.common.Drools",
567 "versions",
568 "1.0.0",
569 "policies"
570 ]
571 },
572 "description": "This is a specific API to fetch all policies referring to the given policy type (example - \"onap.policies.controlloop.operational.common.Drools\"). The same API can be used to fetch policies for any policy type currently available in Policy DB."
573 },
574 "response": []
575 },
576 {
577 "name": "Fetch All Version of a Policy (Specific)",
578 "request": {
579 "method": "GET",
580 "header": [
581 {
582 "key": "Accept",
583 "type": "text",
584 "value": "application/json"
585 },
586 {
587 "key": "Content-Type",
588 "type": "text",
589 "value": "application/json"
590 }
591 ],
592 "url": {
593 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig",
594 "host": [
595 "{{POLICY-API-URL}}"
596 ],
597 "path": [
598 "policy",
599 "api",
600 "v1",
601 "policytypes",
602 "onap.policies.controlloop.operational.common.Drools",
603 "versions",
604 "1.0.0",
605 "policies",
606 "operational.modifyconfig"
607 ]
608 },
609 "description": "This is a specific API to fetch all versions of a policy (example - operational.modifyconfig) referring to the given policy type (example - \"onap.policies.controlloop.operational.common.Drools\"). The same API can be used to fetch all versions of a policy referring to any policy type currently available in Policy DB."
610 },
611 "response": []
612 },
613 {
614 "name": "Fetch Latest Version of a Policy (Specific)",
615 "request": {
616 "method": "GET",
617 "header": [
618 {
619 "key": "Accept",
620 "type": "text",
621 "value": "application/json"
622 },
623 {
624 "key": "Content-Type",
625 "type": "text",
626 "value": "application/json"
627 }
628 ],
629 "url": {
630 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/latest",
631 "host": [
632 "{{POLICY-API-URL}}"
633 ],
634 "path": [
635 "policy",
636 "api",
637 "v1",
638 "policytypes",
639 "onap.policies.controlloop.operational.common.Drools",
640 "versions",
641 "1.0.0",
642 "policies",
643 "operational.modifyconfig",
644 "versions",
645 "latest"
646 ]
647 },
648 "description": "This is a specific API to fetch latest version of a policy (example - operational.modifyconfig) referring to the given policy type (example - \"onap.policies.controlloop.operational.common.Drools\"). The same API can be used to fetch latest version of a policy referring to any policy type currently available in Policy DB."
649 },
650 "response": []
651 },
652 {
653 "name": "Delete Policy (Specific)",
654 "request": {
655 "method": "DELETE",
656 "header": [
657 {
658 "key": "Accept",
659 "value": "application/json",
660 "type": "text"
661 },
662 {
663 "key": "Content-Type",
664 "value": "application/json",
665 "type": "text"
666 }
667 ],
668 "url": {
669 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/1.0.0",
670 "host": [
671 "{{POLICY-API-URL}}"
672 ],
673 "path": [
674 "policy",
675 "api",
676 "v1",
677 "policytypes",
678 "onap.policies.controlloop.operational.common.Drools",
679 "versions",
680 "1.0.0",
681 "policies",
682 "operational.modifyconfig",
683 "versions",
684 "1.0.0"
685 ]
686 },
687 "description": "This is a specific API to delete a policy (example - operational.modifyconfig) referring to the given policy type (example - \"onap.policies.controlloop.operational.common.Drools\"). The same API can be used to delete a policy referring to any policy type currently available in Policy DB."
688 },
689 "response": []
690 },
691 {
692 "name": "Delete Policy without specifying policyType (Specific)",
693 "request": {
694 "method": "DELETE",
695 "header": [
696 {
697 "key": "Accept",
698 "type": "text",
699 "value": "application/json"
700 },
701 {
702 "key": "Content-Type",
703 "type": "text",
704 "value": "application/json"
705 }
706 ],
707 "url": {
708 "raw": "{{POLICY-API-URL}}/policy/api/v1/policies/operational.modifyconfig/versions/1.0.0",
709 "host": [
710 "{{POLICY-API-URL}}"
711 ],
712 "path": [
713 "policy",
714 "api",
715 "v1",
716 "policies",
717 "operational.modifyconfig",
718 "versions",
719 "1.0.0"
720 ]
721 },
722 "description": "This is a specific API to delete a policy (example - operational.modifyconfig). The same API can be used to delete a policy without referring to any policy type currently available in Policy DB."
723 },
724 "response": []
725 },
726 {
727 "name": "Delete Policy (Legacy)",
728 "request": {
729 "method": "DELETE",
730 "header": [
731 {
732 "key": "Accept",
733 "value": "application/json",
734 "type": "text"
735 },
736 {
737 "key": "Content-Type",
738 "value": "application/json",
739 "type": "text"
740 }
741 ],
742 "url": {
743 "raw": "{{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/operational.modifyconfiglegacy/versions/1",
744 "host": [
745 "{{POLICY-API-URL}}"
746 ],
747 "path": [
748 "policy",
749 "api",
750 "v1",
751 "policytypes",
752 "onap.policies.controlloop.Operational",
753 "versions",
754 "1.0.0",
755 "policies",
756 "operational.modifyconfiglegacy",
757 "versions",
758 "1"
759 ]
760 },
761 "description": "This is a specific API to delete a policy (example - operational.modifyconfiglegacy) referring to the specific policy type \"onap.policies.controlloop.Operational\" currently available in Policy DB."
762 },
763 "response": []
764 }
765 ],
766 "auth": {
767 "type": "basic",
768 "basic": [
769 {
770 "key": "password",
771 "value": "{{PASSWORD}}",
772 "type": "string"
773 },
774 {
775 "key": "username",
776 "value": "{{USER}}",
777 "type": "string"
778 }
779 ]
780 },
781 "event": [
782 {
783 "listen": "prerequest",
784 "script": {
785 "id": "baf39e37-fd26-4171-82eb-f05352acc45e",
786 "type": "text/javascript",
787 "exec": [
788 ""
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]789 ]
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]790 }
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]791 },
puthuparambil.aditya478ac7c2020-07-17 11:13:49 +0100[diff] [blame^]792 {
793 "listen": "test",
794 "script": {
795 "id": "5ba39dc8-fe5c-48fb-a157-c7bb26641a75",
796 "type": "text/javascript",
797 "exec": [
798 ""
799 ]
800 }
801 }
802 ],
803 "variable": [
804 {
805 "id": "99d48afc-d62d-48be-9f89-d7db5acf48dd",
806 "key": "USER",
807 "value": "healthcheck",
808 "type": "string"
809 },
810 {
811 "id": "a9c660a8-2bd1-4e87-aacd-aa6ff2104a60",
812 "key": "PASSWORD",
813 "value": "zb!XztG34",
814 "type": "string"
815 }
816 ],
817 "protocolProfileBehavior": {}
Ram Krishna Vermadd1911f2020-06-01 18:03:21 -0400[diff] [blame]818}