GET /action-definitions

基本信息

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

获取所有可用action的list。

返回list的默认排序顺序是按名称升序进行的。您可以使用orderBy参数覆盖默认值。

您可以使用以下任何字段来排序结果：

• 名称（name）
• 标题（title）

请求方式：GET

请求API： /action-definitions

响应等级（状态200）

成功回应

{
  "list": {
    "pagination": {
      "count": 0,
      "hasMoreItems": true,
      "totalItems": 0,
      "skipCount": 0,
      "maxItems": 0
    },
    "entries": [
      {
        "id": "string",
        "name": "string",
        "title": "string",
        "description": "string",
        "applicableTypes": [
          "string"
        ],
        "trackStatus": true,
        "parameterDefinitions": [
          {
            "name": "string",
            "type": "string",
            "multiValued": true,
            "mandatory": true,
            "displayLabel": "string"
          }
        ]
      }
    ]
  }
}

响应内容类型 applicaiton/json

Query参数

名称	类型	是否必填	示例值	描述
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"
  }
}