Space/documents

​
ドキュメントのコメントを削除します（作成者のみ）。スレッドの最初のコメントを削除するとスレッドも削除されます

DELETE
/v1/space/documents/{document_id}/comments/{comment_id}
curl -X DELETE "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E/comments/%3Ccomment_id%3E" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
{  "data": {    "deleted": true,    "id": "<string>"  }}

Orchestor API キーを取得

ワークスペースの設定から API キーを作成します。

認証

次のいずれかの条件を満たしてください。

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

ウェブアプリにサインインすることで確立されるブラウザセッションです。サーバーは、ワークスペースのメンバーシップと権限を確認します。ワークスペーススコープの操作には X-Workspace-ID を指定してください。サーバー間リクエストの場合、操作がサポートしていれば API キーを使用します。

パスパラメータ

document_idstringpath必須
パターン
^doc_[a-f0-9]{24}$
comment_idstringpath必須
パターン
^dcm_[a-f0-9]{24}$

ヘッダー

X-Workspace-IDstringheader

アクセスするワークスペースです。ワークスペーススコープの API キーを使用する場合、サーバーはキーからこの値を導出するため、ヘッダーは任意です。指定する場合、認証情報のワークスペースと一致する必要があり、一致しない場合リクエストは 403 workspace_mismatch を返します。インタラクティブなセッションリクエストの場合、メンバーになっているワークスペースを選択するためにこのヘッダーを指定します。プロジェクト ID をワークスペース ID として使用することはできません。

例"wks_abc123"

レスポンス

application/json

削除されたコメント

dataobject必須
data.deletedbooleanenum<boolean>必須
許可される値
true
data.idstring必須