summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authork.kazak <k.kazak@samsung.com>2019-07-26 17:04:59 +0200
committerk.kazak <k.kazak@samsung.com>2019-07-26 17:04:59 +0200
commit1acd44ec87a77858db96ee1ef36dbb6c79cf5ed8 (patch)
tree964c3b005fdaa177f95c2ffe3cc190113d6ed8f2 /docs/api
parent7e9581d1cab9604abdf0c3397877a100567bc33c (diff)
fix malformed tables in docs
Fixed malformed tables in SO Interfaces documentation page Change-Id: I77e4a272bbcc735da8c07dc45cf548787091e0a0 Issue-ID: SO-2152 Signed-off-by: k.kazak <k.kazak@samsung.com>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/apis/SO_Interface.rst480
1 files changed, 240 insertions, 240 deletions
diff --git a/docs/api/apis/SO_Interface.rst b/docs/api/apis/SO_Interface.rst
index b079989aff..d1586eb5d0 100644
--- a/docs/api/apis/SO_Interface.rst
+++ b/docs/api/apis/SO_Interface.rst
@@ -3,7 +3,7 @@
.. Copyright 2018 Huawei Technologies Co., Ltd.
SO Interfaces
-================================
+=============
.. image:: ../../images/SO_1.png
@@ -13,17 +13,17 @@ SO APIs
North Bound APIs
----------------
Create service instance
-++++++++++++++++++++++++
++++++++++++++++++++++++
-+--------------------+-------------------------------------+
-|Interface Definition|Description |
-+====================+=====================================+
++--------------------+------------------------------------------------------------+
+|Interface Definition|Description |
++====================+============================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6 |
-+--------------------+-------------------------------------+
-|Operation Type |POST |
-+--------------------+-------------------------------------+
-|Content-Type |application/json |
-+--------------------+-------------------------------------+
++--------------------+------------------------------------------------------------+
+|Operation Type |POST |
++--------------------+------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+------------------------------------------------------------+
Request Body:
@@ -205,17 +205,17 @@ LineOfBusiness Object
+-------------------------+------------------+-------------------------------------------------+
Delete service instance
-++++++++++++++++++++++++
++++++++++++++++++++++++
-+--------------------+---------------------------------------------------------+
-|Interface Definition|Description |
-+====================+=========================================================+
++--------------------+--------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+================================================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId} |
-+--------------------+---------------------------------------------------------+
-|Operation Type |DELETE |
-+--------------------+---------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+---------------------------------------------------------+
++--------------------+--------------------------------------------------------------------------------+
+|Operation Type |DELETE |
++--------------------+--------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+--------------------------------------------------------------------------------+
Request Body:
@@ -258,17 +258,17 @@ RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
Create Volume Group
-++++++++++++++++++++++++
++++++++++++++++++++
-+--------------------+-------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+===========================================================================================+
++--------------------+------------------------------------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+==================================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
-+--------------------+-------------------------------------------------------------------------------------------+
-|Operation Type |POST |
-+--------------------+-------------------------------------------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+-------------------------------------------------------------------------------------------+
++--------------------+------------------------------------------------------------------------------------------------------------------+
+|Operation Type |POST |
++--------------------+------------------------------------------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+------------------------------------------------------------------------------------------------------------------+
Request Body:
@@ -389,17 +389,17 @@ relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
Delete Volume Group
-++++++++++++++++++++++++
++++++++++++++++++++
-+--------------------+---------------------------------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+=====================================================================================================================+
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+============================================================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
-+--------------------+---------------------------------------------------------------------------------------------------------------------+
-|Operation Type |DELETE |
-+--------------------+---------------------------------------------------------------------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+---------------------------------------------------------------------------------------------------------------------+
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|Operation Type |DELETE |
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
Request Body:
@@ -450,17 +450,17 @@ RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
Create VF Module
-+++++++++++++++++
+++++++++++++++++
-+--------------------+----------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+========================================================================================+
++--------------------+---------------------------------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+===============================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
-+--------------------+----------------------------------------------------------------------------------------+
-|Operation Type |POST |
-+--------------------+----------------------------------------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+----------------------------------------------------------------------------------------+
++--------------------+---------------------------------------------------------------------------------------------------------------+
+|Operation Type |POST |
++--------------------+---------------------------------------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+---------------------------------------------------------------------------------------------------------------+
Request Body:
@@ -545,17 +545,17 @@ relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
Delete VF Module
-++++++++++++++++++++++++
+++++++++++++++++
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================================================================+
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+=====================================================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Operation Type |DELETE |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+|Operation Type |DELETE |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Request Body:
@@ -614,17 +614,17 @@ RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
Create VNF
-+++++++++++++++
+++++++++++
-+--------------------+--------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================+
++--------------------+-------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+=====================================================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs |
-+--------------------+--------------------------------------------------------------+
-|Operation Type |POST |
-+--------------------+--------------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+--------------------------------------------------------------+
++--------------------+-------------------------------------------------------------------------------------+
+|Operation Type |POST |
++--------------------+-------------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+-------------------------------------------------------------------------------------+
Request Body:
@@ -761,17 +761,17 @@ UserParams Object
+-------------------------+------------------+-------------------------------------------------+
Delete VNF
-+++++++++++++++
+++++++++++
-+--------------------+------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================================+
++--------------------+-----------------------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+=====================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId} |
-+--------------------+------------------------------------------------------------------------------+
-|Operation Type |DELETE |
-+--------------------+------------------------------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+------------------------------------------------------------------------------+
++--------------------+-----------------------------------------------------------------------------------------------------+
+|Operation Type |DELETE |
++--------------------+-----------------------------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+-----------------------------------------------------------------------------------------------------+
Request Body:
@@ -842,17 +842,17 @@ UserParams Object
+-------------------------+------------------+-------------------------------------------------+
GET Orchestration Request
-++++++++++++++++++++++++++
++++++++++++++++++++++++++
-+--------------------+--------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================+
++--------------------+-------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+=====================================================================================+
|URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6/{request-id} |
-+--------------------+--------------------------------------------------------------+
-|Operation Type |GET |
-+--------------------+--------------------------------------------------------------+
-|Content-Type |application/json |
-+--------------------+--------------------------------------------------------------+
++--------------------+-------------------------------------------------------------------------------------+
+|Operation Type |GET |
++--------------------+-------------------------------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+-------------------------------------------------------------------------------------+
Response Body:
@@ -998,7 +998,7 @@ GET Orchestration Requests
+--------------------+--------------------------------------------------------------+
|Interface Definition|Description |
+====================+==============================================================+
-|URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6 |
+|URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6 |
+--------------------+--------------------------------------------------------------+
|Operation Type |GET |
+--------------------+--------------------------------------------------------------+
@@ -1152,7 +1152,7 @@ RequestStatus Object
+-------------------------+------------------+-------------------------------------------------+
SDC Client API
-------------------
+--------------
Get List of Existing Catalog Assets
+++++++++++++++++++++++++++++++++++
@@ -1291,7 +1291,7 @@ Response:
Resource Object:
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Content|Description | |
+|Attribute |Qualifier|Content|Description |
+=====================+=========+=======+===================================================================================================================+
|resourceInstanceName |M |String |Logical Resource Instance Name.Unique Identifier of the instance of the specific resource in the service context.|
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
@@ -1372,20 +1372,20 @@ Response:
+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
E2E Service API
-----------------
+---------------
Create E2E service instance
-++++++++++++++++++++++++++++
++++++++++++++++++++++++++++
-+--------------------+-------------------------------------+
-|Interface Definition|Description |
-+====================+=====================================+
++--------------------+------------------------------------------------------------+
+|Interface Definition|Description |
++====================+============================================================+
|URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3 |
-+--------------------+-------------------------------------+
-|Operation Type |POST |
-+--------------------+-------------------------------------+
-|Content-Type |application/json |
-+--------------------+-------------------------------------+
++--------------------+------------------------------------------------------------+
+|Operation Type |POST |
++--------------------+------------------------------------------------------------+
+|Content-Type |application/json |
++--------------------+------------------------------------------------------------+
Request Body:
@@ -1424,7 +1424,7 @@ Parameter Object
+------------------------------+-----------------+------------------------------------+
|resource |List of Resource |resource of service/resource |
+------------------------------+-----------------+------------------------------------+
-|requestInputs |key-value map |input of service/resource
+|requestInputs |key-value map |input of service/resource |
+------------------------------+-----------------+------------------------------------+
LocationConstraint Object
@@ -1472,15 +1472,15 @@ Response:
+-------------+---------+-----------+-------+------------------------------------------------------------------------+
Delete E2E service instance
-++++++++++++++++++++++++++++
++++++++++++++++++++++++++++
-+--------------------+-----------------------------------------------+
-|Interface Definition|Description |
-+====================+===============================================+
++--------------------+----------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+======================================================================+
|URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}|
-+--------------------+-----------------------------------------------+
-|Operation Type |DELETE |
-+--------------------+-----------------------------------------------+
++--------------------+----------------------------------------------------------------------+
+|Operation Type |DELETE |
++--------------------+----------------------------------------------------------------------+
Request Parameters:
@@ -1501,15 +1501,15 @@ Response:
+-------------+---------+-----------+-------+------------------------------------------------------------------------+
Query E2E service operation result
-++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++
-+--------------------+------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+========================================================================+
++--------------------+-----------------------------------------------------------------------------------------------+
+|Interface Definition|Description |
++====================+===============================================================================================+
|URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
-+--------------------+------------------------------------------------------------------------+
-|Operation Type |GET |
-+--------------------+------------------------------------------------------------------------+
++--------------------+-----------------------------------------------------------------------------------------------+
+|Operation Type |GET |
++--------------------+-----------------------------------------------------------------------------------------------+
Request Parameters:
@@ -1548,7 +1548,7 @@ Response:
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
Inventory APIs
-----------------
+--------------
create or update an existing service-instance
+++++++++++++++++++++++++++++++++++++++++++++
@@ -1740,10 +1740,10 @@ Response:
VFC APIs
----------
+--------
Create NS
-+++++++++++
++++++++++
+--------------------+-------------------+
|Interface Definition|Description |
@@ -1778,7 +1778,7 @@ Response:
+-----------------+---------+-----------+----------------+-------------------+
Get NS
-+++++++
+++++++
+--------------------+-------------------+
|Interface Definition|Description |
@@ -1869,7 +1869,7 @@ vnffgInfo Array:
+----------------------+---------+-----------+----------------+-------------------+
Instantiate NS
-+++++++++++++++
+++++++++++++++
+--------------------+-------------------------------------+
|Interface Definition|Description |
@@ -1898,7 +1898,7 @@ LocationConstraints Array:
+----------------------+---------+-----------+-------+-----------------------+
|Attribute |Qualifier|Cardinality|Content|Description |
+======================+=========+===========+=======+=======================+
-|vnfProfileId |M |1 |String |vnfProfileId |
+|vnfProfileId |M |1 |String |vnfProfileId |
+----------------------+---------+-----------+-------+-----------------------+
|vimid |M |1 |String |vimid |
+----------------------+---------+-----------+-------+-----------------------+
@@ -1912,7 +1912,7 @@ Response:
+--------------+---------+-----------+-------+-----------------------+
Terminate NS
-+++++++++++++++
+++++++++++++
+--------------------+-------------------------------------+
|Interface Definition|Description |
@@ -1945,7 +1945,7 @@ Response:
+--------------+---------+-----------+-------+-----------------------+
Delete NS
-+++++++++++++++
++++++++++
+--------------------+-------------------------------------+
|Interface Definition|Description |
@@ -1964,9 +1964,9 @@ Request Parameters:
+----------------------------+---------+-----------+-------+-----------------------------+
MultiVIM API
-----------------
+------------
Get token
-++++++++++
++++++++++
https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
@@ -2051,7 +2051,7 @@ Response:
+-------------------------+------------------+--------------------------------------------------------------------------+
Create stack
-+++++++++++++
+++++++++++++
https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
@@ -2108,7 +2108,7 @@ Response:
+-------------------------+------------------+--------------------------------------------------------------------------+
Get stack
-+++++++++++++
++++++++++
https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
@@ -2187,7 +2187,7 @@ Response:
+-------------------------+------------------+------------------------------------------------------------------------------+
Delete stack
-+++++++++++++
+++++++++++++
https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
@@ -2346,7 +2346,7 @@ Request Body:
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
Create Keypair
-+++++++++++++++
+++++++++++++++
https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
@@ -2397,7 +2397,7 @@ Response:
+-----------------+------------------+------------------------------------------------------------------------------+
Delete Keypair
-+++++++++++++++
+++++++++++++++
https://developer.openstack.org/api-ref/compute/#delete-keypair
@@ -2422,7 +2422,7 @@ Request Body:
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
Create Network
-+++++++++++++++
+++++++++++++++
https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
@@ -2543,7 +2543,7 @@ Response:
+-----------------------------+------------------+------------------------------------------------------------------------------+
Delete Network
-+++++++++++++++
+++++++++++++++
https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
@@ -2566,7 +2566,7 @@ Request Body:
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
Create Subnet
-+++++++++++++++
++++++++++++++
https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
@@ -2675,7 +2675,7 @@ Response:
+-----------------------------+------------------+------------------------------------------------------------------------------+
Delete Subnet
-+++++++++++++++
++++++++++++++
https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
@@ -2698,7 +2698,7 @@ Request Body:
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
Create Port
-+++++++++++++++
++++++++++++
https://developer.openstack.org/api-ref/networking/v2/#create-port
@@ -2829,7 +2829,7 @@ Response:
+-----------------------------+------------------+------------------------------------------------------------------------------+
Delete Port
-+++++++++++++++
++++++++++++
https://developer.openstack.org/api-ref/network/v2/#delete-port
@@ -2852,7 +2852,7 @@ Request Body:
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
Create Security Group
-++++++++++++++++++++++
++++++++++++++++++++++
https://developer.openstack.org/api-ref/network/v2/#create-security-group
@@ -2909,7 +2909,7 @@ Response:
+-----------------------------+------------------+------------------------------------------------------------------------------+
Delete security group
-++++++++++++++++++++++
++++++++++++++++++++++
https://developer.openstack.org/api-ref/network/v2/#delete-security-group
@@ -3007,7 +3007,7 @@ Response:
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
Delete security group
-++++++++++++++++++++++
++++++++++++++++++++++
https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
@@ -3948,139 +3948,139 @@ Request Parameters:
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|transactionId |Y |1 |String |A unique ID to track an ONAP transaction. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|requestId |Y |1 |String |A unique ID to track multiple requests. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|callbackHeader |N |1 |String |The header information a client expecting in a async callback. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|sourceId |Y |1 |String |The unique ID of a client making an optimization call. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|requestType |Y |1 |String |The type of a request |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|numSolutions |N |1 |Integer|Expected number of solutions. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|optimizers |Y |1..N |List of Strings|A list of optimization services. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|timeout |N |1 |Integer|A tolerance window (in secs) for expecting solutions. Default is 600 secs.|
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content |Description |
++===================+=========+===========+===============+==========================================================================+
+|transactionId |Y |1 |String |A unique ID to track an ONAP transaction. |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|requestId |Y |1 |String |A unique ID to track multiple requests. |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|callbackHeader |N |1 |String |The header information a client expecting in a async callback. |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|sourceId |Y |1 |String |The unique ID of a client making an optimization call. |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|requestType |Y |1 |String |The type of a request |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|numSolutions |N |1 |Integer |Expected number of solutions. |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|optimizers |Y |1..N |List of Strings|A list of optimization services. |
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
+|timeout |N |1 |Integer |A tolerance window (in secs) for expecting solutions. Default is 600 secs.|
++-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
PlacementInfo Object
-+-------------------+---------+-----------+-------+-------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=============================================================+
-|requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.|
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service.|
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|subscriberInfo |N |1 |Object |The information of a service subscriber. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content |Description |
++===================+=========+===========+==============================+=======================================================================================================================================================================================================================================================================================================================================+
+|requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.|
++-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service. |
++-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|subscriberInfo |N |1 |Object |The information of a service subscriber. |
++-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
PlacementDemand Object
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|tenantId |N |1 |String |A tenant Id as defined in the ordering system. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions.|
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content |Description |
++===================+=========+===========+============================+=======================================================================+
+|resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
+|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
+|tenantId |N |1 |String |A tenant Id as defined in the ordering system. |
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
+|resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. |
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
+|existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. |
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
+|excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions. |
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
+|requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. |
++-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
SubscriberInfo Object
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|globalSubscriberId |Y |1 |String |An ID of a subscriber. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'.|
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content|Description |
++=======================+=========+===========+=======+===================================================================================+
+|globalSubscriberId |Y |1 |String |An ID of a subscriber. |
++-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
+|subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'. |
++-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
+|subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. |
++-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
ModelMetaData Object
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|modelVersionId |Y |1 |String |A unique model Id as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|modelName |N |1 |String |A model name as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|modelType |N |1 |String |A model type as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|modelVersion |N |1 |String |A model version as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|modelCustomizationName |N |1 |String |A model customization name as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content|Description |
++========================+=========+===========+=======+=======================================================================+
+|modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. |
++------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
+|modelVersionId |Y |1 |String |A unique model Id as defined in a service model. |
++------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
+|modelName |N |1 |String |A model name as defined in a service model. |
++------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
+|modelType |N |1 |String |A model type as defined in a service model. |
++------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
+|modelVersion |N |1 |String |A model version as defined in a service model. |
++------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
+|modelCustomizationName |N |1 |String |A model customization name as defined in a service model. |
++------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
Candidates Object
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|identifierType |Y |1 |String |The type of a candidate. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|identifiers |Y |1..N |List |A list of identifiers. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id.|
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content|Description |
++===================+=========+===========+=======+================================================================================+
+|identifierType |Y |1 |String |The type of a candidate. |
++-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
+|identifiers |Y |1..N |List |A list of identifiers. |
++-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
+|cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id. |
++-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
ServiceInfo Object
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|serviceInstanceId |Y |1 |String |A service instance id associated with a request. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|serviceName |Y |1 |String |The name of a service |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content |Description |
++===================+=========+===========+=====================+=======================================================================+
+|serviceInstanceId |Y |1 |String |A service instance id associated with a request. |
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
+|modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. |
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
+|serviceName |Y |1 |String |The name of a service |
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
LicenseInfo Object
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-------------------+---------+-----------+------------------------------+-----------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content |Description |
++===================+=========+===========+==============================+=======================================================================+
+|licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. |
++-------------------+---------+-----------+------------------------------+-----------------------------------------------------------------------+
LicenseDemand Object
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|Attribute |Required |Cardinality|Content|Description |
-+===================+=========+===========+=======+=======================================================================+
-|resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model.|
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
-|existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content |Description |
++===================+=========+===========+=====================+=======================================================================+
+|resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
+|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
+|resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model. |
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
+|existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. |
++-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
LicenseModel Object
@@ -4105,4 +4105,4 @@ Response Body
|statusMessage |N |1 |String |Reasoning if a requestStatus is failed. |
+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
|requestStatus |Y |1 |String |The status of a request. |
-+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ \ No newline at end of file
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+