Alfresco API

GET /nodes/{nodeId}/audit-entries

基本信息

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

获取节点nodeId的audit条目的列表。

列表可以由createdByUser过滤并给定包含的的时间段。

默认排序顺序是在升序创建(createdAt)的,但是您可以使用可选的ASCDESC修饰符来指定升序或降序。

例如,指定orderBy = createdAt DESC将以createdAt降序返回audit条目。

这依赖于预先配置的“Alfresco访问”(alfresco-access) audit应用程序。

请求方式:GET

请求API :/nodes/{nodeId}/audit-entries

响应等级(状态200)

成功回应

{
  "list": {
    "pagination": {
      "count": 0,
      "hasMoreItems": true,
      "totalItems": 0,
      "skipCount": 0,
      "maxItems": 0
    },
    "entries": [
      {
        "entry": {
          "id": "string",
          "auditApplicationId": "string",
          "createdByUser": {
            "displayName": "string",
            "id": "string"
          },
          "createdAt": "2021-01-08T08:52:11.174Z",
          "values": {}
        }
      }
    ]
  }
}     

响应内容类型 applicaiton/json

Query参数

名称 类型 是否必填 示例值 描述
skipCount integer 0 在list中跳过指定数量的数据。 如果未提供,则默认值为0。
maxItems integer 100 列表中要返回的最大项目数。 如果未提供,则默认值为100。
orderBy Array[string]   控制list中entities退回顺序的string。您可以使用orderBy参数通过一个或多个fields对列表进行排序。每个fields都有一个默认的排序顺序,通常是升序的。阅读API方法实践说明以检查是否所有fields使用这个方法将默认搜索顺序设为降序。要按照特殊顺序对entities进行排序的话,您可以使用ASC和DESC关键字对fields进行排序。
where string   可选过滤列表。 示例:
where=(createdByUser='-me-')
where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
include Array[string]   返回有关audit条目的其他信息。 可以请求以下可选字段:values
fields Array[string]   field名称的list。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。
例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 该列表适用于返回的单个实体或集合中的条目。
如果API方法也支持include参数,则除了在fields参数中指定的fields外,还返回include参数中指定的fields。

Path参数

名称 类型 是否必填 示例值 描述
pernodeId string   节点的标识符。

错误信息描述

状态码 原因
400 无效的参数:nodeId不是有效的格式,maxItemsskipCount *的值无效
401 验证失败
403 用户无权获取audit信息
404 nodeId不存在
501 系统禁用audit
default 意外错误

返回结果示例

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