查询所有用户的信息

查询所有用户的信息

API调用URL地址

http://<serverName>:<portNumber>/api/v3/users
其中<serverName>:<portNumber>替换为您的环境下SDP所在的主机IP和对应端口

请求参数

方法:GET

参数名


位置

Input_data

<JSON_String>

URL路径

authtoken

<API Key>

header

 

<JSON_String>输入示例:

%7B%0A%20%20%20%20%22list_info%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22sort_field%22%3A%20%22name%22%2C%0A%20%20%20%20%20%20%20%20%22start_index%22%3A%201%2C%0A%20%20%20%20%20%20%20%20%22sort_order%22%3A%20%22asc%22%2C%0A%20%20%20%20%20%20%20%20%22row_count%22%3A%20%2225%22%2C%0A%20%20%20%20%20%20%20%20%22get_total_count%22%3A%20true%2C%0A%20%20%20%20%20%20%20%20%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22fields_required%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%22email_id%22%2C%0A%20%20%20%20%5D%0A%7D%0A

提示:以上为执行URLEncode之后的值,原值为:
{
    "list_info": {
        "sort_field": "name",
        "start_index": 1,
        "sort_order": "asc",
        "row_count": "25",
        "get_total_count": true,
 
    },
    "fields_required": [
        "email_id",
    ]
}

List_info中的值为API请求的参数,其中:
start_index“:1,为从第一个开始查询;
sort_order:”asc”,为升序排列;
”row_count”:”25”,为查询返回25个数据;
get_total_count:true,为获得所有数据计数。
search_fields:{“email_id”:”guest@zoho.com”},即搜索条件,以上示例为检索邮箱地址为guest@zoho.com的用户信息
fields_required中的值为响应结果需要的属性,其他属性会被过滤掉。如”email_id”为邮箱地址。

 

响应示例

{
    "response_status": [
        {
            "status_code"2000,
            "status""success"
        }
    ],
    "list_info": {
        "has_more_rows"false,
        "start_index"1,
        "sort_field""name",
        "total_count"4,
        "sort_order""asc",
        "get_total_count""true",
        "row_count"22
    },
    "users": [
        {
            "email_id""APItest@test.com",
            "is_technician"false,
            "id""1806",
            "type""User",
            "profile_pic_url"null,
            "citype": {
                "name""用户",
                "id"3
            }
        },
        {
            "email_id""APItest@test.com",
            "is_technician"false,
            "id""1804",
            "type""User",
            "profile_pic_url"null,
            "citype": {
                "name""用户",
                "id"3
            }
        },
        {
            "email_id""APItest@test.com",
            "is_technician"false,
            "id""1803",
            "type""User",
            "profile_pic_url"null,
            "citype": {
                "name""用户",
                "id"3
            }
        },
        {
            "email_id""APItest@test.com",
            "is_technician"false,
            "id""1808",
            "type""User",
            "profile_pic_url"null,
            "citype": {
                "name""用户",
                "id"3
            }
        },
    ]
}

 

Postman示例



2-3



    • Related Articles

    • 查询一个用户信息

      API调用URL地址 http://<serverName>:<portNumber>/api/v3/users/<user_id> 其中<user_id>为被查询信息用户的id 示例:http://localhost:8080/api/v3/users/4 请求参数 HTTP方法:GET 参数名 值 位置 authtoken <API Key> header   响应示例 {     "response_status": {         "status_code": 2000, ...
    • SDP SaaS API学习汇总

      DataCenter API Domain URL Accounts Server URL API Endpoint China https://servicedeskplus.cn https://accounts.zoho.com.cn https://servicedeskplus.cn/api/v3/requests 授权领牌/认证代码 - 认证服务器创建的临时领牌,用于客户端认证 访问领牌,执行API操作,时限1小时 刷新领牌,重新获取访问领牌 ...
    • apm/opm 添加监视器 or 设备等常规api

      以apm为例,有些特殊情形下,监视器无法添加,无法删除等,但苦于没有及时有效的sql语句去操作,可以参考以下链接,从而排错,其他操作可查阅具体手册。 https://www.manageengine.cn/products/applications_manager/help/addmonitor-api.html opm也有丰富的api可操作设备,告警,组等供参考。 ...
    • 用API添加ci项时multi-line类型字段如何带格式?

      CMDB中的字段single-line最多显示250个字符,multi-line最多显示4000个字符,如果不加格式会在一行内显示。 有时客户希望多行文本中的值带一定格式,便于查看,比如说如下方式: 在调用API时,需要使用转码器将字符由ACSI转成Unicode即可,如下述所示,换行转码后是&#10;
    • 【OPM】如何查找API密钥

      1,点击右上角齿轮图标 2,点击REST API密钥 复制即可。 注意:注意事项