Find Instance process for v7.5

The Find Instance process retrieves CI and relationship instances from BMC Atrium CMDB.

The following table describes the process input elements for the Find Instance process.

Process Inputs - Find Instance process

Process input

Description

Required?

<adapter name>

Specifies the name of the adapter to use to handle the request
Default value: BMCAtriumCMDBActorAdapter

No

<items>

Specifies an XML document containing the information to retrieve records from BMC Atrium CMDB for a specified query

Yes

The following figure shows a sample <items> XML for the Find Instance with selected attributes process.

<items> XML for the Find Instance with selected attributes process

 <items>
  <item>
    <parameters>
      <username>Demo</username>
      <password> </password>
      <login-info>
        <locale />
        <time-zone />
        <authentication />
      </login-info>
      <class-name-id>
       <namespace-name>BMC.CORE</namespace-name>
        <class-name>BMC_Account</class-name>
      </class-name-id>
      <query><![CDATA[AccountID == NULL ]]></query>
      <attributes>
        <list>SerialNumber</list>
        <list>AttributeDataSourceList</list>
        <list>ClassId</list>
        <list>ShortDescription</list>
        <list>Notes</list>
        <list>OwnerName</list>
        <list>Name</list>
        <list>AssignedTo</list>
     </attributes>
      <first-retrieve>0</first-retrieve>
      <max-retrieve>10</max-retrieve>
<sort-order>
        <list>
          <attribute-name>SerialNumber</attribute-name>
          <sort-order>ASCENDING</sort-order>
        </list>
      </sort-order>
      <dataset-id />
      <get-mask>GET_MASK_NONE</get-mask>
       </parameters>
  </item>
</items>


The following figure illustrates the adapter response for the Find Instance process.

Adapter response for the Find Instance process

 <bmc-atrium-cmdb-response>
  <item>
    <metadata>
      <status>success</status>
      <item-count>2</item-count>
    </metadata>
      <parameters>
           <instance-info>
        <value>
          <element>
            <class-name-id>
              <namespace-name>BMC.CORE</namespace-name>
              <class-name>BMC_Account</class-name>
            </class-name-id>

           <instance-id>OI-EECF255CC4664E498A2A41B7A106CA02</instance-id>
            <instance-attributes>
              <element>
                <name>SerialNumber</name>
                <value>
                  <string-value>999</string-value>
                </value>
              </element>
              <element>
                <name>ClassId</name>
                <value>
                  <string-value>BMC_ACCOUNT</string-value>
                </value>
              </element>
              <element>
                <name>AssignedTo</name>
                <value />
              </element>
              <element>
                <name>ShortDescription</name>
                <value>
                  <string-value>This is the 18th CI.</string-value>
                </value>
              </element>
              <element>
                <name>AttributeDataSourceList</name>
                <value>
                  <string-value>attrdataSourceList</string-value>
                </value>
              </element>
              <element>
                <name>Notes</name>
                <value>
                  <diary-value>
                    <diary-value-out>
                      <element>
                        <user>Demo</user>
                        <text>These are the notes for 18th CI.</text>
                        <timestamp>1247665227000</timestamp>
                      </element>
                    </diary-value-out>
                  </diary-value>
                </value>
              </element>
              <element>
                <name>OwnerName</name>
                <value />
              </element>
              <element>
                 <name>Name</name>
                <value>
                  <string-value>TestClassInstance</string-value>
                </value>
              </element>
            </instance-attributes>
          </element>
          <element>
            <class-name-id>
              <namespace-name>BMC.CORE</namespace-name>
              <class-name>BMC_Account</class-name>
            </class-name-id>
            <instance-id>OI-D1D36E01259748B3A8D9A02914C22049</instance-id>
            <instance-attributes>
              <element>
                <name>SerialNumber</name>
                <value>
                  <string-value>999</string-value>
                </value>
              </element>
              <element>
                <name>ClassId</name>
                <value>
                  <string-value>BMC_ACCOUNT</string-value>
                </value>
              </element>
              <element>
                <name>AssignedTo</name>
                <value />
              </element>
               <element>
                <name>ShortDescription</name>
                <value>
                  <string-value>This is test description.</string-value>
                </value>
              </element>
              <element>
                <name>AttributeDataSourceList</name>
                <value>
                  <string-value>attrdataSourceList</string-value>
                </value>
              </element>
              <element>
              <name>Notes</name>
                <value>
                  <diary-value>
                    <diary-value-out>
                      <element>
                        <user>Demo</user>
                        <text>Test diary field.</text>
                        <timestamp>1247674486000</timestamp>
                      </element>
                    </diary-value-out>
                  </diary-value>
                </value>
              </element>
              <element>
                <name>OwnerName</name>
                <value />
              </element>
              <element>
                <name>Name</name>
                <value>
                  <string-value>TestClassInstance</string-value>
                </value>
              </element>
            </instance-attributes>
          </element>
        </value>
      </instance-info>
      <status>
        <value />
      </status>
    </parameters>
  </item>
</bmc-atrium-cmdb-response>
Was this page helpful? Yes No Submitting... Thank you

Comments