テンプレートジェネレータ文書の詳細照会 v2

説明

テンプレートジェネレータ文書の詳細内容を照会するための APIです。

照会 API

テンプレートジェネレータ文書の詳細内容を照会する。

リクエスト URL

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/doc/{aprvDocId}

リクエストヘッダ共通

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

リクエスト例

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/doc/39283

GET /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/doc/39283
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

レスポンスデータ

レスポンス詳細データ

共有対象リスト

共有意見リスト

決裁ラインリスト

受信先リスト

添付ファイルリスト

関連文書リスト

ボディ情報リスト

コンポーネント詳細項目値

CP_TEXT(テキストコンポーネント)

CP_EDITOR(スマートエディタコンポーネント)

CP_HIDDEN_TEXT(自動出力テキストコンポーネント)

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

CP_TABLE_FORM_CAL(数式テーブルコンポーネント)

レスポンスコードの説明

文書の状態コード

決裁タイプ

決裁者の在職状態

決裁処理状態

受信先の状態

レスポンス例

{
  "tenantId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
  "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
  "aprvDocId": "39283",
  "dfmId": "09161cb2-9516-46a7-bc16-fb1a4b0dbd52",
  "doc": {
    "tenantId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "companyNm": "[AA] test2",
    "companyI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "aprvDocId": "39283",
    "categoryId": "9561",
    "categoryNm": "テンプレートデータ確認用",
    "categoryI18nNames": {
      "ko_KR": "テンプレートデータ確認用",
      "en_US": "テンプレートデータ確認用",
      "ja_JP": "テンプレートデータ確認用",
      "zh_CN": "テンプレートデータ確認用",
      "zh_TW": ""
    },
    "dfmId": "09161cb2-9516-46a7-bc16-fb1a4b0dbd52",
    "dfmNm": "テンプレートサンプル",
    "dfmI18nNames": {
      "ko_KR": "テンプレートサンプル",
      "en_US": "テンプレートサンプル",
      "ja_JP": "テンプレートサンプル",
      "zh_CN": "テンプレートサンプル",
      "zh_TW": ""
    },
    "dfmVersion": "2",
    "docTitle": "テンプレートサンプル件名",
    "docNo": "2021-CUS00465-000002",
    "docStatCd": "ing",
    "docStatNm": "進行",
    "docStatI18nNames": {
      "ko_KR": "進行",
      "en_US": "In Progress",
      "ja_JP": "承認中",
      "zh_CN": "进行",
      "zh_TW": ""
    },
    "drftTzCd": "Pacific/Midway",
    "drftYmdhmsDt": "2021-12-02T15:03:52+09:00[Asia/Seoul]",
    "cmpltYmdhmsDt": null,
    "trgtCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "trgtCompanyNm": "[AA] test2",
    "trgtCompanyI18nNames": {
      "ko_KR": "[AA] test2",
      "en_US": "[AA] test2",
      "ja_JP": "[AA] test2",
      "zh_CN": "[AA] test2",
      "zh_TW": ""
    },
    "trgtExternalKey": null,
    "trgtUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "trgtLoginId": null,
    "trgtUserNm": "(AA)管理者",
    "trgtUserI18nNames": {
      "ko_KR": "(AA)管理者",
      "en_US": "(AA) Manager",
      "ja_JP": "(AA)管理者",
      "zh_CN": "(AA)管理者",
      "zh_TW": ""
    },
    "trgtDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "trgtDeptNm": "test",
    "trgtDeptI18nNames": {
      "ko_KR": "test",
      "en_US": "Hello test",
      "ja_JP": "Hello test",
      "zh_CN": "Hello test",
      "zh_TW": ""
    },
    "trgtJobCd": null,
    "trgtJobNm": "",
    "trgtJobI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "trgtPositCd": null,
    "trgtPositNm": "",
    "trgtPositI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "trgtUserStatCd": "IN",
    "trgtUserStatNm": "在職",
    "trgtUserStatI18nNames": {
      "zh_TW": "在職",
      "ko_KR": "在職",
      "en_US": "Work",
      "zh_CN": "在职",
      "ja_JP": "在職"
    },
    "proxyYn": "N",
    "drftCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "drftCompanyNm": "[AA] test2",
    "drftCompanyI18nNames": {
      "ko_KR": "[AA] test2",
      "en_US": "[AA] test2",
      "ja_JP": "[AA] test2",
      "zh_CN": "[AA] test2",
      "zh_TW": ""
    },
    "drftExternalKey": null,
    "drftUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "drftLoginId": null,
    "drftUserNm": "(AA)管理者",
    "drftUserI18nNames": {
      "ko_KR": "(AA)管理者",
      "en_US": "(AA) Manager",
      "ja_JP": "(AA)管理者",
      "zh_CN": "(AA)管理者",
      "zh_TW": ""
    },
    "drftDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "drftDeptNm": "test",
    "drftDeptI18nNames": {
      "ko_KR": "test",
      "en_US": "Hello test",
      "ja_JP": "Hello test",
      "zh_CN": "Hello test",
      "zh_TW": ""
    },
    "drftJobCd": null,
    "drftJobNm": "",
    "drftJobI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "drftPositCd": null,
    "drftPositNm": "",
    "drftPositI18nNames": {
      "ko_KR": "",
      "en_US": "",
      "ja_JP": "",
      "zh_CN": "",
      "zh_TW": ""
    },
    "drftUserStatCd": "IN",
    "drftUserStatNm": "在職",
    "drftUserStatI18nNames": {
      "zh_TW": "在職",
      "ko_KR": "在職",
      "en_US": "Work",
      "zh_CN": "在职",
      "ja_JP": "在職"
    },
    "delYn": "N"
  },
  "shre": [
    {
      "shreObjectTpCd": "user",
      "shreObjectTpNm": "ユーザー",
      "shreObjectTpI18nNames": {
        "ko_KR": "사용자",
        "en_US": "User",
        "ja_JP": "使用者",
        "zh_CN": "用户",
        "zh_TW": ""
      },
      "shreExternalKey": null,
      "shreObjectLoginId": null,
      "shreObjectId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "shreObjectNm": "木村名前",
      "shreObjectI18nNames": {
        "ko_KR": "木村名前",
        "en_US": "木村名前",
        "ja_JP": "木村名前",
        "zh_CN": "木村名前",
        "zh_TW": ""
      },
      "shreDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "shreDeptNm": "test",
      "shreDeptI18nNames": {
        "ko_KR": "test",
        "en_US": "Hello test",
        "ja_JP": "Hello test",
        "zh_CN": "Hello test",
        "zh_TW": ""
      },
      "shreJobCd": null,
      "shreJobNm": "",
      "shreJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shrePositCd": null,
      "shrePositNm": "",
      "shrePositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreUserStatCd": "IN",
      "shreUserStatNm": "在職",
      "shreUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "재직",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    },
    {
      "shreObjectTpCd": "user",
      "shreObjectTpNm": "ユーザー",
      "shreObjectTpI18nNames": {
        "ko_KR": "사용자",
        "en_US": "User",
        "ja_JP": "使用者",
        "zh_CN": "用户",
        "zh_TW": ""
      },
      "shreExternalKey": null,
      "shreObjectLoginId": null,
      "shreObjectId": "70cba748-40f8-4a02-9cd6-9510c044022d",
      "shreObjectNm": "ホン・ギルドン",
      "shreObjectI18nNames": {
        "ko_KR": "佐藤一郎",
        "en_US": "ホン・ギルドン",
        "ja_JP": "ホン・ギルドン",
        "zh_CN": "ホン・ギルドン",
        "zh_TW": ""
      },
      "shreDeptCd": "test2008000665",
      "shreDeptNm": "会計グループ",
      "shreDeptI18nNames": {
        "ko_KR": "会計グループ",
        "en_US": "会計グループ",
        "ja_JP": "会計グループ",
        "zh_CN": "会計グループ",
        "zh_TW": ""
      },
      "shreJobCd": null,
      "shreJobNm": "",
      "shreJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shrePositCd": null,
      "shrePositNm": "",
      "shrePositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreUserStatCd": "IN",
      "shreUserStatNm": "在職",
      "shreUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "在職",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    }
  ],
  "shreOpnion": [
    {
      "shreOpnionSeq": 1,
      "shreOpnionCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "shreOpnionCompanyNm": "[AA] test2",
      "shreOpnionCompanyI18nNames": {
        "ko_KR": "[AA] test2",
        "en_US": "[AA] test2",
        "ja_JP": "[AA] test2",
        "zh_CN": "[AA] test2",
        "zh_TW": ""
      },
      "shreOpnionExternalKey": null,
      "shreOpnionUserId": "96b02530-82de-41c8-8223-3055c74e705e",
      "shreOpnionLoginId": null,
      "shreOpnionUserNm": "(AA)管理者",
      "shreOpnionUserI18nNames": {
        "ko_KR": "(AA)管理者",
        "en_US": "(AA) Manager",
        "ja_JP": "(AA)管理者",
        "zh_CN": "(AA)管理者",
        "zh_TW": ""
      },
      "shreOpnionDeptNm": "test",
      "shreOpnionDeptI18nNames": {
        "ko_KR": "test",
        "en_US": "Hello test",
        "ja_JP": "Hello test",
        "zh_CN": "Hello test",
        "zh_TW": ""
      },
      "shreOpnionJobNm": "",
      "shreOpnionJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreOpnionPositNm": "",
      "shreOpnionPositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "shreOpnionUserStatCd": "IN",
      "shreOpnionUserStatNm": "在職",
      "shreOpnionUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "재직",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      },
      "shreOpnionCont": "共有意見です。",
      "shreOpnionYmdhmsDt": "2021-12-15T18:55:08+09:00[Asia/Seoul]"
    }
  ],
  "aprvLine": [
    {
      "aprvOrd": 1,
      "aprvParallelGrp": 0,
      "aprvParallelDtlGrp": 0,
      "aprvParallelDtlOrd": 0,
      "aprvCompanyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "aprvCompanyNm": "[AA] test2",
      "aprvCompanyI18nNames": {
        "ko_KR": "[AA] test2",
        "en_US": "[AA] test2",
        "ja_JP": "[AA] test2",
        "zh_CN": "[AA] test2",
        "zh_TW": ""
      },
      "aprvExternalKey": null,
      "aprvUserId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "aprvLoginId": null,
      "aprvUserNm": "木村名前",
      "aprvUserI18nNames": {
        "ko_KR": "木村名前",
        "en_US": "木村名前",
        "ja_JP": "木村名前",
        "zh_CN": "木村名前",
        "zh_TW": ""
      },
      "aprvDeptExternalKey": null,
      "aprvDeptCd": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
      "aprvDeptNm": "test",
      "aprvDeptI18nNames": {
        "ko_KR": "test",
        "en_US": "Hello test",
        "ja_JP": "Hello test",
        "zh_CN": "Hello test",
        "zh_TW": ""
      },
      "aprvJobCd": null,
      "aprvJobNm": "",
      "aprvJobI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "aprvPositCd": null,
      "aprvPositNm": "",
      "aprvPositI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "aprvUserStatCd": "IN",
      "aprvUserStatNm": "在職",
      "aprvUserStatI18nNames": {
        "zh_TW": "在職",
        "ko_KR": "在職",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      },
      "aprvStatCd": "ing",
      "aprvStatNm": "進行",
      "aprvStatI18nNames": {
        "ko_KR": "進行",
        "en_US": "Progress",
        "ja_JP": "実行",
        "zh_CN": "进行",
        "zh_TW": ""
      },
      "aprvTpCd": "aprv",
      "aprvTpNm": "決裁",
      "aprvTpCdI18nNames": {
        "ko_KR": "決裁",
        "en_US": "Approval",
        "ja_JP": "決裁",
        "zh_CN": "审批",
        "zh_TW": ""
      },
      "aprvYmdhms": null,
      "aprvOpnin": null,
      "defaultYn": "N",
      "postponeYn": "N"
    }
  ],
  "rcpt": [
  {
    "statusCd": "ORG_DOC_ING",
    "statusNm": "送信文書を進行中",
    "rcptAprvDocId": 0,
    "rcptAprvDocNo": null,
    "rcptAprvDocDrftYmdhms": null,
    "rcptAprvDocCmpltYmdhms": null,
    "rcptTypeCd": "EMP",
    "gatewayRcptEmp": {
      "empRcptExternalKey": null,
      "empRcptLoginId": null,
      "empRcptEmpId": "7185653f-c8cd-43bc-b4f0-712e7e61bbf2",
      "empRcptEmpNm": "韓国語",
      "empRcptEmpI18nNames": {
        "ko_KR": "韓国語",
        "en_US": "korean",
        "ja_JP": "korean",
        "zh_CN": "korean",
        "zh_TW": "korean"
      },
      "empRcptDeptExternalKey": null,
      "empRcptDeptCd": "null",
      "empRcptDeptNm": "サービスチーム",
      "empRcptDeptI18nNames": {
        "ko_KR": "サービスチーム",
        "en_US": "Service Team",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      }
    },
    "gatewayRcptDept": null
  },
  {
    "statusCd": "RCPT_WAIT",
    "statusNm": "受信待ち",
    "rcptAprvDocId": 0,
    "rcptAprvDocNo": null,
    "rcptAprvDocDrftYmdhms": null,
    "rcptAprvDocCmpltYmdhms": null,
    "rcptTypeCd": "DEPT",
    "gatewayRcptEmp": null,
    "gatewayRcptDept": {
      "deptRcptExternalKey": null,
      "deptRcptDeptCd": "cgv2008000661",
      "deptRcptDeptNm": "Developers Group",
      "deptRcptDeptI18nNames": {
        "ko_KR": "Developers Group",
        "en_US": "Developers Group",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "deptRcptIncludeSubDept": "Y",
      "inChargeUserExternalKey": null,
      "inChargeUserLoginId": null,
      "inChargeUserId": null,
      "inChargeUserNm": "",
      "inChargeUserI18nNames": {
        "ko_KR": "",
        "en_US": "",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      }
    }
  },
  {
    "statusCd": "RCPT_DOC_CMPLT",
    "statusNm": "受信文書完了",
    "rcptAprvDocId": 43227,
    "rcptAprvDocNo": "2022-RCV01-000043",
    "rcptAprvDocDrftYmdhms": "2022-11-09T18:09:05+09:00[Asia/Seoul]",
    "rcptAprvDocCmpltYmdhms": "2022-11-09T18:09:05+09:00[Asia/Seoul]",
    "rcptTypeCd": "DEPT",
    "gatewayRcptEmp": null,
    "gatewayRcptDept": {
      "deptRcptExternalKey": null,
      "deptRcptDeptCd": "mng202110000034",
      "deptRcptDeptNm": "韓国-管理室",
      "deptRcptDeptI18nNames": {
        "ko_KR": "韓国-管理室",
        "en_US": "管理室",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      },
      "deptRcptIncludeSubDept": "Y",
      "inChargeUserExternalKey": null,
      "inChargeUserLoginId": null,
      "inChargeUserId": "96b02530-82de-41c8-8223-3055c74e705e",
      "inChargeUserNm": "관리자",
      "inChargeUserI18nNames": {
        "ko_KR": "관리자",
        "en_US": "(Manager)管理者",
        "ja_JP": "",
        "zh_CN": "",
        "zh_TW": ""
      }
    }
  }
]
  "attachFile": [
    {
      "attachSeq": 1,
      "attachFileNm": "スクリーンショット2021-11-29午後 8.06.59.png",
      "attachFileSize": 184391
    }
  ],
  "relatedDoc": [
    {
      "relAprvSeq": 1,
      "relAprvDocId": "37768",
      "relAprvDocNo": "2021-TCP01-000038"
    }
  ],
  "docBody": [
    {
      "componentCode": "CP_TEXT",
      "componentName": "テキスト",
      "componentUuid": "71b76fd6-72d6-9994-7778-db119dab1993",
      "componentCustomId": "custom-uuid-001",
      "orderNum": 0,
      "label": "ID",
      "value": {
        "ver": 2,
        "value": "test_id"
      }
    }
  ]
}