MENU
      Delete task
        • PDF

        Delete task

        • PDF

        Article summary

        Available in VPC

        Use this when you want to delete a task model that you no longer use or that is unnecessary.

        The deletion conditions for a task are as follows.

        Deletion availabilityTask statusTask usage status
        Available
        • registered: registered
        • completed: available
        • failed: failed
        • If there is no function (task model run or custom attributes) that uses the task you want to delete
        • Even if there is a function that uses the task you want to delete, it is either before the start (registered) or has already been completed (completed, failed)
        Unavailable
        • pending: pending
        • in_progress: creating
        If the function that uses the task you want to delete (task model run or shopping intent) is running (pending, in_progress)
        Note

        If the deletion is not possible, you will receive an error message. Try again under conditions where deletion is possible.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        DELETE/tasks/{task_id}

        Request headers

        For information about the headers common to all NCLUE APIs, see NCLUE request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        task_idStringRequiredTask ID

        Request example

        The request example is as follows:

        curl --location --request DELETE 'https://nclue.apigw.ntruss.com/api/v1/tasks/{task_id}' \
        --header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
        --header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
        --header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        task_idString-Task ID

        Response status codes

        For response status codes common to NCLUE, see NCLUE response status codes.

        Response example

        The response example is as follows:

        {
            "task_id": "f5aebc0c-****-****-****-b201bc64b1c9"
        }
        JSON

        Was this article helpful?

        What's Next
        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.