Get documents as admin v1

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

This is the API to search approved documents that can be searched with admin permission.

Search API

It searches approved documents that can be searched with admin permission.

Request URL

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

Request header

Header name	Description
x-ncp-apigw-timestamp	- It indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. - If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued on the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with the access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`

Request path parameter

Parameter	Type	Size	Requirement status	Description
companyId	String	36	Y	Linkage key (CompanyId) `Developers > Basic settings > Linkage key`

Request parameter

Parameter	Type	Size	Requirement status	Description
categoryId	String	20	N	Category ID
dfmId	String	20	N	Form ID
dfmTpCd	String	20	N	Form type code
docStatCd	String	50	N	Document status code
docNo	String	100	N	Document number
docTitle	String	1000	N	Document title
zoneId	String	50	Y	ZoneId based on search period
startDt	String	10	Y	Search period start date (YYYY-MM-DD)
endDt	String	10	Y	Search period end date (YYYY-MM-DD)
dateType	String	20	N	Period type code (drft, cmplt)
waitEmpId	String	36	N	Approval pending employee ID
ingEmpId	String	36	N	Approval requesting employee ID
prcsdEmpId	String	36	N	Approval obtained employee ID
drftEmpId	String	36	N	Creator ID
trgtEmpId	String	36	N	Applicant ID
trgtDeptCd	String	36	N	Applicant department code
delYn	String	1	N	Hidden document status
approverDocYn	String	1	N	Inclusion status of document under my approval
shareDocYn	String	1	N	Inclusion status of document shared to me
offset	long	9	N	Display offset rows first
limit	int	9	Y	Display as many as the number of limits
locale	String	20	Y	Search data locale
empExternalKey	String	100	N	empExternalKey
emailId	String	100	N	email ID

Request example

GET https://workplace.apigw.ntruss.com/workflow/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/mngdocs

GET /workflow/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/mngdocs?companyId=fe5f8382-aae3-4746-8d6e-f9d0545c5a9b&startDt=2020-01-02&endDt=2020-10-02&locale=ko_KR&limit=10&zoneId=Asia/Seoul
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=

Response data

Parameter	Type	Size	Requirement status	Description
resultCode	Long	36	Y	Result code
resultMessage	Long	36	Y	Result message
totalElements	int		Y	Number of entire data
content	List		Y	Data list
aprvDocId	> Long	20	Y	Approval document ID
companyId	> String	36	N	Company ID
companyNm	> String	1000	N	Company name
categoryId	> String	20	N	Category ID
categoryNm	> String	1000	N	Category name
dfmId	> String	36	N	Form ID
dfmNm	> String	1000	N	Form name
docNo	> String	100	N	Document number
docStatCd	> String	50	Y	Document status code
dfmTpCd	> String	50	Y	Form type code
dfmTpNm	> String	1000	N	Form type name
docTitle	> String	1000	N	Document title
shreTimeTpCd	> String	50	N	Share time code
shreOpninCnt	> int		N	Number of shared comments
shreTpCd	> String	50	N	Share type code
drftEmpId	> String	36	N	Creator ID
drftEmpNm	> String	1000	N	Creator name
drftEmpStatCd	> String	50	N	Creator status code
trgtEmpId	> String	36	N	Applicant ID
trgtEmpNm	> String	1000	N	Applicant name
trgtEmpStatCd	> String	50	N	Applicant status code
drftDt	> Date	50	N	Creation date and time
cmpltDt	> Date	50	N	Invitation completion/rejection date and time
delYn	> String	1	Y	Hidden document status
aprvLine	> List		N	Approval line
aprvOrd	>> int		N	Approval order
aprvEmpId	>> String	36	N	Approver ID
aprvEmpNm	>> String	1000	N	Approver name
aprvEmpStatCd	>> String	50	N	Approver status code
aprvStatCd	>> String	50	N	Approval status code
aprvTpCd	>> String	50	N	Approval type code
docUri	> String	1000	N	Document link

Response example (normal)

{
  "resultCode": "OK",
  "resultMessage": null,
  "content": [
    {
      "aprvDocId": 30493,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2004",
      "categoryNm": "Basic",
      "dfmId": "D000000003",
      "dfmNm": "General (ko)",
      "docNo": "2020_GEN01_000041",
      "docStatCd": "cmplt",
      "dfmTpCd": "8",
      "dfmTpNm": "Recruitment plan",
      "docTitle": "sdf",
      "shreTimeTpCd": "anyTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "bee51313-5411-4a13-8850-a1db29dedf14",
      "drftEmpNm": "Sehun Lee (South Korea)",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "bee51313-5411-4a13-8850-a1db29dedf14",
      "trgtEmpNm": "Sehun Lee (South Korea)",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-25T03:07:22.000Z",
      "cmpltDt": "2020-09-25T03:07:23.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30493?at=WF"
    },
    {
      "aprvDocId": 30480,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "Work",
      "dfmId": "D000000007",
      "dfmNm": "Work result request",
      "docNo": "2020_TCS01_000177",
      "docStatCd": "cmplt",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "Work result request - September 25, 2020",
      "shreTimeTpCd": "anyTime",
      "shreOpninCnt": 0,
      "shreTpCd": "allShre",
      "drftEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "drftEmpNm": "Greeny",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "trgtEmpNm": "Greeny",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-25T02:26:57.000Z",
      "cmpltDt": "2020-09-25T02:26:58.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30480?at=WF"
    },
    {
      "aprvDocId": 30478,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "HR",
      "dfmId": "D000000001",
      "dfmNm": "Absence schedule (ko)",
      "docNo": "2020_TIM01_000188",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "Annual leave",
      "docTitle": "Absence schedule (ko) - 0.187 days of annual leave September 29, 2020 (1 hour 30 minutes)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "Gildong Hong.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "Gildong Hong.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:45.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30478?at=WF"
    },
    {
      "aprvDocId": 30477,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "HR",
      "dfmId": "D000000001",
      "dfmNm": "Absence schedule (ko)",
      "docNo": "2020_TIM01_000187",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "Annual leave",
      "docTitle": "Absence schedule (ko) - 0.125 days of annual leave September 28, 2020 (1 hour)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "Gildong Hong.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "Gildong Hong.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:33.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30477?at=WF"
    },
    {
      "aprvDocId": 30476,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "HR",
      "dfmId": "D000000001",
      "dfmNm": "Absence schedule (ko)",
      "docNo": "2020_TIM01_000186",
      "docStatCd": "ing",
      "dfmTpCd": "001",
      "dfmTpNm": "Annual leave",
      "docTitle": "Absence schedule (ko) - 0.062 days of annual leave September 25, 2020 (30 minutes)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "Gildong Hong.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "Gildong Hong.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:14:19.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30476?at=WF"
    },
    {
      "aprvDocId": 30474,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "Work",
      "dfmId": "D000000009",
      "dfmNm": "Cancel work result request",
      "docNo": "2020_TCC01_000054",
      "docStatCd": "ing",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "Work results of Gildong Hong.ko canceled by the admin",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "drftEmpNm": "Greeny",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "18a7cd5b-d5de-4601-8fbf-5b70e5368e44",
      "trgtEmpNm": "Greeny",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:07:30.000Z",
      "cmpltDt": null,
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30474?at=WF"
    },
    {
      "aprvDocId": 30473,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2006",
      "categoryNm": "Work",
      "dfmId": "D000000007",
      "dfmNm": "Work result request",
      "docNo": "2020_TCS01_000176",
      "docStatCd": "cmplt",
      "dfmTpCd": null,
      "dfmTpNm": "",
      "docTitle": "Work result request - September 24, 2020",
      "shreTimeTpCd": "anyTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "Gildong Hong.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "Gildong Hong.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T10:05:39.000Z",
      "cmpltDt": "2020-09-24T10:05:41.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30473?at=WF"
    },
    {
      "aprvDocId": 30471,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "HR",
      "dfmId": "D000000001",
      "dfmNm": "Absence schedule (ko)",
      "docNo": "2020_TIM01_000185",
      "docStatCd": "decline",
      "dfmTpCd": "002",
      "dfmTpNm": "Business trip",
      "docTitle": "Absence schedule (ko) - 4 days of business trip July 24, 2020 - July 27, 2020",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "Gildong Hong.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "Gildong Hong.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T09:08:10.000Z",
      "cmpltDt": "2020-09-24T09:14:03.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30471?at=WF"
    },
    {
      "aprvDocId": 30468,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "HR",
      "dfmId": "D000000001",
      "dfmNm": "Absence schedule (ko)",
      "docNo": "2020_TIM01_000184",
      "docStatCd": "decline",
      "dfmTpCd": "001",
      "dfmTpNm": "Annual leave",
      "docTitle": "Absence schedule (ko) - 0.25 days of annual leave September 24, 2020 (2 hours)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "Gildong Hong.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "Gildong Hong.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T08:42:27.000Z",
      "cmpltDt": "2020-09-24T08:55:53.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30468?at=WF"
    },
    {
      "aprvDocId": 30467,
      "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
      "companyNm": "ABC Corp.",
      "categoryId": "2005",
      "categoryNm": "HR",
      "dfmId": "D000000001",
      "dfmNm": "Absence schedule (ko)",
      "docNo": "2020_TIM01_000183",
      "docStatCd": "decline",
      "dfmTpCd": "001",
      "dfmTpNm": "Annual leave",
      "docTitle": "Absence schedule (ko) - 0.125 days of annual leave September 23, 2020 (1 hour)",
      "shreTimeTpCd": "cmpltTime",
      "shreOpninCnt": 0,
      "shreTpCd": "partShre",
      "drftEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "drftEmpNm": "Gildong Hong.ko",
      "drftEmpStatCd": "IN",
      "trgtEmpId": "b113e5e0-9833-4882-8b2d-68d1c1efe79b",
      "trgtEmpNm": "Gildong Hong.ko",
      "trgtEmpStatCd": "IN",
      "drftDt": "2020-09-24T08:41:49.000Z",
      "cmpltDt": "2020-09-24T08:45:29.000Z",
      "delYn": "N",
      "aprvLine": [],
      "docUri": "http://sample.ncpworkplace.com/user/view/doc/30467?at=WF"
    }
  ],
  "totalElements": 481
}

Response

Returned as an HTTP status code in the response body.

HTTP status code	Response message	Description
200	OK	General request made successfully
400	Bad Request	Use for failed general request Usually used to respond to a request format that the server can't understand 4XX error codes represent client-side errors.
401	Unauthorized	Authentication is required.
403	Forbidden	Server denied the request.
404	Not Found	The requested page wasn't found.
500	Internal Server Error	- Response code to general server errors 5xx error codes represent server-side errors.

Was this article helpful?

What's Next

Get documents as user v1

Table of contents

Description
Search API
Response