{"id":11974,"date":"2019-10-22T16:03:25","date_gmt":"2019-10-22T07:03:25","guid":{"rendered":"https:\/\/www.eformsign.com\/kr\/support\/?post_type=manual_documentation&p=11974"},"modified":"2020-09-15T10:59:29","modified_gmt":"2020-09-15T01:59:29","slug":"doc-creation","status":"publish","type":"manual_documentation","link":"https:\/\/www.eformsign.com\/en\/support\/documentation\/open-api\/doc-creation\/","title":{"rendered":"2.3.7 OPA_007 Document creation"},"content":{"rendered":"\n

API for creating documents using an API key.<\/p>\n\n\n\n

Rest API<\/h2>\n\n\n\n
domain\/v1.0\/api\/forms\/{FORM_ID}\/documents<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
  • The domain must use the company.api_url value in which the access token is issued.<\/em><\/li><\/ul>\n\n\n\n

    Example<\/p>\n\n\n\n

    https:\/\/kr-api.eformsign.com\/v1.0\/api\/forms\/61b05d369b2a4a10b5c4c8a1373abc0d\/documents<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

    – POST<\/p>\n\n\n\n

    Request Header<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>Remark<\/td>Required?<\/td><\/tr>
    Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td>O<\/td><\/tr>
    access_token<\/td>String<\/td>Access token<\/td>Member access token<\/td>O<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

    Request Body<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>Remark<\/td>Required?<\/td><\/tr>
    title<\/td>String<\/td>Document title<\/td>The title set in the template is set if there is no value. <\/td>X<\/td><\/tr>
    next_steps<\/td>Array<\/td>Next step list<\/td>Includes step objects (step_type, comment, approvers)

    The document is saved as a draft is there is no value.<\/td>    		X<\/td><\/tr>
    next_steps[].step_type<\/td>String<\/td>Next step type<\/td>approval, outsider, accept, complete<\/td>X<\/td><\/tr>
    next_steps[].comment<\/td>String<\/td>Next step request comment<\/td> <\/td>X<\/td><\/tr>
    next_steps[].approvers<\/td>Array<\/td>Requester list (included in approval, internal recipient, and external recipient steps)<\/td>Includes approver object (user_id)<\/td>X<\/td><\/tr>
    next_steps[].approvers[].user_id<\/td>String<\/td>ID of the next step requester
    (“All” if its’ an internal request and requesting to all internal recipients)<\/td>    		 <\/td>X<\/td><\/tr>
    next_steps[].approvers[].user_name<\/td>String<\/td>The requester name, for external recipient requests<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].code<\/td>String<\/td>The country code for SMS requests, for external recipient requests<\/td>E.g. \u201c+82\u201d<\/td>X<\/td><\/tr>
    next_steps[].approvers[].number<\/td>String<\/td>The mobile phone number for SMS requests, for external recipient requests<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].auth_password<\/td>String<\/td>The verification password, for external recipient requests<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].auth_valid_time <\/td>number<\/td>The validity time for external recipient review, for external recipient requests<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].auth_hint<\/td>String<\/td>The verification password hint, for external recipient requests<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].type<\/td>String<\/td>The requester type, for internal recipient requests<\/td>member, group<\/td>X<\/td><\/tr>
    form_fields<\/td>Array<\/td>List of data to be written in components in documents<\/td>Includes form_field objects (input_form_id, input_form_value)<\/td>X<\/td><\/tr>
    form_fields[].input_form_id<\/td>String<\/td>Form ID in components in documents<\/td> <\/td>X<\/td><\/tr>
    form_fields[].input_form_value<\/td>String<\/td>Data to be written in components in documents<\/td> <\/td>X<\/td><\/tr>
    group<\/td>String<\/td>Group name<\/td>The group information is set in the default value of the input field in template field settings.
    Required when the document creator belongs to 2 or more groups.
    Ignore when the document creator belongs to 1 group or no groups.<\/td>    		X<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

    Success Response Body<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>Remark<\/td><\/tr>
    document_title <\/td> String <\/td>Document title <\/td>The title of a created document<\/td><\/tr>
    document_id <\/td> String <\/td>Document ID<\/td>The unique ID of a created document<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Fail Response Body<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>Remark<\/td><\/tr>
    error<\/td>Object<\/td>Error details<\/td>-Displayed only in errors
    -Includes error objects (includes code and messages)<\/td><\/tr>
    error.code<\/td>String<\/td>Error code<\/td> <\/td><\/tr>
    error.message<\/td>String<\/td>Error message<\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

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

    POST \/v1.0\/api\/forms\/61b05d369b2a4a10b5c4c8a1373abc0d\/documents HTTP\/1.1\n\nContent-Type : application\/json\n\naccess_token : eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJvY2UuaWFtIiwiY29udGV4dCI6eyJjbGllbnRJ....\n\nHOST : https:\/\/kr-api.eformsign.com\n\n{\n\n\"form_version\" : \"1\",\n\"title\" : \"Holiday request\",\n\"next_steps\" : [ \/\/ saved as draft if next_step doesn't exist.\n{\n\"step_type\" : \"approval\",\n\"comment\" : \"\",\n\"approvers\" : [\n{\n\"user_id\" : \"test1@forcs.com\"\n}\n]\n}\n],\n\"form_fields\" : [\n{\n\"input_form_id\" : \"TextBox1\",\n\"input_form_value\" : \"This is a test 1\"\n},\n{\n\"input_form_id\" : \"TextBox2\",\n\"input_form_value\" : \"This is a test 2\"\n}\n]\n}<\/code><\/pre>\n\n\n\n
    Response<\/strong><\/p>\n\n\n\n
    – Success<\/p>\n\n\n\n
    HTTPS\/1.1 200 OK\nContent-Type: application\/json\n{\n\"document_title\": \"openAPItest\",\n\"document_id\": \"e433c854ca034a88bd2e1a0e380afe9b\"\n}<\/code><\/pre>\n\n\n\n
    – Failure<\/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\/11974"}],"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":11,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11974\/revisions"}],"predecessor-version":[{"id":14530,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11974\/revisions\/14530"}],"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=11974"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11974"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}