{"id":11956,"date":"2019-10-22T15:52:10","date_gmt":"2019-10-22T06:52:10","guid":{"rendered":"https:\/\/www.eformsign.com\/kr\/support\/?post_type=manual_documentation&#038;p=11956"},"modified":"2019-11-27T10:40:22","modified_gmt":"2019-11-27T01:40:22","slug":"lookup-doc-history","status":"publish","type":"manual_documentation","link":"https:\/\/www.eformsign.com\/en\/support\/documentation\/open-api\/lookup-doc-history\/","title":{"rendered":"2.3.5 OPA_005 Lookup document history"},"content":{"rendered":"\n<p>API which looks up document history<\/p>\n\n\n\n<h2>Rest API<\/h2>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td>domain\/v1.0\/api\/documents\/{DOCUMENT_ID}\/histories<\/td><\/tr><\/tbody><\/table>\n\n\n\n<ul><li><em>Must use Access Token issued company.api_url for its domain<\/em><\/li><\/ul>\n\n\n\n<p>Example<\/p>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td>https:\/\/sg-api.eformsign.com\/v1.0\/api\/documents\/d803930e2094464aab548c340f7c8a4b\/histories<\/td><\/tr><\/tbody><\/table>\n\n\n\n<h2>Method<\/h2>\n\n\n\n<p>&#8211; GET<\/p>\n\n\n\n<h3>Request Header<\/h3>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td>Name<\/td><td>Type<\/td><td>Description<\/td><td>Miscellaneous<\/td><td>Required<\/td><\/tr><tr><td>Content-Type<\/td><td>String<\/td><td>Content-Type<\/td><td>application\/json<\/td><td>O<\/td><\/tr><tr><td>access_token<\/td><td>String<\/td><td>Access token<\/td><td>&nbsp;<\/td><td>O<\/td><\/tr><\/tbody><\/table>\n\n\n\n<h3>QueryString<\/h3>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td>Name<\/td><td>Type<\/td><td>Description<\/td><td>Miscellaneous<\/td><\/tr><\/tbody><\/table>\n\n\n\n<h3>Request Body<\/h3>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td>Name<\/td><td>Type<\/td><td>Description<\/td><td>Miscellaneous<\/td><\/tr><\/tbody><\/table>\n\n\n\n<h3>Response Header<\/h3>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td>Name<\/td><td>Type<\/td><td>Description<\/td><td>Miscellaneous<\/td><\/tr><tr><td>Content-Type<\/td><td>String<\/td><td>Content-Type<\/td><td>application\/json<\/td><\/tr><\/tbody><\/table>\n\n\n\n<h3>Success Response Body<\/h3>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td>Name<\/td><td>Type<\/td><td>Description<\/td><td>Miscellaneous<\/td><\/tr><tr><td>action<\/td><td>String<\/td><td>User action<\/td><td>doc_create(create a document),<br>doc_tempsave (save document as a draft),<br>doc_request_approval (request approval),<br>doc_accept_approval (approve document),<br>doc_reject_approval (reject approval document),<br>doc_request_external (request external user process),<br>doc_remind_external (request external user process again),<br>doc_open_external (open document_external),<br>doc_accept_external (approve document_external),<br>doc_reject_external (reject approval document_external),<br>doc_request_internal (request internal user process),<br>doc_accept_internal (accept document_internal),<br>doc_reject_internal (reject document_internal),<br>doc_tempsave_internal (internal user saves document as a draft),<br>doc_cancel_request (cancel request),<br>doc_reject_request (request for rejection),<br>doc_decline_cancel_request (decline rejection request),<br>doc_delete_request(request for deletion),<br>doc_decline_delete_request (decline deletion request),<br>doc_deleted (delete document),<br>doc_complete (complete document)<\/td><\/tr><tr><td>executor_id<\/td><td>String<\/td><td>Executor id<\/td><td>&nbsp;<\/td><\/tr><tr><td>executor_name<\/td><td>String<\/td><td>Executor name<\/td><td>&nbsp;<\/td><\/tr><tr><td>execute_date<\/td><td>long<\/td><td>execution date<\/td><td>&nbsp;<\/td><\/tr><tr><td>comment<\/td><td>String<\/td><td>comment<\/td><td>&nbsp;<\/td><\/tr><tr><td>workflow_step_type<\/td><td>String<\/td><td>workflow type<\/td><td>write, approval, internal, external, complete<\/td><\/tr><tr><td>workflow_step_name<\/td><td>String<\/td><td>workflow name<\/td><td>&nbsp;<\/td><\/tr><tr><td>notification<\/td><td>Object<\/td><td>notification<\/td><td>&nbsp;<\/td><\/tr><tr><td>notification.mail_list<\/td><td>Array<\/td><td>notification mail list<\/td><td>mail object (includes recipient_name, email_address, attach_pdf)<\/td><\/tr><tr><td>mail_list[].recipient_name<\/td><td>String<\/td><td>recipient name<\/td><td>&nbsp;<\/td><\/tr><tr><td>mail_list[].email_address<\/td><td>String<\/td><td>email address<\/td><td>&nbsp;<\/td><\/tr><tr><td>mail_list[].is_pdf_attached<\/td><td>boolean<\/td><td>status of PDF attached or not<\/td><td>&nbsp;<\/td><\/tr><tr><td>notification.push_list<\/td><td>Array<\/td><td>push notification list<\/td><td>push object (includes recipient_name, device_os, device_name)<\/td><\/tr><tr><td>push_list[].recipient_name<\/td><td>String<\/td><td>recipient name<\/td><td>&nbsp;<\/td><\/tr><tr><td>push_list[].device_os<\/td><td>String<\/td><td>device os name<\/td><td>android, ios<\/td><\/tr><tr><td>push_list[].device_name<\/td><td>String<\/td><td>device name<\/td><td>&nbsp;<\/td><\/tr><tr><td>notification.sms_list<\/td><td>Array<\/td><td>Text message recipient list<\/td><td>SMS object (includes receiver_name, phone_number, is_attach_pdf_link)<\/td><\/tr><tr><td>sms_list[].recipient_name<\/td><td>String<\/td><td>recipient name<\/td><td>&nbsp;<\/td><\/tr><tr><td>sms_list[].phone_number<\/td><td>String<\/td><td>recipient contact<\/td><td>&nbsp;<\/td><\/tr><tr><td>sms_list[].is_pdf_attached<\/td><td>boolean<\/td><td>status of PDF attached or not<\/td><td>&nbsp;<\/td><\/tr><tr><td>sms_list[].type<\/td><td>String<\/td><td>Text message type<\/td><td>sms, kakao_notification, whatsapp<\/td><\/tr><tr><td>cloud_storage_list<\/td><td>Array<\/td><td>external storage<\/td><td>Includes external storage object ( account, type, files)<\/td><\/tr><tr><td>cloud_storage_list[].account<\/td><td>String<\/td><td>storage integrated account<\/td><td>&nbsp;<\/td><\/tr><tr><td>cloud_storage_list[].type<\/td><td>String<\/td><td>storage type<\/td><td>Google drive, Dropbox<\/td><\/tr><tr><td>cloud_storage_list[].files<\/td><td>Array<\/td><td>file list<\/td><td>includes file (name)<\/td><\/tr><tr><td>files[].name<\/td><td>String<\/td><td>file name<\/td><td>&nbsp;<\/td><\/tr><tr><td>timestamp_files<\/td><td>Array<\/td><td>Timestamp applied files (TSA)<\/td><td>includes file (name)<\/td><\/tr><tr><td>timestamp_files[].name<\/td><td>String<\/td><td>file name<\/td><td>&nbsp;<\/td><\/tr><\/tbody><\/table>\n\n\n\n<h3>Fail Response Body<\/h3>\n\n\n\n<table class=\"wp-block-table\"><tbody><tr><td><strong>Name<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Description<\/strong><\/td><td><strong>\ube44\uace0<\/strong><\/td><\/tr><tr><td>error<\/td><td>Object<\/td><td>Error details<\/td><td>Only appears when there is an error. Error object (includes code, message)<\/td><\/tr><tr><td>error.code<\/td><td>String<\/td><td>Error code<\/td><td>&nbsp;<\/td><\/tr><tr><td>error.message<\/td><td>String<\/td><td>Error message<\/td><td>&nbsp;<\/td><\/tr><\/tbody><\/table>\n\n\n\n<h4>Example<\/h4>\n\n\n\n<p><strong>Request<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>GET \/v1.0\/api\/documents\/d803930e2094464aab548c340f7c8a4b\/status HTTP\/1.1\n\nContent-Type : application\/json\n\naccess_token : eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJvY2UuaWFtIiwiY29udGV4dCI6eyJjbGllbnRJ....\n\nHOST : https:\/\/kr-api.eformsign.com<\/code><\/pre>\n\n\n\n<p><strong>Response<\/strong><\/p>\n\n\n\n<p>&#8211; When succeeded<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>HTTPS\/1.1 200 OK\nContent-Type: application\/json\n[\n{\n\"action\": \"doc_create\",\n\"executor_id\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1554280625464,\n\"comment\": \"\",\n\"workflow_step_type\": \"write\",\n\"workflow_step_name\": \"request for approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_tempsave\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1554280625475,\n\"comment\": \"\",\n\"workflow_step_type\": \"write\",\n\"workflow_step_name\": \"request for approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_tempsave\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1554280639296,\n\"comment\": \"\",\n\"workflow_step_type\": \"write\",\n\"workflow_step_name\": \"request for approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_tempsave\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296532388,\n\"comment\": \"\",\n\"workflow_step_type\": \"write\",\n\"workflow_step_name\": \"request for approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_request_approval\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296532392,\n\"comment\": \"\",\n\"workflow_step_type\": \"approval\",\n\"workflow_step_name\": \"manager approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"device_os\": \"android\",\n\"device_name\": \"SHW-M480W\"\n}\n],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_accept_approval\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296583992,\n\"comment\": \"\",\n\"workflow_step_type\": \"approval\",\n\"workflow_step_name\": \"manager approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_request_reception\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296584092,\n\"comment\": \"\",\n\"workflow_step_type\": \"accept\",\n\"workflow_step_name\": \"collect approval\",\n\"notification\": {\n\"mail_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"email_address\": \"windy4788@forcs.com\",\n\"is_attach_pdf\": false\n}\n],\n\"push_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"device_os\": \"android\",\n\"device_name\": \"SHW-M480W\"\n}\n],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_accept_reception\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296680466,\n\"comment\": \"\",\n\"workflow_step_type\": \"accept\",\n\"workflow_step_name\": \"collect approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_request_approval\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296680564,\n\"comment\": \"\",\n\"workflow_step_type\": \"approval\",\n\"workflow_step_name\": \"collect approval\",\n\"notification\": {\n\"mail_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"email_address\": \"windy4788@forcs.com\",\n\"is_pdf_attached\": false\n}\n],\n\"push_list\": [\n{\n\"receiver_name\": \"John Doe\",\n\"device_os\": \"android\",\n\"device_name\": \"SHW-M480W\"\n}\n],\n\"sms_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"phone_number\": \"010-1234-5678\",\n\"is_pdf_attached\": false,\n\"sms_type\": \"kakao_notification\"\n}\n]\n}\n},\n{\n\"action\": \"doc_accept_approval\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296708782,\n\"comment\": \"\",\n\"workflow_step_type\": \"approval\",\n\"workflow_step_name\": \"collect approval\",\n\"notification\": {\n\"mail_list\": [],\n\"push_list\": [],\n\"sms_list\": []\n}\n},\n{\n\"action\": \"doc_complete\",\n\"executor\": \"windy4788@forcs.com\",\n\"executor_name\": \"John Doe \",\n\"execute_date\": 1557296708879,\n\"comment\": \"\",\n\"workflow_step_type\": \"complete\",\n\"workflow_step_name\": \"request for approval completed\",\n\"notification\": {\n\"mail_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"email_address\": \"windy4788@forcs.com\",\n\"is_pdf_attached\": false\n}\n],\n\"push_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"device_os\": \"android\",\n\"device_name\": \"SHW-M480W\"\n}\n],\n\"sms_list\": [\n{\n\"recipient_name\": \"John Doe\",\n\"phone_number\": \"010-1234-5678\",\n\"is_pdf_attached\": false,\n\"sms_type\": \"kakao_notification\"\n}\n]\n},\n\"cloud_storages\": [\n{\n\"account\": \"windy4788@forcs.com\",\n\"type\": \"Dropbox\",\n\"files\": [\n{\n\"name\": \"2019_John Doe approval_document.pdf\"\n},\n{\n\"name\": \"2019_John Doe approval_document_audit trail.pdf\"\n}\n]\n},\n{\n\"account\": \"windy4788@forcs.com\",\n\"type\": \"Google drive\",\n\"files\": [\n{\n\"name\": \"2019_John Doe approval_document.pdf\"\n},\n{\n\"name\": \"2019_John Doe approval_document_audit trail.pdf\"\n}\n]\n}\n],\n\"timestamp_files\": [\n{\n\"name\": \"2019_John Doe approval_document.pdf\"\n},\n{\n\"name\": \"2019_John Doe approval_document_audit trail.pdf\"\n}\n]\n}\n]<\/code><\/pre>\n\n\n\n<p>&#8211; When failed (error)<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>HTTPS \/ 1.1 403 forbidden\nContent-Type: application\/json\n{\n\"error\": {\n\"code\": \"4030001\",\n\"message\": \"invalid api key\"\n}\n}<\/code><\/pre>\n","protected":false},"author":1,"featured_media":0,"parent":11930,"menu_order":0,"template":"","manualdocumentationcategory":[44],"_links":{"self":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11956"}],"collection":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/users\/1"}],"version-history":[{"count":4,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11956\/revisions"}],"predecessor-version":[{"id":12732,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11956\/revisions\/12732"}],"up":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11930"}],"wp:attachment":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/media?parent=11956"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11956"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}