Alfresco API

GET /queries/people

基本信息

Note: 该端点在Alfresco 5.2和更高版本中可用。

获取符合给定搜索条件的people列表。

搜索词用于查找与people ID,名字和姓氏匹配的项。

搜索词:

  • 必须至少包含2个字母数字字符
  • 可以选择在术语内使用“ *”进行通配符匹配

您可以使用orderBy参数对结果列表进行排序。 您可以在orderBy参数中指定以下一个或多个字段:

  • id
  • 姓名(firstName)
  • 姓氏(lastName)

请求方式 :GET

请求API: /queries/people

响应等级(状态200)

成功回应

{
  "list": {
    "pagination": {
      "count": 0,
      "hasMoreItems": true,
      "totalItems": 0,
      "skipCount": 0,
      "maxItems": 0
    },
    "entries": [
      {
        "entry": {
          "id": "string",
          "firstName": "string",
          "lastName": "string",
          "description": "string",
          "avatarId": "string",
          "email": "string",
          "skypeId": "string",
          "googleId": "string",
          "instantMessageId": "string",
          "jobTitle": "string",
          "location": "string",
          "company": {
            "organization": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "postcode": "string",
            "telephone": "string",
            "fax": "string",
            "email": "string"
          },
          "mobile": "string",
          "telephone": "string",
          "statusUpdatedAt": "2021-01-08T08:52:11.580Z",
          "userStatus": "string",
          "enabled": true,
          "emailNotificationsEnabled": true,
          "aspectNames": [
            "string"
          ],
          "properties": {},
          "capabilities": {}
        }
      }
    ]
  }
} 

响应内容类型 applicaiton/json

Query参数

名称 类型 是否必填 示例值 描述
term string   要搜索的字词。
skipCount integer 0 在list中跳过指定数量的数据。 如果未提供,则默认值为0。
maxItems integer 100 list中要返回的最大项目数。 如果未提供,则默认值为100。
orderBy Array[string]   控制list中entities退回顺序的string。您可以使用orderBy参数通过一个或多个fields对列表进行排序。每个fields都有一个默认的排序顺序,通常是升序的。阅读API方法实践说明以检查是否所有fields使用这个方法将默认搜索顺序设为降序。要按照特殊顺序对entities进行排序的话,您可以使用ASC和DESC关键字对fields进行排序。
fields Array[string]   field名称的list。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。
例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 该列表适用于返回的单个实体或集合中的条目。
如果API方法也支持include参数,则除了在fields参数中指定的fields外,还返回include参数中指定的fields。

错误信息描述

状态码 原因
400 参数无效:maxItems的值或skipCount无效,或者搜索词太短或orderBy无效
401 验证失败
default 意外错误

返回结果示例

{
  "error": {
    "errorKey": "string",
    "statusCode": 0,
    "briefSummary": "string",
    "stackTrace": "string",
    "descriptionURL": "string",
    "logId": "string"
  }
}