CreateDataServiceApi
Generate and manage data service APIs in DataWorks MCP Server by defining API details, paths, protocols, and methods for streamlined data access and integration.
Instructions
创建数据服务API
Input Schema
Name | Required | Description | Default |
---|---|---|---|
ApiDescription | Yes | API的描述信息 | |
ApiMode | No | API的类型,可选枚举值包括0(向导API)、1(脚本API)和2(注册API) | |
ApiName | Yes | API的名称,支持汉字、英文、数字和下划线(_),且只能以英文和汉字开头,4~50个字符 | |
ApiPath | Yes | API的路径,支持英文、数字、下划线(_)和连字符(-),且只能以斜线(/)开头,不能超过200个字符 | |
FolderId | No | 创建API的目标文件夹ID,业务流程下根文件夹ID等于0,用户自建文件夹ID大于0 | |
GroupId | Yes | 业务流程的ID | |
ProjectId | No | 工作空间的ID | |
Protocols | Yes | API的协议,可选枚举值包括0(HTTP)和1(HTTPS)。支持多个值,多个值之间使用英文逗号(,)分隔 | |
RegistrationDetails | No | 注册API的详情,请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSONString | |
RequestContentType | No | 请求数据类型。- 0:xml- 1:json- 2:form | |
RequestMethod | No | API的请求方式,可选枚举值包括0(GET)、1(POST)、2(PUT)和3(DELETE)。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE | |
ResourceGroupId | No | 独享资源组ID | |
ResponseContentType | No | API的返回数据类型,可选枚举值包括0(JSON)和1(XML)。向导和脚本API支持JSON,注册API支持JSON和XML | |
ScriptDetails | No | 脚本API的详情,请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSONString | |
SqlMode | No | 0-基础模式。-1-mybatis | |
TenantId | No | 租户ID | |
Timeout | No | 超时时间,单位为毫秒(ms),取值范围为(0,30000] | |
VisibleRange | No | 可见范围,可选枚举值包括0(工作空间)和1(私有) | |
WizardDetails | No | 向导API的详情,请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSONString |