Searching document details v1

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

This is the API to search document details.

Search API

It searches document details.

Request URL

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

Request header

Header name	Description
x-ncp-apigw-timestamp	It indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds, and 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	This is the signature encrypted 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)`Linkage key for the basic settings`
aprvDocId	String	36	Y	Linkage key (AprvDocId)`Search target document ID - It gets documents as user and uses aprvDocId of the result from the documents obtained.`

Request parameter

Parameter	Type	Size	Requirement status	Description

Request example

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=

Response data

Parameter	Type	Size	Requirement status	Description
doc	Map		Y	Document information
drftUserStatCd	> Map		Y	Creator status information
code	>>String	36	Y	Status code
name	>> String	100	N	Status name (default)
i18nNames	>> Map		N	Status name of multiple language
drftDeptCd	> String	36	Y	Creator department code
aprvDocId	> String	20	Y	Approval document ID
drftUserId	> String	36	Y	Creator ID
drftYmdhmsDt	> String	100	Y	Proposal date and time
trgtUserNm	> String	150	Y	Applicant name
docTitle	> String	1000	Y	Document title
trgtCompanyId	> String	36	Y	Applicant company ID
drftCompanyNm	> String	150	Y	Creator company name
shreOpninCnt	> String	10	Y	Number of shared comments
drftCompanyId	> String	36	Y	Creator company ID
trgtJobNm	> String	150	N	Applicant position name
drftJobNm	> String	150	N	Creator position name
trgtDeptNm	> String	150	N	Applicant department name
companyNm	> String	150	N	Document company name
delYmdhmsDt	> String	100	N	Hiding date and time
dfmId	> String	36	Y	Form ID
trgtUserStat	> Map	36	Y	Applicant status code
code	>> String	36	Y	Status code
name	>> String	150	Y	Status code name
i18nNames	>> Map		N	Status name of multiple language
drftTzCd	> String	100	N	Document application Zone ID
drftPositNm	> String	150	N	Creator job grade name
trgtPositCd	> String	150	N	Applicant job grade code
cmpltYmdhmsDt	> String	100	N	Completion date and time
shreTimeTpCd	> Map	100	N	Sharing settings date and time
code	>> String	36	Y	Code
name	>> String	150	Y	Code name
i18nNames	>> Map		N	Multiple language
drftDeptNm	> String	150	N	Creator department name
drftUserNm	> String	150	N	Creator name
trgtDeptCd	> String	50	N	Applicant department code
modifiableYn	> String	1	N	Document editable status
docNo	> String	36	Y	Document number
trgtUserId	> String	36	Y	Applicant ID
dfmTpCd	> String	36	N	Information of detailed sharing settings
dfmVersion	> String	9	Y	Form version
delYn	> String	1	Y	Hide status
trgtCompanyNm	> String	150	N	Applicant company name
trgtJobCd	> String	150	N	Applicant position code
companyId	> String	36	Y	Company ID
delUserId	> String	36	Y	Document status code
docStatCd	> Map		Y	Document status code
code	>> String	36	Y	Code
name	>> String	150	Y	Code name
i18nNames	>> Map		N	Multiple language
proxyYn	> String	1	Y	Proxy application status
commonDfmYn	> String	1	Y	Common form status
drftJobCd	> String	1	N	Creator position code
tenantId	> String	36	Y	Tenant ID
dfmNm	> String	150	Y	Form name
trgtPositNm	> String	150	N	Applicant job grade name
category	> Map	150	Y	Category
code	>> String	36	Y	Code
name	>> String	150	Y	Code name
i18nNames	>> Map		N	Multiple language
drftPositCd	> String	36	Y	Creator job grade code
aprvUseYn	> String	1	Y	Approval line use status
shre	Map		Y	Shared information
shreUsersList	> List		N	Information to be shared
shrePositNm	>> String	150	N	Job grade name to be shared (if the sharing target is an employee)
revisionSeq	>> String	10	N	History number (default: 1)
aprvDocId	>> String	20	N	Approval document ID
shreJobCd	>> String	36	N	Position code to be shared (if the sharing target is an employee)
shreJobNm	>> String	150	N	Position name to be shared (if the sharing target is an employee)
shreUserStatCd	>> String	36	N	Status code of a person to share with
shreObjectId	>> String	36	N	Sharing target ID
shrePositCd	>> String	36	N	Job grade code to be shared (if the sharing target is an employee)
shreDeptCd	>> String	36	N	Department code to be shared (if the sharing target is an employee)
shreObjectTpCd	>> Map		N	Type code to be shared
code	>>> String	36	N	Code
name	>>> String	150	N	Code name
i18nNames	>>> Map		N	Multiple language
shreObjectNm	>> String	150	N	Name to be shared
shreDeptNm	>> String	150	N	Department name to be shared (if the sharing target is an employee)
shreTpCd	> Nap	36	Y	Share time
code	>> String	36	Y	Code
name	>> String	150	Y	Code name
i18nNames	>> Map		Y	Multiple language
aprvLineList	List		N	Approval line
aprvDeptNm	> String	150	N	Approver department name
aprvUserStatCd	> Map		N	Approver status
code	>> String	36	N	Code
name	>> String	150	N	Code name
i18nNames	>> Map		N	Multiple language
defaultYn	> String	1	N	Default approval line status
delegUserNm	> String	150	N	Delegated employee name (exclude if automatically delegated)
aprvUserNm	> String	150	N	Approver name
aprvPositNm	> String	150	N	Approver job grade name
aprvDocId	> String	20	N	Approval document ID
aprvObjectTpNm	> String	150	N	Type name to be approved
aprvCompanyId	> String	36	N	Approver company ID
aprvJobCd	> String	36	N	Approver position code
aprvObjectId	> String	36	N	Approval target
aprvUserId	> String	36	N	Approver ID
aprvPositCd	> String	36	N	Approver job grade code
aprvCompanyNm	> String	150	N	Approver company name
revisionSeq	> String	10	N	History number (default: 1)
aprvObjectTpCd	> Map		N	Type code to be approved
code	>> String	36	N	Code
name	>> String	150	N	Code name
i18nNames	>> Map		N	Multiple language
delegUserId	> String	36	N	Delegated employee ID (exclude if automatically delegated)
rptToYn	> String	1	N	Reports To status
aprvTpCd	> Map		N	Approval type code
code	>> String	36	N	Code
name	>> String	150	N	Code name
i18nNames	>> Map		N	Multiple language
aprvDeptCd	> String	36	N	Approver department code
aprvJobNm	> String	150	N	Approver position name
aprvStatCd	> Map		N	Approval status code
code	>> String	36	N	Code
name	>> String	150	N	Code name
i18nNames	>> Map		N	Multiple language
aprvOrd	> String	9	N	Approval order (default: 1)
rptUserId	> String	36	N	Reportee ID
aprvOpnin	> String	1000	N	Comment
aprvYmdhmsDt	> String	100	N	Process date and time
info	Map		Y	Approval document history
tenantId	> String	36	Y	Tenant ID
companyId	> String	36	Y	Company ID
aprvId	> String	36	Y	Document ID
empId	> String	36	Y	Applicant ID
aprvDt	> String	10	Y	Date to be applied for
docNo	> String	100	Y	Document number
title	> String	1000	Y	Document title
content	> String	4000	N	Content
docStat	> Map		Y	Progress status
code	>> String	36	N	Code
name	>> String	150	N	Code name
i18nNames	>> Map		N	Multiple language
detailList	> List		Y	List of work plan request times
startDt	>> String	100	Y	Application start time
endDt	>> String	100	Y	Application end time

Response example

{
"doc": {
    "drftUserStat": {
      "code": "IN",
      "name": "Employment",
      "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": "Gildong Hong",
    "docTitle": "Sharing absence schedule",
    "trgtCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "drftCompanyNm": "ABC Corporation",
    "shreOpninCnt": 0,
    "drftCompanyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
    "trgtJobNm": "",
    "drftJobNm": "",
    "trgtDeptNm": "Planning team",
    "companyNm": null,
    "delYmdhmsDt": null,
    "dfmId": "D000000001",
    "trgtUserStat": {
      "code": "IN",
      "name": "Employment",
      "i18nNames": {
        "zh_TW": "在職",
        "ko_KR": "재직",
        "en_US": "Work",
        "zh_CN": "在职",
        "ja_JP": "在職"
      }
    },
    "drftTzCd": "Pacific/Midway",
    "drftPositNm": "",
    "trgtPositCd": null,
    "cmpltYmdhmsDt": null,
    "shreTimeTpCd": {
      "code": "anyTime",
      "name": "Share constantly from creation",
      "i18nNames": {
        "zh_TW": "從編寫文件起持續分享",
        "ko_KR": "Share constantly from creation",
        "en_US": "Share from document creation",
        "zh_CN": "从编写文件起持续共享",
        "ja_JP": "文書作成から継続して共有"
      }
    },
    "drftDeptNm": "Planning team",
    "drftUserNm": "Gildong Hong",
    "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": "In progress",
      "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": "Absence schedule (ko)",
    "trgtPositNm": "",
    "category": {
      "code": "1973",
      "name": "HR",
      "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": "User",
          "i18nNames": {
            "zh_TW": "使用者",
            "ko_KR": "사용자",
            "en_US": "User",
            "zh_CN": "用户",
            "ja_JP": "使用者"
          }
        },
        "shreObjectNm": "Joined in 2019",
        "shreDeptNm": "Planning team"
      },
      {
        "shrePositNm": "",
        "revisionSeq": 1,
        "aprvDocId": 25675,
        "shreJobCd": null,
        "shreJobNm": "",
        "shreUserStatCd": "IN",
        "shreObjectId": "59a674bb-24f5-471f-a066-1d7ed8af8e04",
        "shrePositCd": null,
        "shreDeptCd": "abc002",
        "shreObjectTpCd": {
          "code": "user",
          "name": "User",
          "i18nNames": {
            "zh_TW": "使用者",
            "ko_KR": "사용자",
            "en_US": "User",
            "zh_CN": "用户",
            "ja_JP": "使用者"
          }
        },
        "shreObjectNm": "Joined in 2016",
        "shreDeptNm": "Planning team"
      }
    ],
    "shreTpCd": {
      "code": "partShre",
      "name": "Shared to selected",
      "i18nNames": {
        "zh_TW": "部分分享",
        "ko_KR": "일부 공유",
        "en_US": "Share to Selected",
        "zh_CN": "部分共享",
        "ja_JP": "一部共有"
      }
    }
  },
   "aprvLineList": [
    {
      "aprvDeptNm": "ABC Corp",
      "aprvUserStatCd": {
        "code": "IN",
        "name": "Employment",
        "i18nNames": {
          "zh_TW": "在職",
          "ko_KR": "재직",
          "en_US": "Work",
          "zh_CN": "在职",
          "ja_JP": "在職"
        }
      },
      "defaultYn": "N",
      "delegUserNm": "",
      "aprvUserNm": "Myeongsik Park",
      "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": "User",
        "i18nNames": {
          "zh_TW": "使用者",
          "ko_KR": "사용자",
          "en_US": "User",
          "zh_CN": "用户",
          "ja_JP": "使用者"
        }
      },
      "delegUserId": null,
      "rptToYn": "N",
      "aprvTpCd": {
        "code": "refer",
        "name": "Reference",
        "i18nNames": {
          "zh_TW": "參照",
          "ko_KR": "참조",
          "en_US": "Reference",
          "zh_CN": "参照",
          "ja_JP": "参照"
        }
      },
      "aprvDeptCd": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
      "aprvJobNm": "",
      "aprvStatCd": {
        "code": "cmplt",
        "name": "Agreement",
        "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": "Work plan request - November 14, 2019",
    "content": "ddddd",
    "msg": null,
    "docStat": {
      "code": "cmplt",
      "name": "Agreement",
      "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]"
      }
    ]
  }
}

Response

Returned as HTTP status code in the response body.

HTTP status code	Response message	Description
200	OK	General request made successfully
400	Bad Request	Used for failed request in general (usually used to respond to a request format that the server can't understand.)
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 While 4XX error codes represent client-side errors, 5XX error codes represent server-side errors.

Was this article helpful?

What's Next

Compose Document Using Form Generator v2

Table of contents

Description
Search API
Response