SO Interfaces
================================
-.. image:: ../images/SO_1.png
+.. image:: ../../images/SO_1.png
SO APIs
----------------
|percentProgress |String |percentage of progress |
+-------------------------+------------------+-------------------------------------------------+
- SDC API
- --------
+ SDC Client API
+ ------------------
Get List of Existing Catalog Assets
+++++++++++++++++++++++++++++++++++
|Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . |
+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
- Upload Artifact
- +++++++++++++++
-
- +--------------------+-----------------------------------------------------------------------------------------------+
- |Interface Definition|Description |
- +====================+===============================================================================================+
- |URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
- +--------------------+-----------------------------------------------------------------------------------------------+
- |Operation Type |POST |
- +--------------------+-----------------------------------------------------------------------------------------------+
-
- Request Parameters:
-
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Cardinality|Content|Description |
- +==============================+=========+===========+=======+=====================================================================================+
- |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
- Request Body
- ++++++++++++
-
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Cardinality|Content|Description |
- +==============================+=========+===========+=======+=====================================================================================+
- |payloadData |M |1 |String |The data of the artifact after Base64 encoding |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactName |M |1 |String |The name of the artifact |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactType |M |1 |String |The type of the artifact |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |description |M |1 |String |Description of the artifact |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
- Request Headers:
-
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Header Name |Qualifier|Description |
- +===================+=========+=========================================================================================+
- |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |X-ECOMP-InstanceID |Y |Instance ID |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Authorization |Y |Base64 encoded username:password |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Content-Type |Y |Valid value is : application/json |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
-
- Response:
-
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Content|Description |
- +====================+=========+=======+===================================================================================================+
- |artifactName |M |String |Artifact File name |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactType |M |String |Artifact Type |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactURL |M |String |Relative artifact’s URL. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactDescription |M |String |Artifact Description. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactTimeout |N |String |Will be populated only if its value is not 0. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactVersion |Y |String |Service Version . |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
- Update Artifact
- +++++++++++++++
-
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Interface Definition|Description |
- +====================+==============================================================================================================+
- |URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Operation Type |POST |
- +--------------------+--------------------------------------------------------------------------------------------------------------+
-
- Request Parameters:
-
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Cardinality|Content|Description |
- +==============================+=========+===========+=======+=====================================================================================+
- |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
- Request Headers:
-
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Header Name |Qualifier|Description |
- +===================+=========+=========================================================================================+
- |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |X-ECOMP-InstanceID |Y |Instance ID |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Authorization |Y |Base64 encoded username:password |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Content-Type |Y |Valid value is : application/json |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
-
- Request Body:
-
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Cardinality|Content|Description |
- +==============================+=========+===========+=======+=====================================================================================+
- |payloadData |M |1 |String |The data of the artifact after Base64 encoding |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactName |M |1 |String |The name of the artifact |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactType |M |1 |String |The type of the artifact |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |description |M |1 |String |Description of the artifact |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
- Response:
-
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Content|Description |
- +====================+=========+=======+===================================================================================================+
- |artifactName |M |String |Artifact File name |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactType |M |String |Artifact Type |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactURL |M |String |Relative artifact’s URL. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactDescription |M |String |Artifact Description. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactTimeout |N |String |Will be populated only if its value is not 0. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |artifactVersion |Y |String |Service Version . |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
- Delete Artifact
- +++++++++++++++
-
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Interface Definition|Description |
- +====================+==============================================================================================================+
- |URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Operation Type |DELETE |
- +--------------------+--------------------------------------------------------------------------------------------------------------+
-
- Request Parameters:
-
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Cardinality|Content|Description |
- +==============================+=========+===========+=======+=====================================================================================+
- |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
- |resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
- +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
- Request Headers:
-
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Header Name |Qualifier|Description |
- +===================+=========+=========================================================================================+
- |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |X-ECOMP-InstanceID |Y |Instance ID |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Authorization |Y |Base64 encoded username:password |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
-
- Response:
-
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Content|Description |
- +====================+=========+=======+===================================================================================================+
- |artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
- Update Lifecycle
- ++++++++++++++++
-
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Interface Definition|Description |
- +====================+==============================================================================================================+
- |URI |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation} |
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Operation Type |POST |
- +--------------------+--------------------------------------------------------------------------------------------------------------+
-
- Request Parameters:
-
- +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Cardinality|Content|Description |
- +==============================+=========+===========+=======+=====================================================================================================+
- |assetType |M |1 |String |The requested asset type.valid values are resources/services. |
- +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
- |Uuid |M |1 |String |The uuid of the asset as published in the metadata |
- +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
- |lifecycleOperation |M |1 |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout / Certify |
- +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
-
- Request Headers:
-
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Header Name |Qualifier|Description |
- +===================+=========+=========================================================================================+
- |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |X-ECOMP-InstanceID |Y |Instance ID |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Authorization |Y |Base64 encoded username:password |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
-
- Request Parameters:
-
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Description |
- +===================+=========+=========================================================================================+
- |userRemarks |N |Short description (free text) about the asset version being changed |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
-
- Response:
-
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Content|Description |
- +====================+=========+=======+===================================================================================================+
- |uuid |Y |String |UUID generated by SDC per each major version of the asset |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |name |Y |String |The name of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |version |Y |String |The asset version in SDC catalog |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |category |Y |String |Category of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |subcategory |Y |String |Sub-category of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |resourceType |Y |String |The type of resource. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |lifecycleState |Y |String |The lifecycle state of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
- Create Resource
- +++++++++++++++
-
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Interface Definition|Description |
- +====================+==============================================================================================================+
- |URI |/sdc/v1/catalog/resources |
- +--------------------+--------------------------------------------------------------------------------------------------------------+
- |Operation Type |POST |
- +--------------------+--------------------------------------------------------------------------------------------------------------+
-
- Request Headers:
-
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Header Name |Qualifier|Description |
- +===================+=========+=========================================================================================+
- |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |X-ECOMP-InstanceID |Y |Instance ID |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Authorization |Y |Base64 encoded username:password |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Content-Type |Y |Valid value is : application/json |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
-
- Request Parameters:
-
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Description |
- +===================+=========+=========================================================================================+
- |name |Y |The name of the resource |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |description |Y |Short description of the resource |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |resourceType |Y |“VFCMT” / “VF” / “PNF” |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |category |Y |VFCMT category is “Template”. |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |subcategory |Y |VFCMT subcategory is “Monitoring Template”. |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |vendorName |Y |Vendor Name |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |vendorRelease |Y |Vendor Release |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |tags |Y |The tags are used for search options. |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |icon |Y |The icon should be pre-defined in SDC. |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
- |contactId |Y |The user ID of user responsible for this VFCMT. |
- +-------------------+---------+-----------------------------------------------------------------------------------------+
-
- Response:
-
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |Attribute |Qualifier|Content|Description |
- +====================+=========+=======+===================================================================================================+
- |uuid |Y |String |UUID generated by SDC per each major version of the asset |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |name |Y |String |The name of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |version |Y |String |The asset version in SDC catalog |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |category |Y |String |Category of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |subcategory |Y |String |Sub-category of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |resourceType |Y |String |The type of resource. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |lifecycleState |Y |String |The lifecycle state of the asset. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
- |lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
- +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
- UUI API
+ E2E Service API
----------------
+
Create E2E service instance
++++++++++++++++++++++++++++
Code Review / so.git / commitdiff