Create External Approval Documents v2
    • PDF

    Create External Approval Documents v2

    • PDF

    Article Summary

    Description

    It creates a pop-up window URL to use the API to create a document in a form created by the form generator.
    If you open the pop-up window with the URL created, you can see that the initial data is inserted in the Create document screen.

    Request URL

    POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/fg/{dfmId}/doc/popup
    

    Request Header

    HeaderDescription
    x-ncp-apigw-timestamp
  • It indicates the time elapsed since January 1, 1970 00:00:00 (UTC) in milliseconds.
  • If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
  • x-ncp-iam-access-keyAccess key ID issued on the NAVER Cloud Platform portal or by Sub Account
    x-ncp-apigw-signature-v2
  • Signature used to encrypt the body of the above example with the secret key that maps with the access key ID.
  • HmacSHA256 is used for the HMAC encryption algorithm.
  • Request Path Parameters

    ParameterTypeSizeRequirement statusDescription
    companyIdString36YIntegration key (companyId) Developers > Basic settings > Integration key
    dfmIdString36YForm ID


    Request Body Parameters

    ParameterTypeSizeRequirement statusDescription
    titleString1000NSubject
    dfmIdString36YForm ID
    dataListListYComponent data configured in the form body - Component dataList parameter


    Request Examples

    POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/dda81449-adb8-47a0-869b-d748b4d3c03e/doc/popup
    
    POST /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/dda81449-adb8-47a0-869b-d748b4d3c03e/doc/popup
    HOST: workplace.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-timestamp: 1505290625682
    x-ncp-iam-access-key: D78BB444D6D3C84CA38A
    x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
    
    {
      "title": "[External integration] approval document draft",
      "dfmId": "dda81449-adb8-47a0-869b-d748b4d3c03e",
      "dataList": [
        {
          "componentValue": "홍길동",
          "componentCode": "CP_TEXT",
          "componentUuid": "cebd07e7-c340-d238-545f-1e9603224fde"
        }
      ]
    }
    


    Response Examples

    Returned valueDescription
    companyIdCompany ID
    dfmIdForm ID
    popupDocKeyUnique key issued when the API is successfully called
    redirectUrlURL to be opened by the pop-up window
    HTTP/1.1 200 OK
    Server: nginx
    Date: Wed, 12 Sep 2020 01:18:11 GMT
    Content-Type: application/json;charset=utf-8
    Transfer-Encoding: chunked
    Connection: keep-alive
    Access-Control-Allow-Origin: *
    x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
    
    {
        "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
        "dfmId": "dda81449-adb8-47a0-869b-d748b4d3c03e",
        "popupDocKey": "c1d8a519-e7a5-4c7f-a038-35f7f3af0fee",
        "redirectUrl": "http://dev-ncpworkplace.com/user/write/fg-dfm/dda81449-adb8-47a0-869b-d748b4d3c03e?companyId=187d83ad-4038-45b6-8e7c-59eca16fdc46&popupDocKey=c1d8a519-e7a5-4c7f-a038-35f7f3af0fee"
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.