注释端点

上次更新: 2023-05-25
  • 主题:
  • Tags
    查看有关此主题的更多信息
  • 创建对象:
  • Developer
    User
    Admin
    Leader

在Reactor API中,注释是可以添加到特定资源的文本批注。 附注基本上是对各自资源的评论。 注释的内容对资源行为没有影响,可用于各种用例,包括:

  • 提供背景信息
  • 用作待办事项列表
  • 传递资源使用建议
  • 向其他团队成员提供说明
  • 记录历史上下文

/notes Reactor API中的端点允许您以编程方式管理这些注释。

注释可以应用于以下资源:

这六种类型统称为“重要”资源。 删除重要资源时,也会删除其关联的注释。

注意

对于可以具有多个修订版本的资源,必须在当前(标题)修订版本上创建任何注释。 它们不能附加到其他修订版。

但是,仍可以从修订版本中读取注释。 在这种情况下,API仅返回创建修订版本之前存在的注释。 它们提供了修改时注释的快照。 相反,从当前(标题)修订阅读注释将返回其所有注释。

快速入门

本指南中使用的端点是 Reactor API. 在继续之前,请查看 快速入门指南 有关如何对API进行身份验证的重要信息。

检索注释列表

您可以通过附加来检索资源的注释列表 /notes 指向相关资源的GET请求的路径。

API格式

GET /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
参数 描述
RESOURCE_TYPE 您正在为其获取注释的资源类型。 必须为以下值之一:
  • data_elements
  • extensions
  • libraries
  • properties
  • rule_components
  • rules
RESOURCE_ID id 要列出其注释的特定资源的。

请求

以下请求列出了附加到库的注释。

curl -X GET \
  https://reactor.adobe.io/libraries/LBcffea1a38c52408cae2398868625a12d/notes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

响应

成功响应将返回附加到指定资源的注释列表。

{
  "data": [
    {
      "id": "NTa40de8d76bfd4e40835830900ce83b7b",
      "type": "notes",
      "attributes": {
        "author_display_name": "John Smith",
        "author_email": "jsmith@example.com",
        "created_at": "2020-12-14T17:51:00.411Z",
        "text": "this is a note on a library"
      },
      "relationships": {
        "resource": {
          "links": {
            "related": "https://reactor.adobe.io/libraries/LBcffea1a38c52408cae2398868625a12d"
          },
          "data": {
            "id": "LBcffea1a38c52408cae2398868625a12d",
            "type": "libraries"
          }
        }
      },
      "links": {
        "resource": "https://reactor.adobe.io/libraries/LBcffea1a38c52408cae2398868625a12d",
        "self": "https://reactor.adobe.io/notes/NTa40de8d76bfd4e40835830900ce83b7b"
      }
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": null,
      "prev_page": null,
      "total_pages": 1,
      "total_count": 1
    }
  }
}

查找注释

您可以通过在GET请求的路径中提供注释的ID来查找注释。

API格式

GET /notes/{NOTE_ID}
参数 描述
NOTE_ID id 您想要查找的注释的。

请求

curl -X GET \
  https://reactor.adobe.io/notes/NT550b7a17ab304d49ba289a2978d673e5 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

响应

成功响应将返回注释的详细信息。

{
  "data": {
    "id": "NT550b7a17ab304d49ba289a2978d673e5",
    "type": "notes",
    "attributes": {
      "author_display_name": "John Smith",
      "author_email": "jsmith@example.com",
      "created_at": "2020-12-14T17:51:10.316Z",
      "text": "this is a note on a property"
    },
    "relationships": {
      "resource": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8"
        },
        "data": {
          "id": "PR4537ac6f1f204ffd864ec47c4b27c2e8",
          "type": "properties"
        }
      }
    },
    "links": {
      "resource": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8",
      "self": "https://reactor.adobe.io/notes/NT550b7a17ab304d49ba289a2978d673e5"
    }
  }
}

创建注释

警告

创建新注释之前,请记住,注释不可编辑,删除它们的唯一方法是删除其相应的资源。

您可以通过附加来创建新注释 /notes 到相关资源的POST请求的路径。

API格式

POST /{RESOURCE_TYPE}/{RESOURCE_ID}/notes
参数 描述
RESOURCE_TYPE 正在为其创建注释的资源类型。 必须为以下值之一:
  • data_elements
  • extensions
  • libraries
  • properties
  • rule_components
  • rules
RESOURCE_ID id 要为其创建注释的特定资源的ID。

请求

以下请求为资产创建新的注释。

curl -X POST \
  https://reactor.adobe.io/properties/PRb25a704c0b7c4562835ccdf96d3afd31/notes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -d '{
        "data": {
          "type": "notes",
          "attributes": {
            "text": "this is a note on a property"
          }
        }
      }'
属性 描述
type (必需) 正在更新的资源类型。 对于此端点,值必须为 notes.
attributes.text (必需) 构成注释的文本。 每个注释最多可包含512个Unicode字符。

响应

成功响应将返回新创建的注释的详细信息。

{
  "data": {
    "id": "NT550b7a17ab304d49ba289a2978d673e5",
    "type": "notes",
    "attributes": {
      "author_display_name": "John Smith",
      "author_email": "jsmith@example.com",
      "created_at": "2020-12-14T17:51:10.316Z",
      "text": "This is a note on a property"
    },
    "relationships": {
      "resource": {
        "links": {
          "related": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8"
        },
        "data": {
          "id": "PR4537ac6f1f204ffd864ec47c4b27c2e8",
          "type": "properties"
        }
      }
    },
    "links": {
      "resource": "https://reactor.adobe.io/properties/PR4537ac6f1f204ffd864ec47c4b27c2e8",
      "self": "https://reactor.adobe.io/notes/NT550b7a17ab304d49ba289a2978d673e5"
    }
  }
}

在此页面上