機能の概要
このAPIは、指定されたエクスペリエンスを廃止としてマークするか、その廃止マークを解除するために使用されます。リクエストボディ内の deprecated フィールドを true または false に設定することで実現します。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
PATCH {BASE_URL}/api/v1/memory/spaces/{spaceId}/experiences/{experienceId}/obsolescence
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
| X-OB-Project-ID | はい | {projectId} | プロジェクトID |
リクエストパラメータ
Pathパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| spaceId | string | はい | space-123 | メモリースペースID。 |
| experienceId | integer | はい | 12345 | エクスペリエンスID。 |
Bodyパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| deprecated | boolean | はい | true | trueは廃止としてマークします。falseは廃止を解除します。 |
実行結果
戻り値パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻りコード |
| message | string | 戻り値 |
| data | object | ビジネスデータ |
リクエスト例
curl --request PATCH '{BASE_URL}/api/v1/memory/spaces/{spaceId}/experiences/{experienceId}/obsolescence' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: {projectId}' \
--header 'Content-Type: application/json' \
--data '{
"deprecated": true
}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {}
}