Merge "Update architecture diagram"
[aai/esr-server.git] / docs / platform / consumedapis.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Consumed APIs
5 -------------
6
7 In the Amsterdam release, Holmes does not consume any APIs provided by other ONAP components.
8
9 A&AI
10 ^^^^
11
12 ESR stored external system data to A&AI. EMS/VNFM/Third-party SDNC operation API included in external system namespace. VIM operation API included in CloudInfrastructure namespace.
13
14 #. VIM management API:
15
16    ``PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}``
17    
18    ``GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}``
19
20    ``GET /cloud-infrastructure/cloud-regions``
21    
22    ``DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}``
23    
24 #. VNFM management API:
25
26    ``PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}``
27    
28    ``GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}``
29
30    ``GET /external-system/esr-vnfm-list``
31    
32    ``DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}``
33    
34 #. EMS management API:
35
36    ``PUT /external-system/esr-ems-list/esr-ems/{ems-id}``
37    
38    ``GET /external-system/esr-ems-list/esr-ems/{ems-id}``
39
40    ``GET /external-system/esr-ems-list``
41    
42    ``DELETE /external-system/esr-ems-list/esr-ems/{ems-id}``
43    
44 #. Thirdparty SDNC management API:
45
46    ``PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}``
47    
48    ``GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}``
49
50    ``GET /external-system/esr-thirdparty-sdnc-list``
51    
52    ``DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}``   
53
54 More details could be found at `A&AI APIs <https://wiki.onap.org/pages/viewpage.action?pageId=13598793>`_. 
55    
56 Multi-Cloud
57 ^^^^^^^^^^^
58
59 ESR will call the API from Multi-Cloud to update the cloud-region information after put the VIM data to A&AI.
60
61 #. Update VIM Info:
62
63    ``POST /api/multicloud /v0/{cloud-owner}_{cloud-region}/registry``
64
65 More details could be found at `Multi-Cloud APIs <https://wiki.onap.org/download/attachments/13599038/MultiVIM-onap-draft-r1-0822.doc?version=1&modificationDate=1503406573000&api=v2>`_.
66    
67 MSB
68 ^^^
69
70 Both esr-server and esr-gui need to registered to MSB.
71
72 Service Registration: ``/api/microservices/v1/services``
73
74 More details could be found at `MSB APIs <https://wiki.onap.org/display/DW/Microservice+Bus+API+Documentation>`_.