| .. This work is licensed under a Creative Commons Attribution 4.0 |
| International License. http://creativecommons.org/licenses/by/4.0 |
| Copyright 2017 AT&T Intellectual Property. All rights reserved. |
| |
| .. index:: API Reference |
| |
| .. _doc-apiref: |
| |
| REST API Reference |
| ================== |
| |
| .. note:: |
| Some high level groupings are introduced below with references to |
| REST API offered by the various components. |
| |
| User Interfaces |
| --------------- |
| |
| .. toctree:: |
| :maxdepth: 1 |
| :titlesonly: |
| |
| CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/index.rst> |
| Portal <../../../submodules/portal.git/docs/platform/offeredapis.rst> |
| SDC - Service Design and Creation <../../../submodules/sdc.git/docs/offeredapis.rst> |
| VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/offeredapis.rst> |
| |
| Platform Components |
| ------------------- |
| |
| .. toctree:: |
| :maxdepth: 1 |
| :titlesonly: |
| |
| APPC - Application Controller <../../../submodules/appc.git/docs/index.rst> |
| DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst> |
| Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst> |
| Policy <../../../submodules/policy/parent.git/docs/offeredapis.rst> |
| SDNC - SDN Controller <../../../submodules/sdnc/oam.git/docs/offeredapis.rst> |
| SO - Service Orchestration <../../../submodules/so.git/docs/api/offered_consumed_apis.rst> |
| VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst> |
| |
| Common Services |
| --------------- |
| |
| .. toctree:: |
| :maxdepth: 1 |
| :titlesonly: |
| |
| AAF - Application Authorization Framework <../../../submodules/aaf/sms.git/docs/api.rst> |
| AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI.rst> |
| AAI ESR - AAI External System Register <../../../submodules/aai/esr-server.git/docs/offeredapis.rst> |
| DMAAP DBC - Data Management as a Platform (Data Bus Controller) <../../../submodules/dmaap/dbcapi.git/docs/api.rst> |
| DMAAP DR - Data Management as a Platform (Data Router) <../../../submodules/dmaap/datarouter.git/docs/index.rst> |
| DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst> |
| ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst> |
| Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst> |
| MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst> |
| Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-APIv1-Specification.rst> |
| MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst> |
| OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst> |
| |
| SDK |
| --- |
| |
| .. toctree:: |
| :maxdepth: 1 |
| :titlesonly: |
| |
| VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst> |
| |
| |
| Some ONAP Postman collections |
| ----------------------------- |
| |
| .. toctree:: |
| :maxdepth: 1 |
| :titlesonly: |
| |
| Some ONAP Postman collections <../../../submodules/integration.git/docs/docs_postman.rst> |