ユーザー権限の文書リストの照会 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}/empdocs

リクエストヘッダ

ヘッダ名	説明
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) `Developers > 基本設定 > 連携キー`

リクエストパラメータ

パラメータ	タイプ	容量	必須の有無	説明
categoryId	String	20	N	カテゴリID
dfmId	String	20	N	テンプレートID
dfmTpCd	String	20	N	テンプレート区分コード
docStatCd	String	50	N	文書の状態コード
docNo	String	100	N	文書番号
docTitle	String	1000	N	文書の件名
zoneId	String	50	Y	検索期間基準ZoneId
startDt	String	10	Y	検索期間の開始日(YYYY-MM-DD)
endDt	String	10	Y	検索期間の終了日(YYYY-MM-DD)
dateType	String	20	N	期間の区分コード(、)
waitEmpId	String	36	N	決裁待機中の社員ID
ingEmpId	String	36	N	決裁する社員ID
prcsdEmpId	String	36	N	決裁済みの社員ID
drftEmpId	String	36	N	作成者ID
trgtEmpId	String	36	N	申請者ID
trgtDeptCd	String	36	N	申請者の部署コード
delYn	String	1	N	隠された文書の有無
approverDocYn	String	1	Y	処理者である文書を含むかどうか(approverDocYn、shareDocYnのどちらか必須)
shareDocYn	String	1	Y	共有された文書を含むかどうか(approverDocYn、shareDocYnのどちらか必須)
offset	long	9	N	オフセット行から表示
limit	int	9	Y	リミットの数だけ表示
locale	String	20	Y	検索データロケール
empExternalKey	String	100	Y	empExternalKey(empExternalKey、emailIdのどちらか必須)
emailId	String	100	Y	メールID(empExternalKey、emailIdのどちらか必須)

リクエスト例

GET https://workplace.apigw.ntruss.com/workflow/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/empdocs?companyId=fe5f8382-aae3-4746-8d6e-f9d0545c5a9b&startDt=2020-01-02&endDt=2020-10-02&locale=ko_KR&limit=10&zoneId=Asia/Seoul&approverDocYn=Y&emailId=green@naver.com

GET /workflow/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/empdocs
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=

レスポンスデータ

パラメータ	タイプ	容量	必須の有無	説明
resultCode	Long	36	Y	結果コード
resultMessage	Long	36	Y	結果メッセージ
totalElements	int		Y	全体データ件数
content	List		Y	データリスト
docId	> Long	20	Y	決裁文書ID
companyId	> String	36	N	会社ID
companyNm	> String	1000	N	会社名
categoryId	> String	20	N	カテゴリID
categoryNm	> String	1000	N	カテゴリ名
dfmId	> String	36	N	テンプレートID
dfmNm	> String	1000	N	テンプレート名
docNo	> String	100	N	文書番号
docStatCd	> String	50	Y	文書の状態コード
dfmTpCd	> String	50	Y	テンプレート区分コード
dfmTpNm	> String	1000	N	テンプレート区分名
docTitle	> String	1000	N	文書の件名
shreTimeTpCd	> String	50	N	共有時点コード
shreOpninCnt	> int		N	共有意見数
shreTpCd	> String	50	N	共有区分コード
drftEmpId	> String	36	N	作成者ID
drftEmpNm	> String	1000	N	作成者名
drftEmpStatCd	> String	50	N	作成者の状態コード
trgtEmpId	> String	36	N	申請者ID
trgtEmpNm	> String	1000	N	申請者名
trgtEmpStatCd	> String	50	N	申請者の状態コード
drftDt	> Date	50	N	作成日時
cmpltDt	> Date	50	N	完了(拒否)日時
delYn	> String	1	Y	非表示文書の有無
aprvLine	> List		N	決裁ライン
aprvOrd	>> int		N	決裁順序
aprvEmpId	>> String	36	N	決裁者ID
aprvEmpNm	>> String	1000	N	決裁者名
aprvEmpStatCd	>> String	50	N	決裁者の状態コード
aprvStatCd	>> String	50	N	決裁状態コード
aprvTpCd	>> String	50	N	決裁タイプコード
docUri	> String	1000	N	文書リンク

レスポンス例(正常)

{
  "resultCode": "OK",
  "resultMessage": null,
  "content": [
    {
      "aprvDocId": 30480,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "勤務",
      "dfmId": "D000000007",
      "dfmNm": "勤務結果申請",
      "docNo": "2020_TCS01_000177",
      "docStatCd": "cmplt",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "勤務結果申請 - 2020.09.25",
      "shreTimeTpCd": "anyTime",
      "shreOpninCnt": 0,
      "shreTpCd": "allShre",
      "drftEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "drftEmpNm": "書いた者",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "trgtEmpNm": "書いた者",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-25T02:26:57.000Z",
      "cmpltDt": "2020-09-25T02:26:58.000Z",
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": null,
          "aprvEmpId": null,
          "aprvEmpNm": "",
          "aprvEmpStatCd": null,
          "aprvStatCd": null,
          "aprvTpCd": null
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30480?at=NM"
    },
    {
      "aprvDocId": 30478,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000188",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "有休",
      "docTitle": "不在スケジュール(ko) - 有休0.187日 2020.09.29(1時間30分)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "ホン・ギルドン.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "ホン・ギルドン.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:45.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
          "aprvEmpNm": "書いた者",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "ing",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30478?at=NM"
    },
    {
      "aprvDocId": 30477,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000187",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "有休",
      "docTitle": "不在スケジュール(ko) - 有休0.125日 2020.09.28(1時間)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "ホン・ギルドン.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "ホン・ギルドン.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:33.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
          "aprvEmpNm": "書いた者",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "ing",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30477?at=NM"
    },
    {
      "aprvDocId": 30476,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000186",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "有休",
      "docTitle": "不在スケジュール(ko) - 有休0.062日 2020.09.25(30分)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "ホン・ギルドン.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "ホン・ギルドン.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:19.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
          "aprvEmpNm": "書いた者",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "ing",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30476?at=NM"
    },
    {
      "aprvDocId": 30474,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "勤務",
      "dfmId": "D000000009",
      "dfmNm": "勤務結果申請キャンセル",
      "docNo": "2020_TCC01_000054",
      "docStatCd": "ing",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "管理者によるホン・ギルドン勤務結果キャンセル",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "drftEmpNm": "書いた者",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "trgtEmpNm": "書いた者",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:07:30.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
          "aprvEmpNm": "ホン・ギルドン.ko",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "ing",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30474?at=NM"
    },
    {
      "aprvDocId": 30471,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000185",
      "docStatCd": "decline",
      "dfmTpCd": "002",
      "dfmTpNm": "出張",
      "docTitle": "不在スケジュール(ko) - 出張4日 2020.07.24～2020.07.27",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "ホン・ギルドン.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "ホン・ギルドン.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T09:08:10.000Z",
      "cmpltDt": "2020-09-24T09:14:03.000Z",
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
          "aprvEmpNm": "書いた者",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "decline",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30471?at=NM"
    },
    {
      "aprvDocId": 30468,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000184",
      "docStatCd": "decline",
      "dfmTpCd": "001",
      "dfmTpNm": "有休",
      "docTitle": "不在スケジュール(ko) - 有休0.25日 2020.09.24(2時間)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "ホン・ギルドン.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "ホン・ギルドン.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T08:42:27.000Z",
      "cmpltDt": "2020-09-24T08:55:53.000Z",
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
          "aprvEmpNm": "書いた者",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "decline",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30468?at=NM"
    },
    {
      "aprvDocId": 30467,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000183",
      "docStatCd": "decline",
      "dfmTpCd": "001",
      "dfmTpNm": "有休",
      "docTitle": "不在スケジュール(ko) - 有休0.125日 2020.09.23(1時間)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "ホン・ギルドン.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "ホン・ギルドン.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T08:41:49.000Z",
      "cmpltDt": "2020-09-24T08:45:29.000Z",
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
          "aprvEmpNm": "書いた者",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "decline",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30467?at=NM"
    },
    {
      "aprvDocId": 30466,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000182",
      "docStatCd": "decline",
      "dfmTpCd": "001",
      "dfmTpNm": "有休",
      "docTitle": "不在スケジュール(ko) - 有休2日2020.09.18(8時間) ~ 2020.09.21(8時間)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "ホン・ギルドン.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "ホン・ギルドン.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T08:35:05.000Z",
      "cmpltDt": "2020-09-24T08:37:03.000Z",
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": 1,
          "aprvEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
          "aprvEmpNm": "書いた者",
          "aprvEmpStatCd": "IN",
          "aprvStatCd": "decline",
          "aprvTpCd": "aprv"
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30466?at=NM"
    },
    {
      "aprvDocId": 30459,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "人事",
      "dfmId": "D000000001",
      "dfmNm": "不在スケジュール(ko)",
      "docNo": "2020_TIM01_000180",
      "docStatCd": "cmplt",
      "dfmTpCd": "001",
      "dfmTpNm": "有休",
      "docTitle": "不在スケジュール(def) - 有休0.125日 2020.10.08(1時間)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "drftEmpNm": "書いた者",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "trgtEmpNm": "書いた者",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T06:35:10.000Z",
      "cmpltDt": "2020-09-24T06:35:12.000Z",
      "delYn": "N",
      "aprvLine": [
        {
          "aprvOrd": null,
          "aprvEmpId": null,
          "aprvEmpNm": "",
          "aprvEmpStatCd": null,
          "aprvStatCd": null,
          "aprvTpCd": null
        }
      ],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30459?at=NM"
    }
  ],
  "totalElements": 317
}

レスポンス

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

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

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

What's Next

ユーザー権限による待機文書リストの照会 v1

説明
照会API
レスポンス

タグ

WORKPLACE