マージおよび保存 V2 API
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
目的:
Merge and Store V1 APIは、マージ操作が完了するとRIDのみを含むレスポンスを返します。Delugeスクリプトでは、最大タイムアウトは40秒です。しかし、一部のケースではマージ操作が40秒を超え、DREワークフローが失敗する原因となることがあります。
この問題に対処するために、 Merge and Store V2 API を導入しました。このバージョンでは、レスポンスが仮想RIDを含んで即座に返され、マージ操作はバックエンドでスケジュールされ、マージされたドキュメントを 仮想RIDに格納します。ユーザーはこの仮想RIDを使ってワークフローを進めることができます。スケジュールされたマージ操作が完了するまで、仮想RIDは一時的なコンテンツを提供します。
マージステータスを監視するには、レスポンスで生成される'merge_report_data_url'または'merge_report_url'を利用できます。
パラメーターとスコープは、 Merge and Store V1 API と同じです。'output_settings'パラメーター内に、Merge and Store V2 API用の追加オプショナルキー（merge_to）を提供しています。
本文パラメーター
| パラメーター | データの種類 | 説明 |
| Mandatory パラメーター | ||
| output_settings |
{ 'doc_name': '新しいドキュメント名', 'folder_id': 'フォルダID', 'output_format': 'pdf, docx形式', 'password': '<*****>', '既存のファイルに上書きする': 'true, false',
'マージ先':'個別のドキュメント, 一つのドキュメント
}
|
このパラメータを使用して、''doc_name' および 'folder_id'の値をJSON形式で渡します。 doc_name -> マージされたドキュメントの名前を定義します。 folder_id -> マージされたドキュメントを保存するフォルダのIDを指定します。 output_format (任意) -> 対応している形式はpdf、pdfformおよびdocxです。統合した文書を保存したい形式を選択してください。 このキーが次に示す値と等しくない場合、統合された文書はデフォルトでWriter形式のzdocに保存されます。 password (任意) -> 統合文書を保護するためにパスワードを設定してください。このパラメータはpdfおよびdocx文書にのみ適用されます。 overwrite_existing_file (任意) -> Zoho WorkDriveに保存されている既存のファイルを統合文書で置き換えたい場合はこのパラメータを使用してください。
merge_to (任意) -> 文書を統合したいタイプを指定してください。
separatedoc - 各記録を個別の文書として統合したい場合。 singledoc - すべての記録を単一の文書に統合したい場合。
メモ: デフォルトでは、separatedoc統合タイプを考慮します。
|
これ以外に、'HTTPリクエストURL'と'レスポンス構造'が変わります。詳細は以下の通りです：
HTTPリクエストURL
サンプルレスポンス:
{
'merge_report_data_url': '
',
'merge_report_url': '
',
'records': [
{
'data': [{“指定された入力 merge_data”}],
'download_link': '
',
'document_id': '
',
'document_url': '
',
'status': '進行中'
}
],
'status': '進行中'
}
「merge_report_data_url」を呼び出すと、下記のレスポンスが返されます;
// 'merge_to' = 'separatedoc'の場合
{
'records': [
{
'download_link': “{url}“,
'data': {
'name': “Amelia”,
},
'document_id': 'ponazfea04477109f4681a831e7177d96bc40',
'document_url': 'http://writer.zoho.com/writer/表示/ponazfea04477109f4681a831e7177d96bc40',
'status': '進行中'
},
{
'download_link': “{url}“,
'data': {
'name': “John”,
},
'document_id': 'ponazfea04477109f4681a831e7177d96bc40',
'document_url': 'http://writer.zoho.com/writer/表示/ponazfea04477109f4681a831e7177d96bc40',
'status': '進行中'
}
],
'status': '進行中'
}
// 'merge_to' = 'singledoc' の場合
{
'records': [
{
'download_link': “{url}“,
'data': [
{
'name': “Amelia”,
'email': “amelia@zylker.com”
},
{
'name': “John”,
}
],
'document_id': 'ponazfea04477109f4681a831e7177d96bc40',
'document_url': 'http://writer。zoho。com/writer/表示/ponazfea04477109f4681a831e7177d96bc40',
'status': '作業中'
}
],
'status': '作業中'
}
Delugeによるサンプルスニペット:
document_id = 'fbsa6360a78f53f564dfa9b4a1e79febed569';
fieldInfo = invokeurl
[
type: GET
connection: '
' '
];
fieldsList = fieldInfo.get('fields');
datamap = map();
for each field in fieldsList
{
info field;
}
datamap.put('名前', 'Ms. Amelia');
datamap.put('Tamil', 'S');
datamap.put('Japanese', 'A');
datamap.put('Maths', 'A');
datamap.put('Remark', 'Good');
outputsettings = Map();
outputsettings.put('doc_name','Student Grade');
outputsettings.put('folder_id','bsa6360a78f53f***'); //WorkdriveフォルダID //オプション
outputsettings.put('output_format','pdf'); //
//オプション
outputsettings.put('password','*****'); //オプション
outputsettings.put('overwrite_existing_file','true'); //
//オプション
param = map();
param.put('merge_data',{'data':datamap});
param.put('output_settings',outputsettings);
response = invokeurl
[
url: 'https://zohoapis.com/writer/api/v2/documents/fbsa6360a78f53f564dfa9b4a1e79febed569/merge/store'
type: POST
parameters: param
connection: '
' '
];
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
開発者API
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 ...Zoho Writer API で Postman Collection を設定する別の方法
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho Writer APIのPostman コレクション設定を完了するには、以下に示すようにJSONファイルをインポートしてください： Zoho Writer API コレクション JSONファイル Zoho Writer API 環境 JSONファイル Zoho Writer ...ライターでのMerge&SignおよびSign APIの前提条件
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 「Merge and Sign」または「Sign」APIを利用するには、まず「Automate」パネルへとアクセスしてください。これはWriter UIから行い、APIリクエストを送信する前に行う必要があります。 Writer ...Bulk Sign API で 'message_richtext' パラメーターでサポートされている HTML タグ
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Bulk Sign APIの'message_richtext' パラメータは、以下のHTMLタグをサポートしています： script noscript plaintext comment xmp iframe frameset frame label form button ...API/DREを介してマージフィールドタイプのデータを渡す方法は？
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 合併項目の利用可能なタイプに関する情報は、このヘルプ リンクをご覧ください。 各種類の合併項目の値をAPI経由でどのように渡すことができますか？ 値は'merge_data' パラメータ内のJSON形式で渡されます。 こちらがJSONのサンプルです： { 'data':[ { ...