This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

To view the latest version, select the version from the Product version menu.

GetInstances function

Retrieves a list of instances. You can limit the retrieved instance result set by specifying a qualification.

WSDL operation

<operation name="GetInstances" parameterOrder="inargs">
	<input message="tns:GetInstancesRequest"
		name="GetInstancesRequest"/>
	<output message="tns:GetInstancesResponse"
		name="GetInstancesResponse"/>
	<fault message="tns:AtriumFault" name="AtriumFault"/>
</operation>

WSDL messages

<message name="GetInstancesRequest">
		<part element="types:GetInstances" name="inargs"/>
</message>
<message name="GetInstancesResponse">
		<part element="types:GetInstancesOutput" name="outargs"/>
</message>
<message name="AtriumFault">
	<part element="common:AtriumFault" name="errargs"/>
</message>

XSD schema

<element name="GetInstances">
	<complexType>
		<sequence>
			<element name="lang" type="string"/>
			<element name="classNameId" type="common:ClassNameId"/>
			<element name="query" type="string"/>
			<element name="attributes" type="common:ArrayOf_String"/>
			<element name="firstRetrieve" type="int"/>
			<element name="maxRetrieve" type="int"/>
			<element name="sortOrder" type="common:SortOrderList"/>
			<element name="datasetId" type="string"/>
			<element name="aGetMask" type="common:GetMask"/>
			<element name="extensions" type="common:ExtensionsList" 
				nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="GetInstancesOutput">
	<complexType>
		<sequence>
			<element name="instanceInfo"
				type="common:InstanceInfoOutList"/>
			<element name="status" type="common:StatusList"/>
			<element name="extensions" type="common:ExtensionsList" 
				nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="AtriumFault">
	<complexType>
		<choice>
			<element name="serviceFault"
				type="tns:AtriumServiceFault" />
			<element name="backendFault"
				type="tns:AtriumBackendFault" />
		</choice>
	</complexType>
</element>

Input arguments


lang

The language of the product specific to the locale. If no language is specified, the default language is used.

classNameId

The class from which the instances are to be retrieved. It is a two-part structure that contains the namespace name and the class name. See ClassNameId.

query

A qualification that determines the set of instances to retrieve. The qualification can include one or more attributes and any combination of conditional, relational, and arithmetic operations.

attributes

A list of attribute names to retrieve.

firstRetrieve

The first instance to retrieve. The value represents the first entry and is the default value if the value is not set.

maxRetrieve

The maximum number of entries to retrieve. Use this parameter to limit the amount of data returned if the query does not narrow the list.

sortOrder

The sort order for the retrieved data. See SortOrderList.

datasetId

The unique identifier for the dataset. The data in the return values are based on the dataset ID specified in this parameter.

aGetMask

The identifier for specifying the dataset type.GET_MASK_NONE: Based on the datasetId being passed, instances retrieves instancesfrom either the overlay or the original dataset.DATASET_MODE_CURRENT: Retrieves instances from the current dataset only.

extensions

A list of extension types for the operation.


Return values


instanceInfo

A list of instances. See InstanceInfoOutList.

status

A list of zero or more notes, warnings, or errors generated from a call of this operation.

extensions

A list of extension types for the operation.

 


Fault message

 

Fault message

See Fault message.

Example

Allen Allbrook, the configuration manager with Calbro Services wants to view all the computers in the production dataset having names starting with 'clm'. Allen needs to query the BMC_ComputerSystem class where the datasetId is BMC.ASSET, and  the name attribute is LIKE clm%.

Request
<?xml version='1.0'
   encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header>
      <wsse:Security
         xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>IN-AllenA-W1_5f62ea4e151a4f559a8fa77fa58331c3</wsse:Username>
            <wsse:Password
               Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">IN-AllenA-W1_5f62ea4e151a4f5</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <GetInstances
         xmlns="http://atrium.bmc.com/2009/01/instances/types">
         <loginInfo xmlns=""/>
         <classNameId xmlns="">
            <namespaceName>BMC.CORE</namespaceName>
            <className>BMC_ComputerSystem</className>
         </classNameId>
         <query xmlns="">'Name' LIKE "clm%"</query>
         <attributes xmlns=""/>
         <firstRetrieve xmlns="">0</firstRetrieve>
         <maxRetrieve xmlns="">0</maxRetrieve>
         <sortOrder xmlns=""/>
         <datasetId>BMC.ASSET</datasetId>
         <getMask xmlns="">DATASET_MODE_CURRENT</getMask>
         <extensions xmlns=""/>
      </GetInstances>
   </soapenv:Body>
</soapenv:Envelope>



The response is shown as follows:

Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header/>
   <soapenv:Body>
      <typ:GetInstancesOutput xmlns:typ="http://atrium.bmc.com/2009/01/instances/types">
         <instanceInfo>
            <list>
               <classNameId>
                  <namespaceName>BMC.CORE</namespaceName>
                  <className>BMC_ComputerSystem</className>
               </classNameId>
               <instanceId>clm250</instanceId>
               <instanceAttributes>
                  <list>
                     <name>NormalizationStatus</name>
                     <value>
                        <enumValue>20</enumValue>
                     </value>
                  </list>
                  <list>
                     <name>SystemClassId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>History</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ReferenceInstance</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ShortDescription</name>
                     <value>
                        <stringValue>n/a</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>Item</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ReconciliationMergeStatus</name>
                     <value>
                        <enumValue>40</enumValue>
                     </value>
                  </list>
                  <list>
                     <name>LastUpdatedDatasetId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ComponentAliases</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>DeleteInstanceTrigger</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Status</name>
                     <value>
                        <enumValue>0</enumValue>
                     </value>
                  </list>
                  <list>
                     <name>ManufacturerName</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>RequestId</name>
                     <value>
                        <stringValue>000000000041638</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>InstanceId</name>
                     <value>
                        <stringValue>clm250</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>patternAlphaNumChar</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ProductType</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>TenantCompany</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>InstanceName</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>NEFeatureStatusMask</name>
                     <value>
                        <intValue>0</intValue>
                     </value>
                  </list>
                  <list>
                     <name>attrDiaryGuide290</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>TokenFormat</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>CheckSumValue</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ServicePack</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ImpactComputationModel</name>
                     <value>
                        <stringValue>STANDARD</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>PatchNumber</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>zTmp_DSO_RequestId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>MFIntegrationID</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>LastModifiedBy</name>
                     <value>
                        <stringValue>IN-AllenA-W1_b7647fee09ea44a3af4363ad98212089</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>Description</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>attrDiaryGuide333</name>
                     <value>
                        <diaryValue>
                           <diaryValueOut>
                              <list>
                                 <user>IN-AllenA-W1_b7647fee09ea44a3af4363ad98212089</user>
                                 <text>amd64</text>
                                 <timestamp>2020-02-20T06:41:58.000-08:00</timestamp>
                              </list>
                           </diaryValueOut>
                        </diaryValue>
                     </value>
                  </list>
                  <list>
                     <name>attrDiaryVersion687</name>
                     <value>
                        <diaryValue>
                           <diaryValueOut>
                              <list>
                                 <user>IN-AllenA-W1_b7647fee09ea44a3af4363ad98212089</user>
                                 <text>9.1.10 202002152304</text>
                                 <timestamp>2020-02-20T06:41:58.000-08:00</timestamp>
                              </list>
                           </diaryValueOut>
                        </diaryValue>
                     </value>
                  </list>
                  <list>
                     <name>NameFormat</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>LicensingType</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ModifiedDate</name>
                     <value>
                        <timeValue>2020-02-20T06:41:58.000-08:00</timeValue>
                     </value>
                  </list>
                  <list>
                     <name>zTmp_DSO_FormName</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>DatasetId</name>
                     <value>
                        <stringValue>BMC.ASSET</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>FailedAutomaticIdentification</name>
                     <value>
                        <enumValue>0</enumValue>
                     </value>
                  </list>
                  <list>
                     <name>attrDiaryGuide55</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ReconciliationIdType</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>CMDBWriteSecurity</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>BuildType</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>SystemName</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>AccountID</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>testAttributeSetClass_OL</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ConfigurationBasicNumber</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>VersionNumber</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Type</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>BuildNumber</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>CMDBRowLevelSecurity</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>LastREJobrunId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>DSOUniqueId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>MarkAsDeleted</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Model</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>patternLowerAttribute</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Company</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>LastScanDate</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ParentCITag</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>CITag</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ClassId</name>
                     <value>
                        <stringValue>BMC_ComputerSystem</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>CreateDate</name>
                     <value>
                        <timeValue>2020-02-20T06:41:58.000-08:00</timeValue>
                     </value>
                  </list>
                  <list>
                     <name>Name</name>
                     <value>
                        <stringValue>clm250</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>ADDMIntegrationId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Availability</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>OpIdWeakReference</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>patternDigitAttribute</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>MarketVersion</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>isCloud</name>
                     <value>
                        <enumValue>0</enumValue>
                     </value>
                  </list>
                  <list>
                     <name>DictionaryId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Priority</name>
                     <value>
                        <enumValue>0</enumValue>
                     </value>
                  </list>
                  <list>
                     <name>CompareActionCode</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ReconciliationIdentificationError</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>RelLeadInstanceId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ReconciliationIdentity</name>
                     <value>
                        <stringValue>0</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>SerialNumber</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>InstallLocation</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>CMDBRowLevelSecurity_Parent</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>isVirtual_old</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>CMDBWriteSecurity_Parent</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>UnstructuredData</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>isVirtual</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>zTmp_DSO_InstanceId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>zCMDBEngTimestampStub</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>OwnerName</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Category</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ContractID</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Supported</name>
                     <value>
                        <enumValue>0</enumValue>
                     </value>
                  </list>
                  <list>
                     <name>LicenseType</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>ReconciliationIdChanged</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Submitter</name>
                     <value>
                        <stringValue>IN-Username-W1_b7647fee09ea44a3af4363ad98212089</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>patternAlphaNumAttribute</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>LicensesAvailable</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>TokenId</name>
                     <value>
                        <stringValue>0</stringValue>
                     </value>
                  </list>
                  <list>
                     <name>Notes</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>AttributeDataSourceList</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>OwnerContact</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>AssignedTo</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>SystemEnvironment</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Confidentiality</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>RelLeadClassId</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>zCMDBEngOverrideCmd</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
                  <list>
                     <name>Integrity</name>
                     <value>
                        <nullValue/>
                     </value>
                  </list>
               </instanceAttributes>
            </list>
         </instanceInfo>
         <status/>
         <extensions xsi:nil="true"/>
      </typ:GetInstancesOutput>
   </soapenv:Body>
</soapenv:Envelope>




Was this page helpful? Yes No Submitting... Thank you

Comments