SDP API 获取所有的资产

API调用URL地址

http://<serverName>:<portNumber>/api/v3/assets

示例：http://192.168.1.8:8080/api/v3/assets

请求参数

方法：GET

请求参数：

参数名	值	位置
input_data	<JSON_String>	params
authtoken	<API Key>	header

输入示例

{
    "list_info": {
        "row_count": "25",
        "get_total_count": true,
        "start_index": 1,
        "search_criteria": [
            {
                "field": "name",
                "value": "test",
                "condition": "contains",
                "logical_operator": "AND"
            },
            {
                "field": "product_type.name",
                "value": "test",
                "condition": "contains",
                "logical_operator": "AND"
            }
        ],
        "sort_field": "computer_system.service_tag",
        "sort_order": "asc",
        "fields_required": [
            "product_type",
            "operating_system.os",
            "ip_addresses",
            "vendor",
            "name",
            "computer_system.model",
            "org_serial_number",
            "state",
            "purchase_cost",
            "department",
            "user",
            "computer_system.service_tag",
            "icon",
            "ci",
            "operating_system.os",
            "last_success_audit"
        ]
    }
}

List_info中的值为API请求的参数，关键字解释如下：

”row_count”:”20”，为查询返回20个数据；

“start_index“：1，为从第一个开始查询；

“get_total_count”:true，为获得所有数据计数。对应API响应中的 "total_count": 0；

“search_fields”:{"subject":"New hire", "priority.name":"high"}，简单搜索条件，以上示例为检索主题为New hire和优先级为"high"的请求信息

"search_criteria":高级搜索条件，参考链接：ManageEngine卓豪技术支持

"sort_field":"subject"：以主题为排序列；

“sort_order”:”asc”，为升序排列；

"fields_required"，API需要返回的字段。不是所有的字段都可返回，仅页面中的列选择器可以选择的字段；

响应示例

{
    "assets": [
//符合条件的资产信息会在此输出
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "start_index": 1,
        "sort_field": "computer_system.service_tag",
        "fields_required": [
            "product_type",
            "operating_system.os",
            "ip_addresses",
            "vendor",
            "name",
            "computer_system.model",
            "org_serial_number",
            "state",
            "purchase_cost",
            "department",
            "user",
            "computer_system.service_tag",
            "icon",
            "ci",
            "operating_system.os",
            "last_success_audit"
        ],
        "total_count": 0,
        "filter_by": {
            "id": 1
        },
        "page": 1,
        "sort_order": "asc",
        "search_criteria": [
            {
                "condition": "contains",
                "field": "name",
                "logical_operator": "AND",
                "value": "test"
            },
            {
                "condition": "contains",
                "field": "product_type.name",
                "logical_operator": "AND",
                "value": "test"
            }
        ],
        "get_total_count": "true",
        "row_count": 0
    }
}

Postman示例

Python脚本示例

#Python version - 3.8
#This script requires requests module installed in python.
import requests
 
url = "https://localhost:8081/api/v3/assets"
headers ={"authtoken":"79A55158-2281-4F34-A64E-321EB809085F"}
input_data = '''{
    "list_info": {
        "row_count": "25",
        "get_total_count": true,
        "start_index": 1,
        "search_criteria": [
            {
                "field": "name",
                "value": "test",
                "condition": "contains",
                "logical_operator": "AND"
            },
            {
                "field": "product_type.name",
                "value": "test",
                "condition": "contains",
                "logical_operator": "AND"
            }
        ],
        "sort_field": "computer_system.service_tag",
        "sort_order": "asc",
        "filter_by": {
            "id": 1
        },
        "fields_required": [
            "product_type",
            "operating_system.os",
            "ip_addresses",
            "vendor",
            "name",
            "computer_system.model",
            "org_serial_number",
            "state",
            "purchase_cost",
            "department",
            "user",
            "computer_system.service_tag",
            "icon",
            "ci",
            "operating_system.os",
            "last_success_audit"
        ]
    }
}'''
params = {'input_data': input_data}
response = requests.get(url,headers=headers,params=params,verify=False)
print(response.text)