文書の詳細照会 v1

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

文書の詳細内容を照会するためのAPIです。

照会API

文書の詳細内容を照会する。

リクエストURL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行されたAccess Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値とSecret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`

リクエストPathパラメータ

パラメータ	タイプ	容量	必須の有無	説明
companyId	String	36	Y	連携キー(CompanyId)`の基本設定連携キー`
aprvDocId	String	36	Y	連携キー(AprvDocId)`照会対象文書ID - ユーザー権限の文書リストの照会とユーザー権限の文書リストの照会結果のaprvDocId利用`

リクエストパラメータ

パラメータ	タイプ	容量	必須の有無	説明

リクエスト例

GET https://workplace.apigw.ntruss.com/workflow/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/doc/39283
HOST: workplace.apigw.ntruss.com:443
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=

レスポンスデータ

パラメータ	タイプ	容量	必須の有無	説明
doc	Map		Y	文書情報
drftUserStatCd	> Map		Y	作成者の状態情報
code	>>String	36	Y	状態コード
name	>> String	100	N	状態名(default)
i18nNames	>> Map		N	状態名多言語
drftDeptCd	> String	36	Y	作成者の部署コード
aprvDocId	> String	20	Y	決裁文書ID
drftUserId	> String	36	Y	作成者ID
drftYmdhmsDt	> String	100	Y	起案日時
trgtUserNm	> String	150	Y	申請者名
docTitle	> String	1000	Y	文書の件名
trgtCompanyId	> String	36	Y	申請者の会社ID
drftCompanyNm	> String	150	Y	作成者の会社名
shreOpninCnt	> String	10	Y	共有意見数
drftCompanyId	> String	36	Y	作成者の会社ID
trgtJobNm	> String	150	N	申請者の職責名
drftJobNm	> String	150	N	作成者の職責名
trgtDeptNm	> String	150	N	申請者の部署名
companyNm	> String	150	N	文書の会社名
delYmdhmsDt	> String	100	N	非表示にした日時
dfmId	> String	36	Y	テンプレートID
trgtUserStat	> Map	36	Y	申請者の状態コード
code	>> String	36	Y	状態コード
name	>> String	150	Y	状態コード名
i18nNames	>> Map		N	状態名多言語
drftTzCd	> String	100	N	文書申込ZoneId
drftPositNm	> String	150	N	作成者の役職名
trgtPositCd	> String	150	N	申請者の役職コード
cmpltYmdhmsDt	> String	100	N	完了日時
shreTimeTpCd	> Map	100	N	共有設定時点
code	>> String	36	Y	コード
name	>> String	150	Y	コード名
i18nNames	>> Map		N	多言語
drftDeptNm	> String	150	N	作成者の部署名
drftUserNm	> String	150	N	作成者名
trgtDeptCd	> String	50	N	申請者の部署コード
modifiableYn	> String	1	N	文書修正の可不可
docNo	> String	36	Y	文書番号
trgtUserId	> String	36	Y	申請者ID
dfmTpCd	> String	36	N	共有詳細設定情報
dfmVersion	> String	9	Y	テンプレートバージョン
delYn	> String	1	Y	非表示の有無
trgtCompanyNm	> String	150	N	申請者の会社名
trgtJobCd	> String	150	N	申請者の職責コード
companyId	> String	36	Y	会社ID
delUserId	> String	36	Y	文書の状態コード
docStatCd	> Map		Y	文書の状態コード
code	>> String	36	Y	コード
name	>> String	150	Y	コード名
i18nNames	>> Map		N	多言語
proxyYn	> String	1	Y	代理申請の有無
commonDfmYn	> String	1	Y	共通テンプレートの有無
drftJobCd	> String	1	N	作成者の職責コード
tenantId	> String	36	Y	テナントID
dfmNm	> String	150	Y	テンプレート名
trgtPositNm	> String	150	N	申請者の役職名
category	> Map	150	Y	カテゴリ
code	>> String	36	Y	コード
name	>> String	150	Y	コード名
i18nNames	>> Map		N	多言語
drftPositCd	> String	36	Y	作成者の役職コード
aprvUseYn	> String	1	Y	決裁ライン使用の有無
shre	Map		Y	共有情報
shreUsersList	> List		N	共有対象情報
shrePositNm	>> String	150	N	共有対象の役職名(共有対象が社員の場合)
revisionSeq	>> String	10	N	履歴番号(1から始まる)
aprvDocId	>> String	20	N	決裁文書ID
shreJobCd	>> String	36	N	共有対象の職責コード(共有対象が社員の場合)
shreJobNm	>> String	150	N	共有対象の職責名(共有対象が社員の場合)
shreUserStatCd	>> String	36	N	共有対象者の状態コード
shreObjectId	>> String	36	N	共有対象ID
shrePositCd	>> String	36	N	共有対象の役職コード(共有対象が社員の場合)
shreDeptCd	>> String	36	N	共有対象の部署コード(共有対象が社員の場合)
shreObjectTpCd	>> Map		N	共有対象の区分コード
code	>>> String	36	N	コード
name	>>> String	150	N	コード名
i18nNames	>>> Map		N	多言語
shreObjectNm	>> String	150	N	共有対象名
shreDeptNm	>> String	150	N	共有対象の部署名(共有対象が社員の場合)
shreTpCd	> Nap	36	Y	共有時点
code	>> String	36	Y	コード
name	>> String	150	Y	コード名
i18nNames	>> Map		Y	多言語
aprvLineList	List		N	決裁ライン
aprvDeptNm	> String	150	N	決裁者の部署名
aprvUserStatCd	> Map		N	決裁者の状態
code	>> String	36	N	コード
name	>> String	150	N	コード名
i18nNames	>> Map		N	多言語
defaultYn	> String	1	N	基本決裁ラインかどうか
delegUserNm	> String	150	N	委任処理した社員名(自動委任された場合を除く)
aprvUserNm	> String	150	N	決裁者名
aprvPositNm	> String	150	N	決裁者の役職名
aprvDocId	> String	20	N	決裁文書ID
aprvObjectTpNm	> String	150	N	決裁対象区分名
aprvCompanyId	> String	36	N	決裁者の会社ID
aprvJobCd	> String	36	N	決裁者の職責コード
aprvObjectId	> String	36	N	決裁対象
aprvUserId	> String	36	N	決裁者ID
aprvPositCd	> String	36	N	決裁者の役職コード
aprvCompanyNm	> String	150	N	決裁者の会社名
revisionSeq	> String	10	N	履歴番号(1から始まる)
aprvObjectTpCd	> Map		N	決裁対象区分コード
code	>> String	36	N	コード
name	>> String	150	N	コード名
i18nNames	>> Map		N	多言語
delegUserId	> String	36	N	委任処理した社員ID(自動委任された場合を除く)
rptToYn	> String	1	N	Reports Toの有無
aprvTpCd	> Map		N	決裁タイプコード
code	>> String	36	N	コード
name	>> String	150	N	コード名
i18nNames	>> Map		N	多言語
aprvDeptCd	> String	36	N	決裁者の部署コード
aprvJobNm	> String	150	N	決裁者の職責名
aprvStatCd	> Map		N	決裁状態コード
code	>> String	36	N	コード
name	>> String	150	N	コード名
i18nNames	>> Map		N	多言語
aprvOrd	> String	9	N	決裁の順番(1から始まる)
rptUserId	> String	36	N	Reportee ID
aprvOpnin	> String	1000	N	処理意見
aprvYmdhmsDt	> String	100	N	処理日時
info	Map		Y	決裁文書の内容
tenantId	> String	36	Y	テナントID
companyId	> String	36	Y	会社ID
aprvId	> String	36	Y	文書ID
empId	> String	36	Y	申請者ID
aprvDt	> String	10	Y	申請対象日時
docNo	> String	100	Y	文書番号
title	> String	1000	Y	文書の件名
content	> String	4000	N	内容
docStat	> Map		Y	進捗状況
code	>> String	36	N	コード
name	>> String	150	N	コード名
i18nNames	>> Map		N	多言語
detailList	> List		Y	勤務計画申請時間リスト
startDt	>> String	100	Y	申請開始時刻
endDt	>> String	100	Y	申請終了時刻

レスポンス例

{
"doc": {
    "drftUserStat": {
      "code": "IN",
      "name": "在職",
      "i18nNames": {
        "zh_TW": "在職",
        "ko_KR": "재직",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    },
    "drftDeptCd": "abc002",
    "aprvDocId": 25675,
    "drftUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "drftYmdhmsDt": "2020-03-19T10:07:26+09:00[Asia/Seoul]",
    "trgtUserNm": "ホン・ギルドン",
    "docTitle": "不在スケジュールを共有します。",
    "trgtCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "drftCompanyNm": "ABC Corporation",
    "shreOpninCnt": 0,
    "drftCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "trgtJobNm": "",
    "drftJobNm": "",
    "trgtDeptNm": "企画チーム",
    "companyNm": null,
    "delYmdhmsDt": null,
    "dfmId": "D000000001",
    "trgtUserStat": {
      "code": "IN",
      "name": "在職",
      "i18nNames": {
        "zh_TW": "在職",
        "ko_KR": "재직",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    },
    "drftTzCd": "Pacific/Midway",
    "drftPositNm": "",
    "trgtPositCd": null,
    "cmpltYmdhmsDt": null,
    "shreTimeTpCd": {
      "code": "anyTime",
      "name": "文書作成から継続して共有",
      "i18nNames": {
        "zh_TW": "從編寫文件起持續分享",
        "ko_KR": "文書作成から継続して共有",
        "en_US": "Share from document creation",
        "zh_CN": "从编写文件起持续共享",
        "ja_JP": "文書作成から継続して共有"
      }
    },
    "drftDeptNm": "企画チーム",
    "drftUserNm": "ホン・ギルドン",
    "trgtDeptCd": "abc002",
    "modifiableYn": "Y",
    "docNo": "2020-TIM01-000060",
    "trgtUserId": "96b02530-82de-41c8-8223-3055c74e705e",
    "dfmTpCd": null,
    "dfmVersion": null,
    "delYn": "N",
    "trgtCompanyNm": "ABC Corporation",
    "trgtJobCd": null,
    "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "delUserId": null,
    "docStatCd": {
      "code": "ing",
      "name": "進行中",
      "i18nNames": {
        "zh_TW": "進行",
        "ko_KR": "진행중",
        "en_US": "Ongoing",
        "zh_CN": "进行",
        "ja_JP": "実行"
      }
    },
    "proxyYn": "N",
    "commonDfmYn": "Y",
    "drftJobCd": null,
    "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "dfmNm": "不在スケジュール(ko)",
    "trgtPositNm": "",
    "category": {
      "code": "1973",
      "name": "人事",
      "i18nNames": {
        "ko_KR": "인사",
        "en_US": "HR",
        "ja_JP": "인사",
        "zh_CN": "인사",
        "zh_TW": "인사"
      }
    },
    "drftPositCd": null,
    "aprvUseYn": "Y"
  },


  "shre": {
    "shreUsersList": [
      {
        "shrePositNm": "",
        "revisionSeq": 1,
        "aprvDocId": 25675,
        "shreJobCd": null,
        "shreJobNm": "",
        "shreUserStatCd": "IN",
        "shreObjectId": "f649075b-f196-4599-a71e-3b3fde723b6f",
        "shrePositCd": null,
        "shreDeptCd": "abc002",
        "shreObjectTpCd": {
          "code": "user",
          "name": "ユーザー",
          "i18nNames": {
            "zh_TW": "使用者",
            "ko_KR": "사용자",
            "en_US": "User",
            "zh_CN": "用户",
            "ja_JP": "使用者"
          }
        },
        "shreObjectNm": "2019年入社",
        "shreDeptNm": "企画チーム"
      },
      {
        "shrePositNm": "",
        "revisionSeq": 1,
        "aprvDocId": 25675,
        "shreJobCd": null,
        "shreJobNm": "",
        "shreUserStatCd": "IN",
        "shreObjectId": "59a674bb-24f5-471f-a066-1d7ed8af8e04",
        "shrePositCd": null,
        "shreDeptCd": "abc002",
        "shreObjectTpCd": {
          "code": "user",
          "name": "ユーザー",
          "i18nNames": {
            "zh_TW": "使用者",
            "ko_KR": "사용자",
            "en_US": "User",
            "zh_CN": "用户",
            "ja_JP": "使用者"
          }
        },
        "shreObjectNm": "2016年入社",
        "shreDeptNm": "企画チーム"
      }
    ],
    "shreTpCd": {
      "code": "partShre",
      "name": "一部共有",
      "i18nNames": {
        "zh_TW": "部分分享",
        "ko_KR": "일부 공유",
        "en_US": "Share to Selected",
        "zh_CN": "部分共享",
        "ja_JP": "一部共有"
      }
    }
  },
   "aprvLineList": [
    {
      "aprvDeptNm": "ABC Corp",
      "aprvUserStatCd": {
        "code": "IN",
        "name": "在職",
        "i18nNames": {
          "zh_TW": "在職",
          "ko_KR": "재직",
          "en_US": "Work",
          "zh_CN": "在职",
          "ja_JP": "在職"
        }
      },
      "defaultYn": "N",
      "delegUserNm": "",
      "aprvUserNm": "パク・ミョンシク",
      "aprvPositNm": "",
      "aprvPositCd": null,
      "aprvDocId": 25675,
      "aprvObjectTpNm": null,
      "aprvCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
      "aprvJobCd": null,
      "aprvObjectId": null,
      "aprvUserId": "05fa1156-4b48-479a-bceb-b8a458746dca",
      "aprvCompanyNm": "ABC Corporation",
      "revisionSeq": 3,
      "aprvObjectTpCd": {
        "code": "user",
        "name": "ユーザー",
        "i18nNames": {
          "zh_TW": "使用者",
          "ko_KR": "사용자",
          "en_US": "User",
          "zh_CN": "用户",
          "ja_JP": "使用者"
        }
      },
      "delegUserId": null,
      "rptToYn": "N",
      "aprvTpCd": {
        "code": "refer",
        "name": "参照",
        "i18nNames": {
          "zh_TW": "參照",
          "ko_KR": "참조",
          "en_US": "Reference",
          "zh_CN": "参照",
          "ja_JP": "参照"
        }
      },
      "aprvDeptCd": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
      "aprvJobNm": "",
      "aprvStatCd": {
        "code": "cmplt",
        "name": "同意",
        "i18nNames": {
          "zh_TW": "核准",
          "ko_KR": "동의",
          "en_US": "Approve",
          "zh_CN": "审批",
          "ja_JP": "承認"
        }
      },
      "aprvOrd": 1,
      "rptUserId": null,
      "aprvOpnin": null,
      "aprvYmdhmsDt": "2020-03-19T10:07:33+09:00[Asia/Seoul]"
    }
  ],
  "info": {
    "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "aprvId": "23270",
    "empId": "96b02530-82de-41c8-8223-3055c74e705e",
    "aprvDt": "2019-11-14",
    "docNo": "2019-TCP01-000183",
    "title": "勤務計画申請 - 2019.11.14",
    "content": "ddddd",
    "msg": null,
    "docStat": {
      "code": "cmplt",
      "name": "同意",
      "i18nNames": {
        "zh_TW": "核准",
        "ko_KR": "동의",
        "en_US": "Approve",
        "zh_CN": "审批",
        "ja_JP": "承認"
      }
    },
    "detailList": [
      {
        "startDt": "2019-11-14T10:00-11:00[Pacific/Midway]",
        "endDt": "2019-11-14T12:00-11:00[Pacific/Midway]"
      }
    ]
  }
}

レスポンス

HTTPステータスコードでリターンされ、Body情報として伝達する。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエストの成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんどの場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
401	Unauthorized	認証が必要
403	Forbidden	サーバのリクエスト拒否
404	Not Found	リクエストしたページが見つからない
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード 4XX台のエラーコードがクライアント側のエラーを表示するために使用されるとすれば、 5XX台のエラーコードはサーバ側のエラーを表示するために使用

この記事は役に立ちましたか?

What's Next

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

説明
照会API
レスポンス

タグ

WORKPLACE