ServiceOfferingInstance get relationship request

Description

This API traverses one or more relationships to retrieve the set of objects associated with the ServiceOfferingInstance 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 ServiceOfferingInstance class, see ServiceOfferingInstance class relationship APIs.

API stability classification

Committed

API overview

HTTP method	URI	Return type	Return type multiplicity
GET	csm/ServiceOfferingInstance/guid/relation+	ServiceOfferingInstance	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 ServiceOfferingInstance object.The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

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 ServiceOfferingInstance object.

Example

The following sample response shows the relationship between the Service Offering Instance (SOI) and the associated tenant.

Note

The response will vary depending on the target setup.

URL Syntax: /csm/Organization/<guid_Oranization>
[
  {
   "cloudClass": "com.bmc.cloud.model.beans.Organization",
   "guid": "AGHAA5V0HCN29ANNZ1VAE8UE6R4BJS",
   "isOnboarded": true,
   "logicalHostingEnvironment": [
     "/logicalhostingenvironment/0adcda6c-a10c-4ec5-8e49-4a69ff0331a8"
    ],
   "modifiedDate": 1431004327000,
   "name": "VCD",
   "owner": "AltoCloudAdmin",
   "reconciliationID": "REHAA5V0HCN29ANNZ1VBE8UF3P4BJV",
   "resourceSet": [
     "/resourceset/470eba02-f0a2-4e16-a0e0-ffe39fe2d033"
    ],
   "serviceOfferingInstance": [
     "/serviceofferinginstance/5f404b74-e177-470c-ad1d-98431a1ac05d"
    ],
   "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-4247dfe129d94a4482498e1e0b1904ad",
     "/contract/OI-9d86b760f7e646a6b2dd54a6e4241c8b"
    ],
   "tokenID": "0"
  }
]