使用匹配条件获取配置项的明细



可以指定特定的匹配条件,以便获取符合条件的配置项的明细。所用的URL为:

http://<hostname>:<port>/api/cmdb/ci/

假设您的AssetExplorer运行在本地服务器的8080端口,则示例URL为:

http://localhost:8080/api/cmdb/ci/



关键参数:

  1. 操作名称 - 属性名称为:"OPERATION_NAME",值为:"read"。

  2. 技术员密钥 - 属性名称为:"TECHNICIAN_KEY",值为:密钥的值。


注意:  

  • 相关参数: 结果格式(format - 可选项),用于指定返回信息的格式(值为xml或者json )

  • 如果不指定该参数,则API将返回JSON 格式的结果。


使用不同条件的示例XML输入:

  1. 使用关系操作符(OR)获取配置项的明细

  2. 使用日期条件,获取配置项的明细

 

使用关系操作符(OR)获取配置项的明细,其输入XML如下:

 

<API version="1.0" locale="en">
        <criterias>
            <criteria>
                <parameter>
                    <name compOperator="START WITH">CI Type</name>
                    <!-- Can give Non english values in the parameter names as well as in the data-->
                    <value>Windows Workstation</value>
                </parameter>
                <reloperator>OR</reloperator>
                <parameter>
                    <name compOperator="CONTAINS">CI Name</name>
                    <value>sdp</value>
                </parameter>
            </criteria>
        </criterias>
        <returnparameters>
            <name>CI Name</name>
            <name>CI Type</name>
            <name>Business Impact</name>
            <name>Site</name>
            <name>Description</name>
        </returnparameters>
        <sortparameters sortOrder="desc">
            <name>CI Name</name>
            <name>Site</name>            
        </sortparameters>
        <!-- If the total number pages is 100, we can give the navigation from 50 to 50 -->
        <range>
            <startindex>1</startindex>
            <limit>50</limit>
        </range>
</API>

 



使用日期作为条件,获取配置项的明细,其输入XML如下:

 

<?xml version="1.0" encoding="UTF-8"?>
<API version="1.0">   
        <citype>
            <name>Workstation</name>
            <criterias>
                <criteria>
                    <parameter>
                        <name compOperator="IS">Acquisition Date</name>
                        <value>2011-12-30</value>
                    </parameter>
                </criteria>
            </criterias>
            <returnFields>
                <!-- Syntax to return all available column(s). <name>*</name> -->
                <name>CI Name</name>
                <name>CI Type</name>
                <name>Owned By</name>
                <name>Site</name>
                <name>Description</name>
                <name>Acquisition Date</name>
                <name>Warranty Expiry Date</name>
                <name>Expiry Date</name>
                <name>Asset Tag</name>
                <name>Serial Number</name>
                <name>Barcode</name>
                <name>Product Name</name>
                <name>Resource State</name>
                <name>Vendor</name>
                <name>Location</name>
                <name>Mac Address</name>
                <name>WS UDF Date</name>
                <name>WS UDF Num</name>
                <name>WS UDF Multi</name>
                <name>WS UDF String</name>
                <name>Sites</name>
            </returnFields>
            <sortFields sortOrder="desc">
                <name>Product Name</name>
            </sortFields>
        </citype>    
</API>

 

XML格式的输出示例(部分)

 

<?xml version="1.0" encoding="UTF-8"?>
<API locale="en" version="1.0">
    <response>

            <range>
                <startindex>40</startindex>
                <limit>50</limit>
            </range>
            <result>
                <statuscode>200</statuscode>
                <status>Success</status>
                <message>Successfully fetched.</message>
                <created-date>May 10, 2013 12:52 PM</created-date>
                <field-names>
                    <name type="String">CI Name</name>
                    <name type="String">CI Type</name>
                    <name type="String">Site</name>
                    <name type="String">Description</name>
                </field-names>
                <field-values totalRecords="14">
                    <record>
                        <value>21 (hp2650.csez.zohocorpin.com)</value>
                        <value>Switch Ports</value>
                        <value>(null)</value>
                        <value>Created while scanning..</value>
                    </record>
                    <!-- 
                    Truncated 
                        .
                        .
                        .
                    -->
                    <record>
                        <value>10 (hp2650.csez.zohocorpin.com)</value>
                        <value>Switch Ports</value>
                        <value>(null)</value>
                        <value>Created while scanning..</value>
                    </record>
                    <record>
                        <value>1 (hp2650.csez.zohocorpin.com)</value>
                        <value>Switch Ports</value>
                        <value>(null)</value>
                        <value>Created while scanning..</value>
                    </record>
                </field-values>
            </result>
        
    </response>
</API>

 

JSON格式的输出示例

 

{"API":{"locale":"en","response":{"":{"result":{"created-date":"May 10, 2013 12:55 PM","field-names":{"name":[{"type":"String","content":"CI Name"},{"type":"String","content":"CI Type"},{"type":"String","content":"Site"},{"type":"String","content":"Description"}]},"message":"Successfully fetched.","field-values":{"record":[{"value":["21 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["20 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["2 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["19 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["18 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["17 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["16 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["15 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["14 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["13 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["12 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["11 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["10 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]},{"value":["1 (hp2650.csez.zohocorpin.com)","Switch Ports","(null)","Created while scanning.."]}],"totalRecords":"14"},"status":"Success","statuscode":"200"},"range":{"limit":"50","startindex":"40"},"name":"read"}},"version":"1.0"}}

 



Copyright © 2015 卓豪(北京)技术有限公司版权所有