...
The diagram describes the discovery process from the point when a user access SDC.
...
Rest endpoint
...
Request (GET)
The used resource is:
https://{serverRoot}/sdc1/config/ui/plugins
Name | Description |
serverRoot | Server base URL : URL hostname+port path Hostname shall contain the FQDN of the SDC FE server or vip |
...
VIP |
Special Request Headers
Header Name | Mandatory? | Description |
X-ECOMP-RequestID | N | According to the general |
agreement the "X-ECOMP-RequestID" header |
with the transaction UUID should be |
published by |
component calling |
an exposed by other component API in order |
to make possible |
the transaction traceability across ECOMP. If it is not sent it will be automatically generated by SDC on request receipt. | ||
Accept | N | Determines the format of the body of the response. Valid values are : “application/json” |
...
Request Body
N/A
2.4.1.3 Request Sample
| Info | ||||
|---|---|---|---|---|
| ||||
GET sdc1/config/ui/plugins HTTP/1.1 Accept : application/json X-ECOMP-RequestID: AA97B177-9383-4934-8543-0F91A7A02836 |
...
Response
...
Special Response Headers
Header Name | Description |
Content-Type | Determines the format of the response body. Valid value is : “application/json” |
Content-Length | Length of the response body |
...
Response body
Response body is returned as JSON object (Content-Type: application/json).
Parameter Name | Parameter Type | Description |
List of objects | A List describing each plugin location and configuration for the UI integration. |
Plugin list:
Parameter Name | Parameter Type | Description |
pluginId | String | The id of the plugin |
pluginDiscoveryUrl | String | The URL which will be used to check the plugin availability |
pluginSourceUrl | String | The URL which will be used to load the plugin page |
pluginDisplayOptions | Map of objects | An map of object representing the plugin options, the currently supported options are tab and context. |
isOnline | Boolean | This value indicates to the SDC UI if the plugin is currently online. If the plugin is down an attempt to open the plugin will result in an error screen. |
...
PluginDisplayOptions tab:
Parameter Name | Parameter Type | Description |
displayName | String | The name to show for this plugin in the tab area. |
displayRoles | List of string | The user roles for which this plugin will be shown. Supported roles are: ADMIN, DESIGNER, TESTER, OPS, GOVERNOR |
...