getScopesByParentId

Using the ID of the parent scope, returns a list of all the child scopes.

Applies to Clouds only.

Parameter:

parentScopeId
The ID for the parent scope.
Returns:
A list of child scopes.

Examples:

The following example is a SOAP request to get scopes by using the ID of the parent scope.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/
schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>B0097A43C5527FA552C3DDBA7EF74CE9</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:getScopesByParentId>
   <sec:parentScopeId>BB173AE61484BD7359D8910789EA4E88</
   sec:parentScopeId>
  </sec:getScopesByParentId>
 </soapenv:Body>
</soapenv:Envelope>
The following example is the SOAP response to the request. The parent scope is a tenant and the child scopes are the environments in the tenant.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getScopesByParentIdResponse xmlns:ns2="http://www.approuter.com/
  schemas/2008/1/security"
  xmlns:ns3="http://www.approuter.com/schema/
  router/1000/security/03">
	 <ns2:scopes>
    <active>true</active>
    <displayName>Staging</displayName>
    <id>9203C78275503796DB49CB5E6CF34111</id>
    <index>1</index>
    <name>Staging</name>
    <parentId>BB173AE61484BD7359D8910789EA4E88</parentId>
    <type>ENV</type>
   </ns2:scopes>
   <ns2:scopes>
    <active>true</active>
    <displayName>Development</displayName>
    <id>A26D2319BAE05E9513117949CF274A09</id>
    <index>0</index>
    <name>Development</name>
    <parentId>BB173AE61484BD7359D8910789EA4E88</parentId>
    <type>ENV</type>
   </ns2:scopes>
   <ns2:scopes>
    <active>true</active>
    <displayName>Production</displayName>
    <id>B56005332F3E41A3F1456F5F40594A06</id>
    <index>2</index>
    <name>Production</name>
    <parentId>BB173AE61484BD7359D8910789EA4E88</parentId>
    <type>ENV</type>
   </ns2:scopes>
  </ns2:getScopesByParentIdResponse>
 </S:Body>
</S:Envelope>
For each child scope, the following information is returned:
active
True or false. True means that the scope is active.
displayName
The name displayed in the WMC for the role.
id
The ID for the child scope.
index
The position in the index of the child scope.
name
The name of the child scope.
parentId
The ID of the parent scope.
type
The type of scope.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.api.doc/ci00031.html