更新时间:2024-04-01 GMT+08:00
分享

步骤3:提交事务型任务

操作场景

工业数字模型驱动引擎-数据建模引擎(xDM Foundation,简称xDM-F)提供同步提交和异步提交两种提交方式。

URI

  • 同步提交
    • URI格式:

      PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/v1/transaction-apis/transactions/{transaction-id}

    • 参数说明:
      表1 URI参数说明

      参数

      是否必填

      参数类型

      描述

      Endpoint

      String

      承载REST服务端点的服务器域名或IP地址。

      appID

      String

      应用ID。

      transaction-id

      Long

      事务型任务ID,即步骤1:创建事务型任务返回的transactionId。

  • 异步提交
    • URI格式:
      • v1版本:PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/v1/transaction-apis/transactions/async/{transaction-id}
      • v2版本:PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/v2/transaction-apis/transactions/async/{transaction_id}?api_count=N
    • 参数说明:
      表2 URI参数说明

      参数

      是否必填

      参数类型

      描述

      Endpoint

      String

      承载REST服务端点的服务器域名或IP地址。

      appID

      String

      应用ID。

      transaction-id

      Long

      说明:

      仅v1版本接口需要配置此参数。

      事务型任务ID,即步骤1:创建事务型任务返回的transactionId。

      transaction_id

      Long

      说明:

      仅v2版本接口需要配置此参数。

      事务型任务ID,即步骤1:创建事务型任务返回的transactionId。

      api_count

      Integer

      说明:

      仅v2版本接口需要配置此参数。

      需要提交执行原子接口的数量。

      该参数会以“?api_count=N”格式拼接在URI后面,其中“N”表示需要提交执行原子接口的数量。

请求参数

“同步提交”的请求参数和“异步提交”的请求参数相同。

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户的token。

响应参数

  • 同步提交
    表4 响应Body参数

    参数

    参数类型

    描述

    result

    String

    调用是否成功。

    • SUCCESS:成功
    • FAIL:失败

    data

    List of data

    调用的返回结果。

    errors

    List

    异常信息列表。

    表5 data

    参数

    参数类型

    描述

    data.id

    Long

    事务型任务ID。

    data.status

    String

    事务型任务是否提交成功。步骤2:执行iDME原子接口执行的任一原子接口若执行失败,均表示事务型任务提交失败。

    • success:成功
    • fail:失败

    data.tasks

    List of task

    事务型任务下的原子接口列表。

    表6 tasks

    参数

    参数类型

    描述

    data.tasks.result

    String

    原子接口的执行详情。

    data.tasks.task_no

    Integer

    原子接口的执行序号。

    data.tasks.task_status

    String

    原子接口的执行状态。

    • success:成功
    • fail:失败
  • 异步提交
    表7 响应Body参数

    参数

    参数类型

    描述

    result

    String

    调用是否成功。

    • SUCCESS:成功
    • FAIL:失败

    data

    List

    调用的返回结果,默认为空。

    errors

    List

    异常信息列表。

请求示例

  • 同步提交
    PUT https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/v1/transaction-apis/transactions/538322343718555649
    X-Auth-Token: ABCDEFJ....
  • 异步提交
    • v1版本请求示例:
      PUT https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/v1/transaction-apis/transactions/async/538322343718555649
      X-Auth-Token: ABCDEFJ....
    • v2版本请求示例:
      PUT https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/v2/transaction-apis/transactions/async/538322343718555650?api_count=2
      X-Auth-Token: ABCDEFJ....

响应示例

  • 同步提交
    {
        "result": "SUCCESS",
        "data": [
            {
                "id": 538322343718555649,
                "status": "success",
                "tasks": [
                    {
                        "result": "{\"id\": 538327077254860800, \"tenant\": {\"id\": -1, \"code\": \"basicTenant\", \"name\": \"basicTenant\", \"creator\": \"xdmAdmin\", \"modifier\": \"xdmAdmin\", \"className\": \"Tenant\", \"createTime\": 1688108575000, \"dataSource\": \"DefaultDataSource\", \"rdmVersion\": 1, \"description\": \"默认租户\", \"disableFlag\": false, \"rdmDeleteFlag\": 0, \"securityLevel\": \"internal\", \"lastUpdateTime\": 1688108575000, \"rdmExtensionType\": \"Tenant\"}, \"creator\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"extAttrs\": [{\"name\": \"ExtString\", \"type\": \"STRING\", \"value\": \"0123\"}, {\"name\": \"ExtDouble\", \"type\": \"DECIMAL\"}], \"modifier\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"className\": \"ExtDataModel\", \"createTime\": 1693367976851, \"extAttrMap\": {}, \"rdmVersion\": 1, \"rdmDeleteFlag\": 0, \"lastUpdateTime\": 1693367976851, \"rdmExtensionType\": \"ExtDataModel\"}",
                        "task_no": 1,
                        "task_status": "success"
                    },
                    {
                        "result": "{\"id\": 535837830857887744, \"tenant\": {\"id\": -1, \"code\": \"basicTenant\", \"name\": \"basicTenant\", \"creator\": \"xdmAdmin\", \"modifier\": \"xdmAdmin\", \"className\": \"Tenant\", \"createTime\": 1688108575000, \"dataSource\": \"DefaultDataSource\", \"rdmVersion\": 1, \"description\": \"默认租户\", \"disableFlag\": false, \"rdmDeleteFlag\": 0, \"securityLevel\": \"internal\", \"lastUpdateTime\": 1688108575000, \"rdmExtensionType\": \"Tenant\"}, \"creator\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"extAttrs\": [{\"name\": \"ExtString\", \"type\": \"STRING\", \"value\": \"1234056789\"}, {\"name\": \"ExtDouble\", \"type\": \"DECIMAL\"}], \"modifier\": \"XDM_Developer 93172bbfd0f64437956d4c9de9345386\", \"className\": \"ExtDataModel\", \"createTime\": 1692774494000, \"extAttrMap\": {}, \"rdmVersion\": 38, \"rdmDeleteFlag\": 0, \"lastUpdateTime\": 1693367978040, \"rdmExtensionType\": \"ExtDataModel\"}",
                        "task_no": 2,
                        "task_status": "success"
                    }
                ],
                "task_count": 2
            }
        ],
        "errors": []
    }
  • 异步提交
     {
          "result": "SUCCESS",
          "data": [],
          "errors": []
      }
分享:

    相关文档

    相关产品