Document

Document（ドキュメント）は、ワークフロー上のテンプレート設定を表します。各出力を生成するためにコピーされる Google Drive ファイルを参照します。

Fields（フィールド）

Field	Type	Description
id	String	ドキュメントの ID。
documentType	String	テンプレートの種類。選択したファイルに応じて `"GOOGLE_DOCS"` または `"GOOGLE_SLIDES"` のいずれかになります。
file	Google File	テンプレートとして使用する Google Drive ファイル。このファイルがコピーされて出力ドキュメントが作成されます。
outputName	String	このテンプレートから作成される各出力の名前に使用するテンプレート文字列。
createPDFCopy	Boolean	true の場合、Portant は出力ドキュメントの PDF コピーも作成します。
removeOutput	Boolean	true の場合、PDF コピーの作成後に元の出力ドキュメント（Google Docs または Slides）が削除されます。
enablePdfPassword	Boolean	true の場合、生成される PDF がパスワードで暗号化されます。
pdfPassword	String	PDF パスワードの生成に使用するテンプレート文字列。`enablePdfPassword` が true の場合にのみ使用されます。
PdfPasswordPreventCopy	Boolean	true の場合、パスワードで保護された PDF からコンテンツをコピーできなくなります。
previewUrl	String	Portant を使用していないユーザーがソースフィールドを通じてこのドキュメントを編集するために使用する埋め込みエディターへの URL。ユーザーがすでに元の Google File にアクセスできることを前提としています。注意: この機能はまだ実装されておらず、変更される可能性があります。

Example（例）

{
    "id": "doc_5LGGqC5S78RNS0",
    "documentType": "GOOGLE_DOCS",
    "file": {
        "id": "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4",
        "name": "Complete Workflow Please - [Template]",
        "url": "https://docs.google.com/document/d/1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4/edit?usp=drivesdk",
        "mimeType": "application/vnd.google-apps.document"
    },
    "outputName": "Document for {{First Name}}",
    "createPdfCopy": true,
    "removeOutput": false,
    "enablePdfPassword": false,
    "pdfPassword": "Password-{{Secret Number}}",
    "pdfPasswordPreventCopy": false,
    "previewUrl": "https://preview.portant.co/doc_5LGGqC5S78RNS0"
}

Endpoints（エンドポイント）

ワークフローのすべてのドキュメントを一覧表示する

GET /workflows/<wkf_id>/documents/

特定のワークフローに属するすべてのドキュメントを一覧表示します。

Responses（レスポンス）

Status	Body
200 OK	Array<Document>
403 Unauthorised	Error

ワークフローにドキュメントを作成する

POST /workflows/<wkf_id>/documents/

ワークフローに新しいドキュメントを作成します。

Request（リクエスト）

JSON 形式の create Document オブジェクト。

ペイロードには、リクエストを行うユーザーがアクセス権を持つ Google Drive ファイルの file_id をオプションとして含めることができます。

{
    file_id?: "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4"
}

file_id を省略した場合、新しいドキュメントがゼロから作成されます。

Responses（レスポンス）

Status	Body
201 Created	Document
400 Bad Request	Error
403 Unauthorised	Error

ドキュメントを取得する

GET /workflows/<wkf_id>/documents/<doc_id>/

特定のワークフロー上の特定のドキュメントを取得します。

Responses（レスポンス）

Status	Body
200 OK	Document
403 Unauthorised	Error

ドキュメントを更新する

PATCH /workflows/<wkf_id>/documents/<doc_id>/

ID を指定して特定のドキュメントを更新します。

Request（リクエスト）

JSON 形式の partial Document オブジェクト。ペイロードにはドキュメントの編集可能なフィールドを任意に含めることができます。ドキュメントの作成後に選択済みのファイルを変更することはできません。

{
    "outputName"?: "New outputName for {{First Name}}",
    "pdfPassword"?: "NewPassword-{{Secret Number}}",
    "enablePdfPassword"?: true,
    "enablePdfPreventCopy"?: true,
}

Responses（レスポンス）

Status	Body
200 OK	Document
400 Bad Request	Error
403 Unauthorised	Error