All Products
Search

This Product

    DataWorks:CreateUdfFile

    Document Center

    DataWorks:CreateUdfFile

    Last Updated:Jul 31, 2026

    Creates a function type file in DataStudio.

    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
    FileFolderPath

    string

    No

    The path of the folder where the function file is stored.

    Business_process/First_Business_Process/function/string_processing
    ProjectId

    integer

    No

    The ID of the DataWorks workspace. You can click the small wrench icon in the upper-right corner of the page to go to the storage management page and view the ID.

    10000
    FileName

    string

    Yes

    The name of the function.

    StringConcat
    FunctionType

    string

    Yes

    The categorization of the function, which corresponds to the Function Type field in the Create Function form. Valid values: MATH (mathematical operation function), AGGREGATE (aggregate functions), STRING (character string processing function), DATE (date processing function), ANALYTIC (window function), and OTHER (other function).

    Valid values:

    • OTHER :

      other function.

    • DATE :

      date processing function.

    • AGGREGATE :

      aggregate functions

    • STRING :

      string processing function.

    • ANALYTIC :

      window function.

    • MATH :

      mathematical operation function.

    STRING
    ClassName

    string

    Yes

    The name of the class in which the function is defined, which corresponds to the Class Name field in the Create Function form.

    com.alibaba.DataWorks.api.udf.StringConcat
    Resources

    string

    Yes

    The resources referenced by the function, which corresponds to the Resources field in the Create Function form. Separate multiple resource names with commas (,).

    string-concat-1.0.0.jar,commons-lang-2.6.jar
    UdfDescription

    string

    No

    The description of the function purpose, which corresponds to the Description field in the Create Function form.

    Concatenate several strings to generate a new string
    CmdDescription

    string

    No

    The command format for invoking the function, which corresponds to the Command Format field in the Create Function form.

    StringConcat(String... substrs)
    ParameterDescription

    string

    No

    The description of the function input parameters, which corresponds to the Parameter Description field in the Create Function form.

    List of strings to be connected
    ReturnValue

    string

    No

    The description of the return value of the function, which corresponds to the Return Value field in the Create Function form.

    New strings generated by concatenating all strings before and after the input order
    Example

    string

    No

    The function invocation example, which corresponds to the Example field in the Create Function form.

    StringConcat('a', 'b', 'c')
    ProjectIdentifier

    string

    No

    The unique identifier of the DataWorks workspace, which is the English identifier displayed in the workspace switcher at the top of the DataStudio page.

    dw_project
    CreateFolderIfNotExists

    boolean

    No

    Specifies whether to enable automatic creation of the directory specified by the FileFolderPath parameter if it does not exist. Valid values:

    • true: Automatically creates the directory if it does not exist.

    • false: The invocation fails if the directory does not exist.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    HttpStatusCode

    integer

    The HTTP status code.

    200
    Data

    integer

    The ID of the file after it is created.

    100000002
    RequestId

    string

    The unique ID of the request. You can use this ID to troubleshoot issues.

    0000-ABCD-EFG****
    ErrorMessage

    string

    The error message.

    The connection does not exist.
    Success

    boolean

    Indicates whether the call was successful.

    true
    ErrorCode

    string

    The error code.

    Invalid.Tenant.ConnectionNotExists

    Examples

    Success response

    JSON format

    {
  "HttpStatusCode": 200,
  "Data": 100000002,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.UserId.Missing An internal system error occurred. Try again later.
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. No permission, please authorize
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.