コメントとコミュニティ
コメント送信結果を取得
確認済みの送信、復旧の継承関係、検証待ち、未解決の対応事項を取得します。
POST /community-engagement-api/comments/outcome契約確認日: · sha256:563d2d581da0ad29
概要
確認済みの送信、復旧の継承関係、検証待ち、未解決の対応事項を取得します。
HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。
認証と権限
トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。
リクエストのフィールド
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド/分岐 | 型/必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 |
|
workspace_id | string親要素内で必須 |
|
action_id | string親要素内で必須 |
|
完全なJSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"workspace_id",
"action_id"
],
"additionalProperties": false
}レスポンスと完了条件
成功時のHTTPステータス: 200. 操作完了時: domain delivery resolution.
HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド/分岐 | 型/必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 | — |
contract_version | string親要素内で必須 |
|
action_id | string親要素内で必須 |
|
status | string親要素内で必須 |
|
execution_stage | string親要素内で必須 |
|
verification_count | integer親要素内で必須 |
|
verification_evidence | object親要素内で必須 |
|
verification_evidence.* | any JSON value任意/項目 | — |
delivery_outcome | string親要素内で必須 |
|
follow_up_required | boolean親要素内で必須 | — |
resolution | object | null親要素内で必須 | — |
resolutionanyOf 1 | object親要素内で必須 | — |
resolution.action_idanyOf 1 | string親要素内で必須 |
|
resolution.workspace_idanyOf 1 | string親要素内で必須 |
|
resolution.kindanyOf 1 | string親要素内で必須 |
|
resolution.replacement_action_idanyOf 1 | string | null親要素内で必須 | — |
resolution.replacement_action_idanyOf 1 / anyOf 1 | string親要素内で必須 |
|
resolution.replacement_action_idanyOf 1 / anyOf 2 | null親要素内で必須 | — |
resolution.evidenceanyOf 1 | object親要素内で必須 |
|
resolution.evidence.*anyOf 1 | any JSON value任意/項目 | — |
resolution.created_byanyOf 1 | string | null親要素内で必須 | — |
resolution.created_byanyOf 1 / anyOf 1 | string親要素内で必須 |
|
resolution.created_byanyOf 1 / anyOf 2 | null親要素内で必須 | — |
resolution.created_atanyOf 1 | string親要素内で必須 |
|
resolutionanyOf 2 | null親要素内で必須 | — |
完全なJSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "community-engagement/v1"
},
"action_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"status": {
"type": "string",
"enum": [
"queued",
"executing",
"succeeded",
"attention",
"failed"
]
},
"execution_stage": {
"type": "string",
"enum": [
"execute",
"verify"
]
},
"verification_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"verification_evidence": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"delivery_outcome": {
"type": "string",
"enum": [
"confirmed",
"recovered",
"not_attempted",
"unknown"
]
},
"follow_up_required": {
"type": "boolean"
},
"resolution": {
"anyOf": [
{
"type": "object",
"properties": {
"action_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"enum": [
"confirmed_delivery",
"confirmed_replacement"
]
},
"replacement_action_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"evidence": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"created_by": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"action_id",
"workspace_id",
"kind",
"replacement_action_id",
"evidence",
"created_by",
"created_at"
]
},
{
"type": "null"
}
]
}
},
"required": [
"contract_version",
"action_id",
"status",
"execution_stage",
"verification_count",
"verification_evidence",
"delivery_outcome",
"follow_up_required",
"resolution"
]
}エラーと安全な再試行
HTTPステータスとレスポンス本文を確認します。400の検証エラーにはZodErrorが含まれる場合があります。ハンドラーエラーはerror、message、codeを使用します。診断用にrequest_idまたはx-request-idを保持し、認証情報は含めないでください。401/403はアクセス問題を解消してから再試行し、429はRetry-Afterに従います。書き込み結果が不確か、または5xxの場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。
トラブルシューティングガイド例
スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。
サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。エージェントはsosoapi auth loginでブラウザーログインし、CLIに更新を任せます。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"action_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/comments/outcome" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/comments/outcome", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"action_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /community-engagement-api/comments/outcome < request.json合成レスポンス例
{
"contract_version": "community-engagement/v1",
"action_id": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"execution_stage": "execute",
"verification_count": 0,
"verification_evidence": {},
"delivery_outcome": "confirmed",
"follow_up_required": false,
"resolution": null
}