MENU
      Data Flow overview
        • PDF

        Data Flow overview

        • PDF

        Article summary

        Data Flow provides API through API Gateway of NAVER Cloud Platform.
        The access key and secret key are necessary for API authentication.
        For more information on API key creation and usage instructions, see API Gateway User Guide > Call API.
        For more information on the access key and secret key, see Common Guide > API overview.

        Data Flow provides various APIs, and you can check the API specifications and perform simple tests through the Swagger page. See the following content for Data Flow's Swagger documentation.

          1. Access NAVER Cloud Platform console.
        1. Click Services > API Gateway in order.
        2. Click Published APIs > Data Flow > Catalog in order.
        3. After clicking Data Flow, click API Manual below.
          The screen that appears at this time is AiTEMS' Swagger page, and the link displayed at the top of the page ( https://dataflow.apigw.ntruss.com/api/v1) is the API address of AiTEMS.

        Common settings


        Data Flow API URL

        https://dataflow.apigw.ntruss.com/api/v1
        HTTP

        Request headers

        Header nameDescription
        x-ncp-apigw-timestampIt indicates the time elapsed since January 1, 1970, 00:00:00 (UTC) in milliseconds and the request is considered invalid if the time difference from the API Gateway server is greater than 5 minutes
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyValue of access key ID issued from NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecify the request body content type as application/json
        Content-Type: application/json

        Operation

        Dashboard

        API nameDescription
        getExecutionResultView the total number of job executions, and the number of succeeded and failed executions
        getExecutionCountView the number of job executions during the specified period
        getExecutionTimesView the job execution time during the specified period

        Workflow

        API nameDescription
        getWorkflowsView workflow list
        getWorkflowByIdView workflow
        createWorkflowCreate workflow
        updateWorkflowEdit workflow
        deleteWorkflowDelete workflow
        getWorkflowExecutionsView workflow execution list

        Job

        API nameDescription
        getJobsView job list
        getJobByIdView job
        createJobCreate job
        updateJobEdit job
        deleteJobDelete job
        verifyJobVerify job request items
        executeJobExecute job
        getJobExecutionsView job execution list
        getJobExecutionByIdView job execution details
        updateJobExecuteConfigEdit job execution settings

        Trigger

        API nameDescription
        getTriggersView trigger list
        getTriggerByIdView trigger
        createTriggerCreate trigger
        deleteTriggerDelete trigger

        Error response format

        If a API request fails, or an error occurs while processing, the success/failure result is returned as an HTTP status code, and the detailed message is returned in JSON format.

        Response examples

        {
          "type": "about:blank",
          "title": "Not Found",
          "status": 404,
          "detail": "{workflowId=aa}: Unable to find.",
          "instance": "/dataflow/api/workflows/aa",
          "errorType": "resource-not-found/WORKFLOW"
        }
        JSON

        Error response

        HTTP status codeError typeMessagesDescriptionSolutions
        400bad-parameterCheck the parameters.Request parameters errorReconfirm the requested value
        400bad-stateCheck the status.Request status errorReconfirm the status of the requested target
        404resource-not-found/The item can't be found.Requested resource ID errorReconfirm the requested target
        400client-request-failedFailed to the request.Linked product request errorView linked products
        400client-resource-not-foundThe resource can't be found.Linked product resource errorView linked product resource
        400client-unauthorizedYou don't have permissions.Linked product permission errorView linked product permission
        500unknown-resource-action/An unexpected error has occurred.Job execution errorContact us through Customer Support > Contact us

        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.