Studio セッションガイド

終点

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files

パラメータ

cURLの例

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files) \
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client_id]" \
-d '{  
      "Name":"Pied_Piper_Acquisition.pdf",  
      "Source":"[https://portfolio.raviga.com/primarybets/piedpiper/legaldocs/Pied_Piper_Acquisition.pdf](https://portfolio.raviga.com/primarybets/piedpiper/legaldocs/Pied_Piper_Acquisition.pdf)"
    }' \
-X POST

回答例

{
  "Id": 1234567
  "UploadUrl":"{upload file to this URL}"
  "UploadContentType":"Application/PDF"
}

アップロードウィンドウ
アップロード URL はアップロード開始から 10 分間有効です。

ファイルのメタデータ ブロック プレースホルダーを作成したら、前のPOSTリクエストから返されたUploadURLにPUTリクエストを実行します。PUTリクエストでは、ヘッダーに次の内容を含めます。

• 値が"AES256"の"x-amz-server-side-encryption"

• 値が"application/pdf"である"Content-Type"

終点

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files/{id}/confirm-upload

cURLの例

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/confirm-upload](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/confirm-upload) \
-H "Authorization: Bearer {valid access_token}" \
-H "client_id: [your client id]" \
-X POST

レスポンス

成功した場合、 204応答が返されます。エラーについては、 認証ガイド の下部にある 一般的な HTML 応答コードを 参照してください。

この方法は、まだ Studio アカウントを持っていない可能性のあるユーザーを招待するのに最適です。招待された人には、無料の Studio アカウントを作成する機会を記載したメールが送信されます。

終点

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/invite

パラメータ

例

cURL https://api.bluebeam.com/publicapi/v1/sessions/{session}/invite \
-H "Authorization: Bearer {token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: {client_id}" \
-d '{  
      "Email":"gavin.belson@hooli.com",  
      "メッセージ":"このセッションに参加して、Pied Piper買収についてのドキュメントをレビューしてください。"
    }' \
-X POST

レスポンス

成功した場合、 204応答が返されます。エラーについては、 認証ガイド の下部にある 一般的な HTML 応答コードを 参照してください。

この方法は、メール アドレスがすでに Studio アカウントに関連付けられていることがわかっていて、オプトインせずに Studio セッションに追加したい場合に最適です。ユーザーがアカウントを持っていない場合、またはアカウントを持っているかどうか不明な場合は、 「方法 A: ユーザーを招待する」を使用します。方法 B: ユーザーの追加 を使用すると、ユーザーが Studio セッションの出席者に追加され、Revu インターフェースの Studio タブ内の出席者セッションの下に Studio セッションが表示されます。

終点

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/users

パラメータ

例

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/users](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/users)
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client id]" \
-d '{  
      "メール": "peter.gregory@raviga.com",
      "SendEmail": true,
      "メッセージ": "リクエストに応じて、こちらがPied Piper買収ドキュメントをレビューするためのセッションです。"
    }' \
-X POST

レスポンス

成功した場合、 204応答が返されます。エラーについては、 認証ガイド の下部にある 一般的な HTML 応答コードを 参照してください。

セッション招待メールの例

セッションのステータスを「終了中」に設定すると、ホストを除くすべてのユーザーがセッションから削除されます。これは、セッション ファイルがダウンロードされた後にさらに変更されるのを防ぐために行われます。

終点

https://api.bluebeam.com/publicapi/v1/sessions/{id}

例

cURL https://api.bluebeam.com/publicapi/v1/sessions/123-456-789 \
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client id]" \
-d '{"Status": "Finalizing"}' \
-X PUT

マークアップされたセッション ファイルのダウンロードは 2 つの部分からなるプロセスです。セッション内の各ファイルに対して、以下の手順に従います。

i. スナップショットを作成する

セッション中は、PDF とマークアップは別々に保存されます。スナップショットは、PDF コンテンツとマークアップ レイヤーを 1 つの PDF に結合するため、Studio セッションの外部で PDF 上でマークアップを表示できるようになります。

終点

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files/{id}/snapshot

例

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/snapshot](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/snapshot) \
-H "Authorization: Bearer {valid access_token}" \
-H "client_id: [your client id]" \

ii. スナップショットのステータスを確認し、完了している場合はダウンロードします。

StatusがCompleteまたはErrorになるまで、スナップショット エンドポイントにGETリクエストを送信します。

• Errorの場合: ユーザーに提示できるエラー メッセージが含まれます。

• Complete場合: DownloadUrlを使用してスナップショットをダウンロードします

終点

https://api.bluebeam.com/publicapi/v1/sessions/{sessionId}/files/{id}/snapshot

例

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789/files/1234567/)
-H "Authorization: Bearer {valid access_token}" \
-H "client_id: [your client id]" \
-X GET

レスポンス本文

{
    "Status": "Complete",
    "StatusTime": "{The last time the Status was changed}",
    "LastSnapshotTime": "{Time of last successful Snapshot}",
    "DownloadUrl": "{A download URL for the last successful Snapshot}"
}

ステータスオプション

マークアップされた PDF が作成されたので、セッション ID エンドポイントにDELETEリクエストを送信してセッションを破棄できます。

終点

https://api.bluebeam.com/publicapi/v1/sessions/{id}

セッションを終了する例

cURL [https://api.bluebeam.com/publicapi/v1/sessions/123-456-789](https://api.bluebeam.com/publicapi/v1/sessions/123-456-789) \
-H "Authorization: Bearer {valid access_token}" \
-H "Content-Type: Application/JSON" \
-H "client_id: [your client id]" \
-X DELETE