Notes端点

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

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

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

注释可应用以下资源:

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

注意

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

但是,注释仍可从修订中读取。 在这种情况下,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: {IMS_ORG}' \
  -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: {IMS_ORG}' \
  -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

请求

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

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: {IMS_ORG}' \
  -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"
    }
  }
}

在此页面上