Notes端點

在Reactor API中,附註是可新增至特定資源的文字註解。 附註主要是對各自資源的評論。 附註的內容對資源行為沒有影響,可用於多種使用案例,包括:

  • 提供背景資訊
  • 運作方式清單
  • 傳遞資源使用建議
  • 向其他團隊成員提供指示
  • 記錄歷史內容

/notes reactor API中的端點可讓您以程式設計方式管理這些附註。

附註可套用至下列資源:

這六種類型統稱為「顯著」資源。 刪除顯著資源時,也會刪除其相關附註。

注意

對於可以有多個修訂的資源,必須在當前(標題)修訂上建立任何注釋。 它們不得附於其他修訂版本。

不過,修訂版仍可閱讀附註。 在這種情況下,API只會傳回建立修訂版本之前存在的附註。 它們提供注釋的快照,與剪切修訂時的快照一樣。 相反地,從當前(head)修訂中讀取注釋將返回其所有注釋。

快速入門

本指南中使用的端點屬於 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
    }
  }
}

查找注釋

您可以在請求的路徑中提供附註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"
    }
  }
}

本頁內容