すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateDataServiceApi

    ドキュメントセンター

    DataWorks:CreateDataServiceApi

    最終更新日:Jul 31, 2026

    データサービス API を作成します。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TenantId

    integer

    任意

    テナント ID。

    10001
    ProjectId

    integer

    必須

    ワークスペース ID。

    10000
    ApiName

    string

    必須

    API の名前。名前には中国語文字、英字、数字、アンダースコア (_) を含めることができ、先頭は英字または中国語文字である必要があります。名前の長さは 4～50 文字です。

    テスト API 名
    GroupId

    string

    必須

    ビジネスプロセスの ID。

    ビジネスプロセス ID
    ApiMode

    integer

    必須

    API のタイプ。有効な値: 0 (ウィザード API)、1 (スクリプト API)、2 (登録 API)。

    0
    RequestMethod

    integer

    必須

    API のリクエストメソッド。有効な値: 0 (GET)、1 (POST)、2 (PUT)、3 (DELETE)。ウィザード API およびスクリプト API は GET と POST をサポートします。登録 API は GET、POST、PUT、DELETE をサポートします。

    0
    ResponseContentType

    integer

    必須

    API の応答データの型。有効な値: 0 (JSON)、1 (XML)。ウィザード API およびスクリプト API は JSON をサポートします。登録 API は JSON と XML をサポートします。

    0
    Timeout

    integer

    必須

    タイムアウト期間 (ミリ秒単位)。有効な値: (0, 30000]。

    10000
    VisibleRange

    integer

    必須

    可視性。有効な値: 0 (ワークスペース)、1 (非公開)。

    0
    Protocols

    string

    必須

    API のプロトコル。有効な値: 0 (HTTP)、1 (HTTPS)。複数の値がサポートされています。複数の値はコンマ (,) で区切ります。

    0,1
    WizardDetails

    string

    任意

    ウィザード API の詳細。詳細については、 GetDataServiceApi 操作の wizardDetails フィールドの JSON 文字列を参照してください。

    {"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 フィールドの JSON 文字列を参照してください。

    {"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 フィールドの JSON 文字列を参照してください。

    {"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 の説明。

    テスト API の説明
    FolderId

    integer

    任意

    API が作成される送信先フォルダの ID。ビジネスプロセス配下のルートフォルダの ID は 0 です。ユーザーが作成したフォルダの ID は 0 より大きい値です。

    0
    SqlMode

    integer

    任意

    • 0: 基本モード。

    • 1: MyBatis モード。

    0
    ResourceGroupId

    integer

    任意

    排他的リソースグループの ID。

    3242432423
    RequestContentType

    integer

    任意

    リクエストのコンテンツタイプ。有効な値:

    • 0: XML

    • 1: JSON

    • 2: フォーム

    列挙値:

    • 0 :

      xml。

    • 1 :

      json。

    • 2 :

      フォーム

    0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    HttpStatusCode

    integer

    HTTP 状態コード。

    200
    Data

    integer

    作成された API の ID。

    100003
    ErrorMessage

    string

    エラーメッセージ。

    接続が存在しません
    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.

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

    変更履歴

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