{"id":11948,"date":"2019-10-22T15:36:23","date_gmt":"2019-10-22T06:36:23","guid":{"rendered":"https:\/\/www.eformsign.com\/kr\/support\/?post_type=manual_documentation&p=11948"},"modified":"2019-11-27T10:30:15","modified_gmt":"2019-11-27T01:30:15","slug":"lookup-doc-status","status":"publish","type":"manual_documentation","link":"https:\/\/www.eformsign.com\/en\/support\/documentation\/open-api\/lookup-doc-status\/","title":{"rendered":"2.3.4 OPA_004 Lookup document status"},"content":{"rendered":"\n

API which looks up document status<\/p>\n\n\n\n

Rest API<\/h2>\n\n\n\n
domain\/v1.0\/api\/documents\/{DOCUMENT_ID}\/status<\/td><\/tr><\/tbody><\/table>\n\n\n\n
  • Must use Access Token issued company.api_url for its domain<\/em><\/li><\/ul>\n\n\n\n

    Example<\/p>\n\n\n\n
    https:\/\/sg-api.eformsign.com\/v1.0\/api\/documents\/d803930e2094464aab548c340f7c8a4b\/status<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Method<\/h2>\n\n\n\n

    – GET<\/p>\n\n\n\n

    Request Header<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
    Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td><\/tr>
    access_token<\/td>String<\/td>Access token<\/td> <\/td><\/tr><\/tbody><\/table>\n\n\n\n

    QueryString<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous <\/strong><\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Request Body<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Response Header<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
    Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Success Response Body<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
    current_status_seq<\/td>int<\/td>Current workflow status<\/td> <\/td><\/tr>
    status_list<\/td>Array<\/td>Document status list<\/td> <\/td><\/tr>
    status_list[].seq<\/td>int<\/td>Status sequence<\/td> <\/td><\/tr>
    status_list[].workflow_step_type<\/td>String<\/td>Workflow step type<\/td>write(\uc791\uc131), approval(\uacb0\uc81c), internal(\ub0b4\ubd80\uc790 \ucc98\ub9ac), external(\uc678\ubd80\uc790 \ucc98\ub9ac), complete(\uc644\ub8cc)<\/td><\/tr>
    status_list[].workflow_step_name<\/td>String<\/td>Workflow step name<\/td> <\/td><\/tr>
    status_list[].action<\/td>String<\/td>User action<\/td>doc_create(create a document),
    doc_tempsave (save document as a draft),
    doc_request_approval (request approval),
    doc_accept_approval (approve document),
    doc_reject_approval (reject approval document),
    doc_request_external (request external user process),
    doc_remind_external (request external user process again),
    doc_open_external (open document_external),
    doc_accept_external (approve document_external),
    doc_reject_external (reject approval document_external),
    doc_request_internal (request internal user process),
    doc_accept_internal (accept document_internal),
    doc_reject_internal (reject document_internal),
    doc_tempsave_internal (internal user saves document as a draft),
    doc_cancel_request (cancel request),
    doc_reject_request (request for rejection),
    doc_decline_cancel_request (decline rejection request),
    doc_delete_request(request for deletion),
    doc_decline_delete_request (decline deletion request),
    doc_deleted (delete document),
    doc_complete (complete document)<\/td><\/tr>
    status_list[].sender<\/td>Object<\/td>sender name (id \/ email \/ contact)<\/td>sender object (includes id, name)<\/td><\/tr>
    sender.id<\/td>String<\/td>sender id<\/td>There may be no id if the document was created by external user<\/td><\/tr>
    sender.name<\/td>String<\/td>sender name<\/td>There may be no name if the document was created by external user<\/td><\/tr>
    status_list[].recipient_list<\/td>Array<\/td>recipient list<\/td>There can be more than one recipient
    Recipient object (includes id, name)<\/td><\/tr>
    recipient_list[].id<\/td>String<\/td>recipient id<\/td>If the recipient is the external user, id value will be an email or contact
    If the recipient is a group, there may be no id value.<\/td><\/tr>
    recipient_list[].name<\/td>String<\/td>recipient name<\/td> <\/td><\/tr>
    status_list[].executor<\/td>Object<\/td>executor info<\/td>executor object (includes id, name)<\/td><\/tr>
    executor.id<\/td>String<\/td>executor id<\/td>If the executor is the external user, id value will be an email or contact<\/td><\/tr>
    executor.name<\/td>String<\/td>executor name<\/td> <\/td><\/tr>
    status_list[].execute_date<\/td>long<\/td>execution time<\/td> <\/td><\/tr>
    status_list[].comment<\/td>String<\/td>comment<\/td> <\/td><\/tr>
    status_list[].progress<\/td>String<\/td> <\/td>step_complete(step completed),
    step_skip(step skip),
    step_in_process(step in process),
    step_stand_by(step stand by)<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Fail Response Body<\/h3>\n\n\n\n
    Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
    error<\/td>Object<\/td>Error details<\/td>Only appears when there is an error. Error object (includes code, message)<\/td><\/tr>
    error.code<\/td>String<\/td>Error code<\/td> <\/td><\/tr>
    error.message<\/td>String<\/td>Error message<\/td> <\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Example<\/h4>\n\n\n\n

    Request<\/strong><\/p>\n\n\n\n

    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
    Response<\/strong><\/p>\n\n\n\n
    – When succeeded<\/p>\n\n\n\n
    HTTPS\/1.1 200 OK\nContent-Type: application\/json\n{\n\"current_status\": 4,\n\"status_list\": [\n{\n\"seq\": 1,\n\"workflow_step_type\": \"write\",\n\"workflow_step_name\": \"Start\",\n\"action\": \"doc_create\",\n\"sender\": {},\n\"recipient_list\": [],\n\"executor\": {\n\"id\": \"windy4788@forcs.com\",\n\"name\": \"John Doe\"\n},\n\"execute_date\": 1556503248076,\n\"comment\": \"\",\n\"progress\": \"step_complete\"\n},\n{\n\"seq\": 2,\n\"workflow_step_type\": \"external\",\n\"workflow_step_name\": \"external user process\",\n\"action\": \"doc_accept_external\",\n\"sender\": {\n\"id\": \"windy4788@forcs.com\",\n\"name\": \"John Doe\"\n},\n\"recipient_list\": [\n{\n\"id\": \"windy4788@nate.com\",\n\"name\": \"Steve Donovan\"\n}\n],\n\"executor\": {\n\"id\": \"windy4788@nate.com\",\n\"name\": \"Steve Donovan\"\n},\n\"execute_date\": 1556503248076,\n\"comment\": \"\",\n\"progress\": \"step_complete\"\n},\n{\n\"seq\": 3,\n\"workflow_step_type\": \"external\",\n\"workflow_step_name\": \"external user process\",\n\"action\": \"doc_accept_external\",\n\"sender\": {\n\"id\": \"windy4788@forcs.com\",\n\"name\": \"John Doe\"\n},\n\"recipient_list\": [\n{\n\"id\": \"010-8946-0159\",\n\"name\": \"Julia Cramer\"\n}\n],\n\"executor\": {\n\"id\": \"010-8946-0159\",\n\"name\": \"Julia Cramer\"\n},\n\"execute_date\": 1556503248076,\n\"comment\": \"\",\n\"progress\": \"step_complete\"\n},\n{\n\"seq\": 4,\n\"workflow_step_type\": \"internal\",\n\"workflow_step_name\": \"Internal user process 1\",\n\"action\": \"\",\n\"sender\": {\n\"id\": \"windy4788@forcs.com\",\n\"name\": \"John Doe\"\n},\n\"recipient_list\": [\n{\n\"id\": \"\",\n\"name\": \"Research Dept.\"\n},\n{\n\"id\": \"windy4788@forcs.com\",\n\"name\": \"John Doe\"\n}\n],\n\"comment\": \"\",\n\"progress\": \"step_in_process\"\n},\n{\n\"seq\": 5,\n\"workflow_step_type\": \"complete\",\n\"workflow_step_name\": \"Complete\",\n\"action\": \"\",\n\"sender\": {\n\"id\": \"windy4788@forcs.com\",\n\"name\": \"John Doe\"\n},\n\"recipient_list\": [],\n\"executor\": {},\n\"execute_date\": -1,\n\"comment\": \"\",\n\"progress\": \"step_stand_by\"\n}\n]\n}<\/code><\/pre>\n\n\n\n
    – When failed (error)<\/p>\n\n\n\n
    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\/11948"}],"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":2,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11948\/revisions"}],"predecessor-version":[{"id":12726,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11948\/revisions\/12726"}],"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=11948"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11948"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}