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

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

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

    Example<\/p>\n\n\n\n
    https:\/\/kr-api.eformsign.com\/v1.0\/api\/documents\/d803930e2094464aab548c340f7c8a4b<\/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>
    id<\/td>String<\/td>Document id<\/td><\/td><\/tr>
    template_id<\/td>String<\/td>Template id<\/td> <\/td><\/tr>
    template_name<\/td>String<\/td>Template name<\/td> <\/td><\/tr>
    template_version<\/td>int<\/td>Template version<\/td> <\/td><\/tr>
    title<\/td>String<\/td>Document title<\/td> <\/td><\/tr>
    creator<\/td>Object<\/td>Document creator info<\/td>document creator object (includes id, name)<\/td><\/tr>
    creator.id<\/td>String<\/td>Document creator id<\/td> <\/td><\/tr>
    creator.name<\/td>String<\/td>Creator name<\/td> <\/td><\/tr>
    created_date<\/td>long<\/td>Created date<\/td> <\/td><\/tr>
    editor<\/td>Object<\/td>Document editor info<\/td>document editor object (includes id, name)<\/td><\/tr>
    editor.id<\/td>String<\/td>Document editor id<\/td> <\/td><\/tr>
    editor.name<\/td>String<\/td>Document editor name<\/td> <\/td><\/tr>
    updated_date<\/td>long<\/td>Document edited date<\/td> <\/td><\/tr>
    current_status<\/td>String<\/td>Document status<\/td>doc_created(document created),
    doc_tempsave (document saved as a draft),
    doc_request_approval (approval requested),
    doc_accept_approval (document approved),
    doc_reject_approval (document not approved),
    doc_request_external (external user process sent),
    doc_remind_external (external user process sent again),
    doc_open_external (external user opened, viewed the document),
    doc_accept_external (external user approved the document),
    doc_reject_external (external user rejected the document),
    doc_request_internal (internal user process sent),
    doc_accept_internal (internal user process approved),
    doc_reject_internal (internal user process rejected),
    doc_tempsave_internal (internal user saved the document as a draft),
    doc_cancel_request (sender cancels the document request),
    doc_reject_request (sender requests to reject one’s approval),
    doc_decline_cancel_request (declines the cancel request from the sender),
    doc_delete_request(sender request to delete the request),
    doc_decline_delete_request (declines the delete request from the sender),
    doc_deleted (document deleted),
    doc_complete (document completed)<\/td><\/tr>
    user_defined_status<\/td>String<\/td>user defined document status<\/td>The document status which user has defined<\/td><\/tr>
    workflow_step_type<\/td>String<\/td>Workflow step type<\/td> <\/td><\/tr>
    workflow_step_name<\/td>String<\/td>Workflow step name<\/td> <\/td><\/tr>
    data_list<\/td>Object<\/td>user input data<\/td>Gets displayed in form_id : value format based on input data<\/td><\/tr><\/tbody><\/table>\n\n\n\n

    Fail Response Body<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>Miscellaneous<\/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 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\"id\": \"1e9c508486d149d8a402a4357c7533a2\",\n\"template_id\": \"f261bba9d4d343ebb67bc1a839f8feff\",\n\"template_name\": \"Product purchase request form\",\n\"template_version\": 1,\n\n\"document_number\":\"Purchase NO.1\",\n\"title\": \"Request\",\n\"creator\": {\n\"id\": \"test1@forcs.com\",\n\"name\": \"John Doe\"\n},\n\"created_date\": 1477385802676,\n\"editor\": {\n\"id\": \"test1@forcs.com\",\n\"name\": \"John Doe\"\n},\n\"updated_date\": 1477385802676,\n\"current_status\": \"doc_request_approval\",\n\"user_defined_status\": \"Purchase request\",\n\"workflow_step_type\": \"approval\",\n\"workflow_step_name\": \"Approval\",\n\"data_list\": {\n\"name\": \"John Doe\",\n\"address\": \"Domant Dr.\",\n\"product\": \"Name card\",\n\"memo\": \"Please make these ASAP\"\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\/11941"}],"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":3,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11941\/revisions"}],"predecessor-version":[{"id":12721,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11941\/revisions\/12721"}],"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=11941"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11941"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}