DataWorks MCP Server

Official

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

NameRequiredDescriptionDefault
ApiDescriptionYesAPI的描述信息
ApiModeNoAPI的类型,可选枚举值包括0(向导API)、1(脚本API)和2(注册API)
ApiNameYesAPI的名称,支持汉字、英文、数字和下划线(_),且只能以英文和汉字开头,4~50个字符
ApiPathYesAPI的路径,支持英文、数字、下划线(_)和连字符(-),且只能以斜线(/)开头,不能超过200个字符
FolderIdNo创建API的目标文件夹ID,业务流程下根文件夹ID等于0,用户自建文件夹ID大于0
GroupIdYes业务流程的ID
ProjectIdNo工作空间的ID
ProtocolsYesAPI的协议,可选枚举值包括0(HTTP)和1(HTTPS)。支持多个值,多个值之间使用英文逗号(,)分隔
RegistrationDetailsNo注册API的详情,请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSONString
RequestContentTypeNo请求数据类型。- 0:xml- 1:json- 2:form
RequestMethodNoAPI的请求方式,可选枚举值包括0(GET)、1(POST)、2(PUT)和3(DELETE)。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE
ResourceGroupIdNo独享资源组ID
ResponseContentTypeNoAPI的返回数据类型,可选枚举值包括0(JSON)和1(XML)。向导和脚本API支持JSON,注册API支持JSON和XML
ScriptDetailsNo脚本API的详情,请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSONString
SqlModeNo0-基础模式。-1-mybatis
TenantIdNo租户ID
TimeoutNo超时时间,单位为毫秒(ms),取值范围为(0,30000]
VisibleRangeNo可见范围,可选枚举值包括0(工作空间)和1(私有)
WizardDetailsNo向导API的详情,请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSONString

Input Schema (JSON Schema)

{ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "ApiDescription": { "description": "API的描述信息", "type": "string" }, "ApiMode": { "description": "API的类型,可选枚举值包括0(向导API)、1(脚本API)和2(注册API)" }, "ApiName": { "description": "API的名称,支持汉字、英文、数字和下划线(_),且只能以英文和汉字开头,4~50个字符", "type": "string" }, "ApiPath": { "description": "API的路径,支持英文、数字、下划线(_)和连字符(-),且只能以斜线(/)开头,不能超过200个字符", "type": "string" }, "FolderId": { "description": "创建API的目标文件夹ID,业务流程下根文件夹ID等于0,用户自建文件夹ID大于0" }, "GroupId": { "description": "业务流程的ID", "type": "string" }, "ProjectId": { "description": "工作空间的ID" }, "Protocols": { "description": "API的协议,可选枚举值包括0(HTTP)和1(HTTPS)。支持多个值,多个值之间使用英文逗号(,)分隔", "type": "string" }, "RegistrationDetails": { "description": "注册API的详情,请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSONString", "type": "string" }, "RequestContentType": { "description": "请求数据类型。- 0:xml- 1:json- 2:form" }, "RequestMethod": { "description": "API的请求方式,可选枚举值包括0(GET)、1(POST)、2(PUT)和3(DELETE)。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE" }, "ResourceGroupId": { "description": "独享资源组ID" }, "ResponseContentType": { "description": "API的返回数据类型,可选枚举值包括0(JSON)和1(XML)。向导和脚本API支持JSON,注册API支持JSON和XML" }, "ScriptDetails": { "description": "脚本API的详情,请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSONString", "type": "string" }, "SqlMode": { "description": "0-基础模式。-1-mybatis" }, "TenantId": { "description": "租户ID" }, "Timeout": { "description": "超时时间,单位为毫秒(ms),取值范围为(0,30000]" }, "VisibleRange": { "description": "可见范围,可选枚举值包括0(工作空间)和1(私有)" }, "WizardDetails": { "description": "向导API的详情,请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSONString", "type": "string" } }, "required": [ "ApiName", "GroupId", "Protocols", "ApiPath", "ApiDescription" ], "type": "object" }

You must be authenticated.

Other Tools from DataWorks MCP Server

Related Tools

ID: 5xvvskonjr