すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateDataServiceApi

    ドキュメントセンター

    DataWorks:CreateDataServiceApi

    最終更新日:Mar 21, 2026

    API を作成します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TenantId

    integer

    任意

    テナント ID。

    10001
    ProjectId

    integer

    必須

    ワークスペース ID。

    10000
    ApiName

    string

    必須

    API の名前。名前の長さは 4～50 文字である必要があります。名前に使用できるのは、英字、数字、アンダースコア (_) で、先頭は英字である必要があります。

    Test API name

    GroupId

    string

    必須

    ビジネスプロセス ID。

    Business process ID
    ApiMode

    integer

    必須

    API のタイプ。有効な値：0、1、2。値 0 は、API がウィザードモードで生成されることを示します。値 1 は、API がスクリプトモードで生成されることを示します。値 2 は、API が登録によって生成されることを示します。

    0
    RequestMethod

    integer

    必須

    API のリクエストメソッド。有効な値：0、1、2、3。値 0 は GET メソッドを示します。値 1 は POST メソッドを示します。値 2 は PUT メソッドを示します。値 3 は DELETE メソッドを示します。ウィザードモードまたはスクリプトモードで生成された API は、GET メソッドと POST メソッドをサポートします。登録によって生成された API は、GET、POST、PUT、DELETE メソッドをサポートします。

    0
    ResponseContentType

    integer

    必須

    API リクエストの応答が返されるフォーマット。有効な値：0 と 1。値 0 は JSON フォーマットを示します。値 1 は XML フォーマットを示します。ウィザードモードまたはスクリプトモードで生成された API は JSON フォーマットをサポートします。登録によって生成された API は JSON と XML フォーマットをサポートします。

    0
    Timeout

    integer

    必須

    API リクエストのタイムアウト期間。単位：ミリ秒。有効な値の範囲：(0,30000]。

    10000
    VisibleRange

    integer

    必須

    API が表示される範囲。有効な値：0 と 1。値 0 は、API がワークスペース内のすべてのメンバーに表示されることを示します。値 1 は、API がそのオーナーにのみ表示されることを示します。

    0
    Protocols

    string

    必須

    API で使用されるプロトコル。有効な値：0 と 1。値 0 は HTTP を示します。値 1 は HTTPS を示します。複数のプロトコルを指定できます。コンマ (,) で区切ります。

    0,1
    WizardDetails

    string

    任意

    ウィザードモードで生成された API の詳細。詳細については、GetDataServiceApi 操作によって返される WizardDetails パラメーターをご参照ください。

    {"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}
    ScriptDetails

    string

    任意

    スクリプトモードで生成された API の詳細。詳細については、GetDataServiceApi 操作によって返される scriptDetails パラメーターをご参照ください。

    {"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}
    RegistrationDetails

    string

    任意

    登録によって生成された API の詳細。詳細については、GetDataServiceApi 操作によって返される registrationDetails パラメーターをご参照ください。

    {"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}
    ApiPath

    string

    必須

    API のパス。パスの長さは 200 文字を超えることはできません。パスには、英字、数字、アンダースコア (_)、ハイフン (-) を使用でき、先頭はスラッシュ (/) である必要があります。

    /test/1
    ApiDescription

    string

    必須

    API の説明。

    Test API description
    FolderId

    integer

    任意

    API を格納するために使用されるフォルダの ID。ビジネスプロセス内のルートフォルダの ID は 0 です。ユーザーが作成したフォルダの ID は 0 より大きい必要があります。

    0
    SqlMode

    integer

    任意

    • SQL モード。有効な値：0：基本モードが使用されます。

    • 1：Mybatis が使用されます。

    0
    ResourceGroupId

    integer

    任意

    専用リソースグループの ID。

    3242432423
    RequestContentType

    integer

    任意

    リクエストするデータのフォーマット。有効な値：

    • 0：XML フォーマット

    • 1：JSON フォーマット

    • 2：form フォーマット

    0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Data

    integer

    API の ID。

    100003
    ErrorMessage

    string

    エラーメッセージ。

    The connection does not exist.
    RequestId

    string

    リクエスト ID。

    0000-ABCD-EFG****
    ErrorCode

    string

    エラーコード。

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。