Login
      目次 x
      テンプレートジェネレータ文書の作成 v2
        • 印刷する
        • PDF
        目次

        テンプレートジェネレータ文書の作成 v2

          • 印刷する
          • PDF
          Article Summary

          説明

          APIを利用し、テンプレートジェネレータで作成したテンプレートの文書を作成します。

          リクエスト URL 

          POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/fg/{dfmId}/doc

          リクエストヘッダ

          HeaderDescription
          x-ncp-apigw-timestamp
        • 1970年1月1日 00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの
        • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
          • x-ncp-iam-access-keyNAVERクラウドプラットフォームポータルまたは Sub Accountで発行された Access Key ID
          x-ncp-apigw-signature-v2
        • 上記例の Bodyを Access Key IDとマッピングする Secret Keyで暗号化した署名
        • HMACの暗号化アルゴリズムは HmacSHA256を使用

          • リクエストパスパラメータ

          パラメータタイプサイズ必須説明
          companyIdString36Y連携キー(CompanyId) Developers > 基本設定 > 連携キー
          dfmIdString36Yテンプレート ID



          リクエストボディパラメータ

          パラメータタイプサイズ必須説明
          titleString1000Y名前
          dfmIdString36Yテンプレート ID
          trgtCompanyIdString36Y申請者の会社 ID
          trgtExternalKeyString36Y申請者 ID - 外部キー - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          trgtUserIdString36Y申請者 WORKPLACE ID - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          trgtLoginIdString36Y申請者ログイン ID - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          trgtDeptExternalKeyString36Y申請者部署コード - 外部キー - WORKPLACEの部署コード、外部キーのうちいずれか1つは必須
          trgtDeptCdString36Y申請者部署コード - WORKPLACEの部署コード、外部キーのうちいずれか1つは必須
          proxyYnString1Y代理申請かどうか- デフォルト: N- 申請者と作成者が異なる場合、Yと入力して作成者情報を入力する。 申請者と作成者が同じである場合、Nに変更される- 以下の drftで始まる項目を作成
          drftCompanyIdString36N作成者の会社 ID
          drftExternalKeyString36N作成者 ID - 外部キー - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          drftUserIdString36N作成者 WORKPLACE ID - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          drftLoginIdString36N作成者ログイン ID - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          drftDeptExternalKeyString36N作成者部署コード - 外部キー - WORKPLACEの部署コード、外部キーのうちいずれか1つは必須
          drftDeptCdString36Y作成者部署コード - WORKPLACEの部署コード、外部キーのうちいずれか1つは必須
          aprvLineMngYnString1Y決裁ラインの管理の使用有無 - デフォルト: Y - 決裁ラインの管理に登録されている決裁ラインを使用- 決裁ラインの管理に上位部署長、直接入力、勤務地のマネージャのみ使用できる。 Reports Toは、全社員の reports toが1人の場合にのみ使用できる。
          aprvLineListListN決裁ライン - 決裁ラインの管理の使用有無が Nの場合、決裁ライン入力 - 決裁ラインがない場合、保存時にすぐに文書が完了する- 決裁ラインの詳細
          shreUsersMngYnString1Y共有者管理使用の有無 - デフォルト: Y - 共有者管理に登録されている共有者を使用、Nの場合は以下の shareに関する項目を確認してください。
          shreTpCdString20Y共有範囲コード - 共有者管理使用の有無が Nの場合、必須入力- allShre: 全体共有(共有対象コードが compの場合、全体共有と入力)- partShre: 一部共有(共有者がいない場合、一部共有と入力し、共有対象情報(shreUsersList)を作成しない)
          shreTimeTpCdString20Y共有時点 - 共有者管理使用の有無が Nの場合、必須入力- anyTime- cmpltTime
          shreUserListListN共有対象情報 - 共有者管理使用の有無が Nの場合、共有範囲: allShreであれば法人 IDを登録、partShreであれば共有者の有無に応じて登録 - 共有者の詳細
          dataListListYテンプレート本文を構成するコンポーネントデータ - コンポーネント dataListパラメータ



          決裁ラインの詳細

          パラメータタイプサイズ必須説明
          aprvOrdintY決裁の順序(1から)
          aprvParallelGrpintY決裁並列グループ(同じグループの場合、同じ値)(並列ではない場合には0)
          aprvParallelDtlGrpintY決裁並列グループ内のグループ順(並列ではない場合には0)
          aprvParallelDtlOrdintY決裁並列グループ内の順序(並列ではない場合には0)
          aprvTpCdString36Y決裁タイプコード- aprv 決裁- refer 参照- agree 合意- parallelAprv 並列決裁- parallelAgree 並列合意
          aprvCompanyIdString36Y決裁者の会社 ID
          aprvExternalKeyString36Y決裁者 ID - 外部キー - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          aprvUserIdString36Y決裁者 WORKPLACE ID - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          aprvLoginIdString36Y決裁者ログイン ID - WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          aprvDeptExternalKeyString50N決裁者部署コード - 外部キー - WORKPLACEの部署コード、外部キーのうちいずれか1つは必須
          aprvDeptCdString50N決裁者部署コード - WORKPLACEの部署コード、外部キーのうちいずれか1つは必須
          defaultYnString1N基本決裁ラインかどうか - Yの場合、ユーザーが決裁ラインを設定すると修正したり削除できない



          共有者の詳細

          パラメータタイプサイズ必須説明
          shreObjectTpCdString50Y共有対象コード- user 社員- comp 会社
          shreCompanyIdString36Y共有対象者の会社 ID- 共有対象コード: userの場合、共有者の所属会社 ID- 共有対象コード: compの場合、共有する会社 ID
          shreUserIdString36Y共有者の WORKPLACE ID- 共有対象コード: userの場合、WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          shreExternalKeyString36Y共有者の外部キー- 共有対象コード: userの場合、WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          shreLoginIdString36Y共有者のログイン ID- 共有対象コード: userの場合、WORKPLACEの社員 IDまたは外部キー、ログイン IDのうちいずれか1つは必須
          shreDeptExternalKeyString50Y共有者部署コード - 外部キー - 共有対象コード: userの場合、WORKPLACEの部署コード、外部キーのうちいずれか1つは必須
          shreDeptCdString50Y共有者部署コード - 共有対象コード: userの場合、WORKPLACEの部署コードまたは外部キーのうちいずれか1つは必須



          コンポーネント dataListパラメータ

          コンポーネントの UUIDは決裁 > テンプレートの照会 > テンプレートの詳細照会 APIで照会できる。

          1. 基本コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentValueString1000Yコンポーネント値

          サポートするコンポーネントの種類

          • [テキスト]コンポーネント(CP_TEXT)
          • [マルチテキスト]コンポーネント(CP_MULTI_TEXT)
          • [数字]コンポーネント(CP_NUMBER)
          • [スマートエディタ]コンポーネント(CP_EDITOR)
          • [自動出力テキスト]コンポーネント(CP_HIDDEN_TEXT)
          • [案内文]コンポーネント(CP_GUIDE)
          • [画像]コンポーネント(CP_IMG_STATIC)
          • [自動番号発行]コンポーネント(CP_AUTO_GENENUM)
          • [区分ライン]コンポーネント(CP_SECTION_LINE)
          参考
          • [案内文]コンポーネント
            • 「テンプレートジェネレータ > 案内文 > 詳細設定 > 出力内容設定」の値が自動で表示される。
          • [画像]コンポーネント
            • 「テンプレートジェネレータ > 画像 > 詳細設定 > 画像設定」に添付された画像が自動で表示される。
          • [自動番号発行]コンポーネント
            • 「テンプレートジェネレータ > 自動番号発行 > 詳細設定」に設定された番号が自動で表示される。
          • [区分ライン]コンポーネント
            • 区分ラインが自動で表示されます。
          参考
          • [自動出力テキスト]コンポーネント
            • 「テンプレートジェネレータ > 自動出力テキスト > 詳細設定 > API連携」オプションを選択した場合にのみ使用できる。
              • テンプレートジェネレータで提供される他のオプションは使用できない。
            • APIの呼び出し時に componentValue項目として入力されたテキストが保存され、画面上には表示されない。
            • このコンポーネントを利用して、画面上には表示されない「内部コード」情報を文書に挿入できる。

          2. テーブルコンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentHeaderString1000Yコンポーネントヘッダ
          componentBodyListYコンポーネントボディ
          componentHeaderタイプサイズ必須説明
          cellUuidString36Yヘッダセル UUID
          cellNameString36Yヘッダセル名
          cellTypeString36Yヘッダセルのデータタイプ
          componentBodyタイプサイズ必須説明
          cellUuidString36Yデータセル UUID
          cellValueString36Yデータセル値

          サポートするコンポーネントの種類

          • [テーブル]コンポーネント(CP_TABLE_FORM)

          3. 数式テーブルコンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentHeaderString1000Yコンポーネントヘッダ
          componentBodyListYコンポーネントボディ
          componentHeaderタイプサイズ必須説明
          cellUuidString36Yヘッダセル UUID
          cellNameString36Yヘッダセル名
          cellTypeString36Yヘッダセルのデータタイプ
          cellModeString36Yヘッダセルモード(data、calculation)
          componentBodyタイプサイズ必須説明
          cellUuidString36Yデータセル UUID
          cellValueString36Yデータセル値

          サポートするコンポーネントの種類

          • [数式テーブル]コンポーネント(CP_TABLE_FORM_CAL)
          参考
          • ヘッダセルモード(cellMode)
            • 基本的に dataを設定
            • 計算式列の場合、calculationを設定
          • 計算式列の場合、データセルの cellValueを入力しなくても構わない。 (内部で自動計算)

          4. ファイル添付コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentAttachFileListYコンポーネント値
          componentAttachFileタイプサイズ必須説明
          fileIdString36Y添付ファイル ID

          サポートするコンポーネントの種類

          • [ファイル添付]コンポーネント(CP_ATTACH_FILE)
          参考
          • fileIdを確認するには、共通 > 添付ファイル > アップロード APIを先に呼び出す必要がある。
          • ファイルのアップロードが成功しないと、ファイル添付コンポーネントは使用できない。

          5. 画像添付コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentImageFileListYコンポーネント値
          componentAttachFileタイプサイズ必須説明
          fileIdString36Y添付ファイル ID

          サポートするコンポーネントの種類。

          • [画像添付]コンポーネント(CP_IMG)
          参考
          • fileIdを確認するには、共通 > 添付ファイル > アップロード APIを先に呼び出す必要がある。
          • ファイルのアップロードが成功しないと、ファイル添付コンポーネントは使用できない。
          • 画像タイプのファイルのみ使用できる。

          6. Item選択が必要なコンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentSelectedItemListYコンポーネント値
          componentSelectedItemタイプサイズ必須説明
          selectedItemIdString36YItem UUID
          selectedItemNmString256YItem名

          サポートするコンポーネントの種類

          • [セレクトボックス]コンポーネント(CP_SELECTBOX)
          • [マルチセレクトボックス]コンポーネント(CP_MULTI_SELECTBOX)
          • [チェックボックス]コンポーネント(CP_CHECKBOX)
          • [ラジオボタン]コンポーネント(CP_RADIO)
          参考
          • 文書の作成時、Item名はテンプレートジェネレータに定義されている Textが表示される。
          • コンポーネントの種類とオプションに応じて、Item選択は1件になることも、複数件になることもある。
          参考
          • [セレクトボックス]コンポーネント
            • 「テンプレートジェネレータ > セレクトボックス > 詳細設定 > 連携コード」オプションを選択できる。
            • この場合、連携コードは、決裁管理 > 連携コードの管理画面で登録されている連携コードの[詳細コード]を確認して、その値を入れる。
            • 連携コードリストは、連携コード管理者の設定に応じてリアルタイムで変更される場合がある。

          7. 日付コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentDateValueObjectYコンポーネント値
          componentDateValueタイプサイズ必須説明
          dayString256Y日付(単一)
          startDayString256Y日付(範囲)の開始日
          endDayString256Y日付(範囲)の終了日

          サポートするコンポーネントの種類

          • [日付(単一)]コンポーネント(CP_DATE)
          • [日付(範囲)]コンポーネント(CP_RANGE_DATE)
          参考
          • 日付(単一)コンポーネント
            • パラメータとして day属性のみ使用できる。
          • 日付(範囲)コンポーネント
            • パラメータとして startDay、endDay属性のみ使用できる。
          • 日付データはフォーマットに従う。
            • <例> 2022.09.08

          8. 時間コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentTimeValueObjectYコンポーネント値
          componentTimeValueタイプサイズ必須説明
          timeString256Y時間(単一)
          startTimeString256Y時間(範囲)の開始時間
          endTimeString256Y時間(範囲)の終了時間

          サポートするコンポーネントの種類

          • [時間(単一)]コンポーネント(CP_TIME)
          • [時間(範囲)]コンポーネント(CP_RANGE_TIME)
          参考
          • 時間(単一)コンポーネント
            • パラメータとして time属性のみ使用できる。
          • 時間(範囲)コンポーネント
            • パラメータとして startTime、endTime属性のみ使用できる。
          • 時間データはフォーマットに従う。
            • <例> 15:00

          9. 住所コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentAddrValueObjectYコンポーネント値
          componentAddrValueタイプサイズ必須説明
          krPostString256Y郵便番号
          krAddr1String256Y住所
          krAddr2String256Y詳細な住所

          サポートするコンポーネントの種類

          • [住所]コンポーネント(CP_ADDR_KR)

          10. 関連文書コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentRelDocListYコンポーネント値
          componentRelDocタイプサイズ必須説明
          aprvDocIdString36Y決裁 ID
          docTypeString36Y文書の種類(一般文書: NM)

          サポートするコンポーネントの種類

          • [関連文書]コンポーネント(WCP_WP_DOC)
          参考
          • aprvDocIdを確認するには、決裁 > 文書リスト照会 APIを先に呼び出す必要がある。
          • 現在、一般文書のみサポートしている。

          11. 社員検索コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentEmpListYコンポーネント値
          componentEmpタイプサイズ必須説明
          empIdString36Y社員 ID

          サポートするコンポーネントの種類

          • [社員検索]コンポーネント(WCP_SEARCH_EMP)
          参考

          empIdを確認するには、メンバー > 社員照会 APIを先に呼び出す必要がある。

          12. 部署検索コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentDeptValueListYコンポーネント値
          componentDeptValueタイプサイズ必須説明
          allbooleanYすべてかどうか(すべて: true、デフォルト: false)
          deptListListY部署の情報
          deptListタイプサイズ必須説明
          deptNoString36Y部署 ID

          サポートするコンポーネントの種類

          • [部署検索]コンポーネント(WCP_SEARCH_DEPT)
          参考

          deptNoを確認するには、メンバー > 組織照会 APIを先に呼び出す必要がある。

          13. 通貨コンポーネント

          ITEMパラメータタイプサイズ必須説明
          componentUuidString36Yコンポーネント UUID
          componentCodeString36Yコンポーネント種類コード
          componentCurrencyValueListYコンポーネント値
          componentCurrencyValueタイプサイズ必須説明
          value36StringY通貨の値
          code36StringN通貨コード

          サポートするコンポーネントの種類

          • [通貨]コンポーネント(CP_CURRENCY)
          参考
          • テンプレートジェネレータで「通貨設定」オプションを使用する場合、「通貨コード」は無視される。 (テンプレート内で設定されている通貨コードを使用)
          • 「通貨を設定しない」オプションを使用する場合、「通貨コード」は必須である。
          • テンプレートジェネレータで「小数点の入力を許可」オプションを使用する場合、「通貨の値」は設定されている小数点以下の桁数を適用する。
          • 小数点を使用しない場合、通貨の値の入力
            • <例> 10000
          • 小数点を使用する場合、通貨の値の入力
            • <例> 10000.00



          レスポンス

          HTTPステータスコードで返され、ボディ情報として伝達する。

          HTTPステータスコードレスポンスメッセージ説明
          200OK一般的なリクエスト成功
          201Createdリソース作成成功に対するレスポンスコード
          400Bad Request一般的なリクエスト失敗に使用
          500Internal Server Error
        • 一般的なサーバエラーに対するレスポンスコード
        • 4XX番台のエラーコードは、クライアント側のエラーを示すために使用される
        • 5XX番台のエラーコードは、サーバ側のエラーを示すために使用される



          • レスポンスの詳細

          コンポーネント入力項目の整合性チェックを行った後、エラーに対してエラーコードとエラーメッセージが伝達される。

          エラーコードエラーメッセージ
          3000必須入力項目が入力されていない
          3001存在しないユーザー
          3002存在しない部署
          3003存在しないコンポーネント値
          3004テンプレートに存在するコンポーネント数と一致しない
          3005存在しないコンポーネント UUID
          3006存在しないコンポーネント属性
          3007入力可能な最大文字数超過
          3008コンポーネントの値は1のみ使用できる
          3009コンポーネントフォーマットが一致しない
          3010添付可能なファイルの最大数超過
          3011添付可能なファイルのサイズ超過
          3012既にアップロード済みのファイル
          3013許可されていないファイル拡張子
          3014複数選択できない
          3015全選択できない
          3016文書情報が一致しない
          3016文書情報が一致しない
          3017テーブルカラムデータが有効ではない
          3018API作成時の必須属性が設定されていない
          3999決裁内部でエラー発生

          レスポンス例 

          HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
    "dfmId": "7ba9b979-024f-4b09-8551-4e638dde0bae",
    "docId": "22541"
}



          サポートする言語コード

          ロケールコード説明
          ko_KR韓国語
          ja_JP日本語
          zh_CN中国語(簡体字)
          zh_TW中国語(繁体字)
          en_US英語



          サポートする通貨コード

          通貨コード説明
          KRW韓国ウォン
          USDアメリカドル
          CNY中国人民元
          JPY日本円
          TWD台湾ドル
          EUR欧州連合ユーロ
          GBPイギリスポンド
          AUDオーストラリアドル
          CADカナダドル
          NZDニュージーランドドル
          NOKノルウェークローネ
          DKKデンマーククローネ
          RUBロシアルーブル
          MYRマレーシアリンギット
          MXNメキシコ
          MNTモンゴル
          VNDベトナムドン
          BRLブラジル
          SARサウジアラビア
          SEKスウェーデン
          CHFスイス
          INRインド
          IDRインドネシア
          THBタイバーツ
          PHPフィリピンペソ
          HKD香港
          ILSイスラエル
          AEDアラブ首長国連邦ディルハム
          BDTバングラデシュ
          BHDバーレーン
          BNDブルネイ
          CZKチェコ
          EGPエジプト
          HUFハンガリー
          JODヨルダン
          KWDクウェート
          KZTカザフスタン
          PKRパキスタン
          PLNポーランド
          SGDシンガポール
          TRYトルコ
          ZAR南アフリカ共和国ランド
          この記事は役に立ちましたか?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout