Generate Product Report

Generate Product Report

Generate interop report for product with defined envId and productId.

Request
URI
POST
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/interop/report/product/{envId}/{productId}
COPY
Path Parameters
string
envId
Required

ID of the environment

string
productId
Required

ID of the product

Query Parameters
string
targetVersion
Optional

Target version for generating the interop report.


Responses
200

Interop report was created.

Returns ProductInteropReport of type(s) */*
{
    "environmentName": "string",
    "environmentId": "string",
    "reportDate": "string",
    "lastDiscoveryDate": "string",
    "targetVersion": "string",
    "product": {
        "productType": "string",
        "environmentId": "string",
        "productId": "string",
        "endpointAddress": "string",
        "currentVersionInfo": {
            "version": "string",
            "buildNumber": "string",
            "availableNewerVersions": [
                "string"
            ]
        },
        "status": {
            "overallStatus": "string",
            "interopStatus": "string",
            "passwordStatus": "string",
            "certificateStatus": "string"
        },
        "certificates": {
            "certificates": {
                "validFrom": "string",
                "validTo": "string",
                "thumbprint": "string",
                "status": {
                    "status": "string",
                    "expirationDays": 0
                }
            }
        },
        "nodes": [
            {
                "nodeId": 0,
                "hostName": "string",
                "rootPasswordExpiration": "string",
                "status": {
                    "status": "string",
                    "expirationDays": 0
                }
            }
        ],
        "targetVersionInfo": {
            "version": "string",
            "buildNumber": "string",
            "availableNewerVersions": [
                "string"
            ]
        },
        "relations": [
            {
                "type": "string",
                "endpointAddress": "string",
                "versionInfo": {
                    "version": "string",
                    "buildNumber": "string",
                    "availableNewerVersions": [
                        "string"
                    ]
                },
                "status": {
                    "overallStatus": "string",
                    "interopStatus": "string",
                    "passwordStatus": "string",
                    "certificateStatus": "string"
                },
                "certificate": {
                    "certificate": {
                        "validFrom": "string",
                        "validTo": "string",
                        "thumbprint": "string",
                        "status": {
                            "status": "string",
                            "expirationDays": 0
                        }
                    }
                },
                "relationship": "string"
            }
        ]
    }
}
string
environmentName
Required

Name of an environment that the product is part of.

string As [a-zA-Z0-9_\-.]{3,}
environmentId
Optional

ID of an environment that the product is part of.

string As date-time As date-time
reportDate
Optional

The creation date of this report.

string As date-time As date-time
lastDiscoveryDate
Optional

The date that the product state was last updated by discovery.

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

The specified product version for the report.

product
Optional

The specified product for the report.


401

Unauthorized access.

Returns ProductInteropReport of type(s) */*
{
    "environmentName": "string",
    "environmentId": "string",
    "reportDate": "string",
    "lastDiscoveryDate": "string",
    "targetVersion": "string",
    "product": {
        "productType": "string",
        "environmentId": "string",
        "productId": "string",
        "endpointAddress": "string",
        "currentVersionInfo": {
            "version": "string",
            "buildNumber": "string",
            "availableNewerVersions": [
                "string"
            ]
        },
        "status": {
            "overallStatus": "string",
            "interopStatus": "string",
            "passwordStatus": "string",
            "certificateStatus": "string"
        },
        "certificates": {
            "certificates": {
                "validFrom": "string",
                "validTo": "string",
                "thumbprint": "string",
                "status": {
                    "status": "string",
                    "expirationDays": 0
                }
            }
        },
        "nodes": [
            {
                "nodeId": 0,
                "hostName": "string",
                "rootPasswordExpiration": "string",
                "status": {
                    "status": "string",
                    "expirationDays": 0
                }
            }
        ],
        "targetVersionInfo": {
            "version": "string",
            "buildNumber": "string",
            "availableNewerVersions": [
                "string"
            ]
        },
        "relations": [
            {
                "type": "string",
                "endpointAddress": "string",
                "versionInfo": {
                    "version": "string",
                    "buildNumber": "string",
                    "availableNewerVersions": [
                        "string"
                    ]
                },
                "status": {
                    "overallStatus": "string",
                    "interopStatus": "string",
                    "passwordStatus": "string",
                    "certificateStatus": "string"
                },
                "certificate": {
                    "certificate": {
                        "validFrom": "string",
                        "validTo": "string",
                        "thumbprint": "string",
                        "status": {
                            "status": "string",
                            "expirationDays": 0
                        }
                    }
                },
                "relationship": "string"
            }
        ]
    }
}
string
environmentName
Required

Name of an environment that the product is part of.

string As [a-zA-Z0-9_\-.]{3,}
environmentId
Optional

ID of an environment that the product is part of.

string As date-time As date-time
reportDate
Optional

The creation date of this report.

string As date-time As date-time
lastDiscoveryDate
Optional

The date that the product state was last updated by discovery.

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

The specified product version for the report.

product
Optional

The specified product for the report.


404

Environment ID or/and product ID doesn't exist.

Returns ProductInteropReport of type(s) */*
{
    "environmentName": "string",
    "environmentId": "string",
    "reportDate": "string",
    "lastDiscoveryDate": "string",
    "targetVersion": "string",
    "product": {
        "productType": "string",
        "environmentId": "string",
        "productId": "string",
        "endpointAddress": "string",
        "currentVersionInfo": {
            "version": "string",
            "buildNumber": "string",
            "availableNewerVersions": [
                "string"
            ]
        },
        "status": {
            "overallStatus": "string",
            "interopStatus": "string",
            "passwordStatus": "string",
            "certificateStatus": "string"
        },
        "certificates": {
            "certificates": {
                "validFrom": "string",
                "validTo": "string",
                "thumbprint": "string",
                "status": {
                    "status": "string",
                    "expirationDays": 0
                }
            }
        },
        "nodes": [
            {
                "nodeId": 0,
                "hostName": "string",
                "rootPasswordExpiration": "string",
                "status": {
                    "status": "string",
                    "expirationDays": 0
                }
            }
        ],
        "targetVersionInfo": {
            "version": "string",
            "buildNumber": "string",
            "availableNewerVersions": [
                "string"
            ]
        },
        "relations": [
            {
                "type": "string",
                "endpointAddress": "string",
                "versionInfo": {
                    "version": "string",
                    "buildNumber": "string",
                    "availableNewerVersions": [
                        "string"
                    ]
                },
                "status": {
                    "overallStatus": "string",
                    "interopStatus": "string",
                    "passwordStatus": "string",
                    "certificateStatus": "string"
                },
                "certificate": {
                    "certificate": {
                        "validFrom": "string",
                        "validTo": "string",
                        "thumbprint": "string",
                        "status": {
                            "status": "string",
                            "expirationDays": 0
                        }
                    }
                },
                "relationship": "string"
            }
        ]
    }
}
string
environmentName
Required

Name of an environment that the product is part of.

string As [a-zA-Z0-9_\-.]{3,}
environmentId
Optional

ID of an environment that the product is part of.

string As date-time As date-time
reportDate
Optional

The creation date of this report.

string As date-time As date-time
lastDiscoveryDate
Optional

The date that the product state was last updated by discovery.

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

The specified product version for the report.

product
Optional

The specified product for the report.