LogicalHostingEnvironment get relationship request

Description

This API traverses one or more relationships to retrieve the set of objects associated with the LogicalHostingEnvironment object specified by the guid in the URI. To learn more about retrieving object relationships, see Relationship traversal. For a list of relationship APIs available in the LogicalHostingEnvironment class, see LogicalHostingEnvironment class relationship APIs.

API stability classification

Unstable

API overview

HTTP method	URI	Return type	Return type multiplicity
`GET`	`csm/LogicalHostingEnvironment/guid/relation+`	`LogicalHostingEnvironment`	0..1

HTTP request message

Query string parameters

Use the fillFields and ignoreFields query string parameters to specify which attributes and relationships to return in the response. Use only one of these parameters in the request; they are mutually exclusive. If you do not send a parameter with the request, the response includes all attributes and relationships of the LogicalHostingEnvironment object.

Name	Type	Multi- plicity	Description
`fillFields`	`String`	0..1	List of attributes and relationships to include in the response
`ignoreFields`	`String`	0..1	List of attributes and relationships to omit from the response

Request message headers

This API uses only common request headers listed in HTTP request and response headers.

Request message body

This API does not use a request message body.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a LogicalHostingEnvironment object.

Example

The following sample response shows the relationship between the Logical Hosting Environment (LHE) and the associated tenant.

Note

The response will vary depending on the target setup.

URL Syntax: /csm/LogicalHostingEnvironment/<guid_Lhe>/organization
[
    {
        "cloudClass": "com.bmc.cloud.model.beans.SearchResults",
        "guid": "5ad07d83-0d70-44ce-9430-2c52624f0dfc",
        "pageNo": 0,
        "pageSize": -1,
        "results": [
            {
                "cloudClass": "com.bmc.cloud.model.beans.Organization",
                "description": "Automation test company for India site.",
                "guid": "AGHAA5V0HC3F9ANMY666AAKQFXA1RZ",
                "isOnboarded": true,
                "logicalHostingEnvironment": [
                    "/logicalhostingenvironment/f2f3ada5-d5f5-4fbc-805c-6af32802d0b8"
                ],
                "modifiedDate": 1429283632000,
                "name": "AltoStratus LLC",
                "owner": "AltoCloudAdmin",
                "reconciliationID": "REHAA5V0HC3F9ANMY667AAKQGZA1SA",
                "tags": [
                    {
                        "cloudClass": "com.bmc.cloud.model.beans.Tag",
                        "guid": "AG842B2B0805822z30TAj4SMAA-zwB",
                        "label": "Tenant",
                        "modifiedDate": 1429279747000,
                        "name": "Tenant",
                        "tagGroup": {
                            "cloudClass": "com.bmc.cloud.model.beans.TagGroup",
                            "guid": "AG842B2B080582RDH0TA7FRbAAQJQA",
                            "modifiedDate": 1429279746000,
                            "name": "CSM",
                            "ownedTags": [
                                "/tag/Provider",
                                "/tag/Tenant"
                            ],
                            "tagScope": "System_Internal"
                        },
                        "tagGroupObject": {
                            "cloudClass": "com.bmc.cloud.model.beans.TagGroup",
                            "description": "@circular-reference-placeholder@",
                            "guid": "AG842B2B080582RDH0TA7FRbAAQJQA",
                            "tagScope": "User_Defined"
                        }
                    },
                    {
                        "cloudClass": "com.bmc.cloud.model.beans.Tag",
                        "description": "@circular-reference-placeholder@",
                        "guid": "AG842B2B0805822z30TAj4SMAA-zwB"
                    }
                ],
                "tenantContracts": [
                    "/contract/OI-e7494edfd07d47b58796bdb11edc29a1"
                ],
                "tokenID": "0"
            }
        ],
        "totalRows": 1
    }
]