メモエンドポイント

Reactor API では、メモは特定のリソースに追加できるテキスト注釈です。 メモは基本的に、それぞれのリソースに関するコメントです。 メモの内容は、リソースの動作に影響を与えず、次のような様々なユースケースに使用できます。

  • 背景情報の提供
  • TODO リストとしての機能
  • リソース使用状況に関するアドバイスを渡す
  • 他のチームメンバーに指示を与える
  • 履歴コンテキストの記録

Reactor API の /notes エンドポイントを使用すると、これらのメモをプログラムで管理できます。

メモは、次のリソースに添付できます。

これら 6 種類はまとめて「メモ機能のある」リソースと呼ばれます。メモ機能のあるリソースを削除すると、関連付けられたメモも削除されます。

メモ

複数のリビジョンを設定できるリソースの場合は、現在の(ヘッド)リビジョンでメモを作成する必要があります。 これらは、他のリビジョンには添付できない可能性があります。

ただし、メモは引き続きリビジョンから読み取ることができます。 この場合、API はリビジョンの作成前に存在したメモのみを返します。 リビジョンを切り取ったときと同じように、注釈のスナップショットが表示されます。 これに対し、現在の(ヘッド)リビジョンからメモを読み取ると、すべてのメモが返されます。

はじめに

このガイドで使用するエンドポイントは、Reactor API の一部です。続行する前に、 はじめる前に で、API への認証方法に関する重要な情報を確認してください。

メモのリストの取得

リソースのメモのリストを取得するには、該当するリソースの GET リクエストのパスに /notes を追加します。

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"
    }
  }
}

メモの作成

警告

新しいメモを作成する前に、メモは編集できず、メモを削除するには対応するリソースを削除する必要があるということを覚えておいてください。

新しいメモを作成するには、該当するリソースの POST リクエストのパスに /notes を追加します。

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"
    }
  }
}

このページ