All Products
Search
Document Center

DataWorks:DeleteFunction

Last Updated:Mar 30, 2026

Deletes a user-defined function (UDF) in DataStudio.

Operation description

Important After a UDF is published, it cannot be deleted. You must unpublish the UDF before you can delete it.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ProjectId

integer

Yes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID. You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.

10000

Id

string

Yes

The unique identifier of the UDF.

Note

This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.

860438872620113XXXX

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

88198F19-A36B-52A9-AE44-4518A688XXXX

Success

boolean

Indicates whether the request was successful. Valid values:

  • true

  • false

true

Examples

Success response

JSON format

{
  "RequestId": "88198F19-A36B-52A9-AE44-4518A688XXXX",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.