Updates the file information of a user-defined function (UDF).
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| FileFolderPath |
string |
No |
The path of the folder that contains the function file. |
Business_process/First_Business_Process/function/string_processing_function |
| ProjectId |
integer |
No |
The DataWorks workspace ID. You can click the wrench icon in the upper-right corner of the DataWorks console and go to the workspace management page to view the ID. |
10000 |
| FunctionType |
string |
Yes |
The function category. This parameter corresponds to the Function Type field in the Create Function dialog box. Valid values: MATH (mathematical functions), AGGREGATE (aggregate functions), STRING (string processing functions), DATE (date processing functions), ANALYTIC (window functions), and OTHER (other functions). |
STRING |
| ClassName |
string |
Yes |
The class name of the function. This parameter corresponds to the Class Name field in the Create Function dialog box. |
com.alibaba.DataWorks.api.udf.StringConcat |
| Resources |
string |
Yes |
The resource names referenced by the function, separated by commas (,). This parameter corresponds to the Resource List field in the Create Function dialog box. |
string-concat-1.0.0.jar,commons-lang-2.6.jar |
| UdfDescription |
string |
No |
The description of the function. This parameter corresponds to the Description field in the Create Function dialog box. |
Concatenate several strings to generate a new string |
| CmdDescription |
string |
No |
The command format for calling the function. This parameter corresponds to the Command Format field in the Create Function dialog box. |
StringConcat(String... substrs) |
| ParameterDescription |
string |
No |
The description of function parameters. This parameter corresponds to the Parameter Description field in the Create Function dialog box. Valid values:
|
List of strings to be connected |
| ReturnValue |
string |
No |
The description of the return value. This parameter corresponds to the Return Value field in the Create Function dialog box. |
New strings generated by concatenating all strings before and after the input order |
| Example |
string |
No |
A usage example of the function. This parameter corresponds to the Example field in the Create Function dialog box. |
StringConcat('a', 'b', 'c') |
| ProjectIdentifier |
string |
No |
The unique identifier of the DataWorks workspace. This is the workspace identifier displayed at the top of the Data Studio page. You must specify either this parameter or ProjectId to identify the DataWorks workspace. |
dw_project |
| FileId |
string |
Yes |
The file ID. |
10000001 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| ErrorMessage |
string |
The error message. |
The connection does not exist. |
| RequestId |
string |
The request ID. You can use this ID to troubleshoot issues. |
0000-ABCD-EFG**** |
| ErrorCode |
string |
The error code. |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-EFG****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true
}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.