Add Integration

Add Integration

Integrate the product with another product or datacenter component.

Request
URI
POST
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/environment/{environmentId}/product/{productId}/integration
COPY
Path Parameters
string
environmentId
Required

ID of the environment

string
productId
Required

ID of the product within the environment

Query Parameters
string
action
Optional

The action to take - VALIDATE or INTEGRATE

Possible values are : INTEGRATE, VALIDATE,
Request Body
BaseDeploymentIntegrationSpec of type(s) application/json
Required 
{
    "properties": {
        "properties": {}
    },
    "integrationId": "string",
    "integrationUsername": "string",
    "integrationPassword": "string",
    "status": "string",
    "ref": "string",
    "version": "string",
    "hostname": "string",
    "port": 0
}
object
properties
Optional

Additional properties

string As ^[^;'"]{1,80}$
integrationId
Optional

ID of an integration.

string As ^[^;'"]{1,80}$
integrationUsername
Optional

Username for an integration.

string As (^[^'"]{2,32}$)|(^ref:password:[a-zA-Z0-9]{20}$)
integrationPassword
Optional

Password for an integration.

string
status
Optional

Whether the declared integration matches what is actually in the environment.

Possible values are : OK, MISSING, MISSING_INFORMATION, UNKNOWN,
string As ([A-Za-z0-9\-\_\.\:\@]+)
ref
Optional

Reference to the registered entity.

string As ^[0-9]+(\.[0-9]+){0,3}([._\-a-zA-Z0-9]+)?$
version
Optional

Version of the product or component of the integration.

string As ^([a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-zA-Z0-9])?\.)*[a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-z_A-Z0-9])?$
hostname
Optional

Hostname or IP address of the integration

integer As int32 As int32
port
Optional

Port to connect to the integration's endpoint.

Responses
200

Task ID for the task configure the product integration.

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


401

Unauthorized access

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


On This Page
Product Operations
POST
Add Integration
POST
Add Product Node
PUT
Configure Certificate
DELETE
Delete Product
DELETE
Delete Product Node
POST
Discover Product
GET
Get All Product Nodes
GET
Get Certificate 1
GET
Get Product Node Spec By Id
PUT
Redeploy Product Node
DELETE
Remove Integration
PATCH
Update All Product Nodes
PUT
Update Integration
PATCH
Update Product Node
PUT
Upgrade Product