外部自訂驗證 REST API 規格

當要求項目透過外部自訂驗證進行驗證時，Cloud EDM 會呼叫此 API。外部系統會驗證要求資料，並針對驗證失敗的任何要求項目或動作傳回驗證訊息。Cloud EDM 接著會使用此回應，以該自訂驗證中所指定的嚴重性顯示驗證問題。

REST 資源

執行外部自訂驗證：

HTTP 方法：POST

路徑：外部驗證全域連線中定義的已設定外部驗證路徑

路徑範例：/api/rest/externalValidation

測試外部驗證全域連線： (請參閱建立全域連線)

HTTP 方法：GET

路徑：外部驗證全域連線中定義的已設定外部驗證路徑

路徑範例：/api/rest/externalValidation

驗證

對外部系統的 HTTP 要求，應透過 Authorization 標頭提供「HTTP 基本驗證」證明資料。

API 要求

支援的媒體類型：application/json

下表彙總用戶端要求。

要求範例

{
  "requestId": "edm_request_id",
  "applicationId": "edm_application_id",
  "validationId": "edm_custom_validation_id",
  "validationKey": "external_program_name",
  "data": [
    {
      "dimensionId": "edm_dimension_id",
      "dimensionName": "dimension_name",
      "nodeTypeId": "edm_node_type_id",
      "dataSetKey": "external_data_set_name",
      "nodes": [
        {
          "nodeName": "edm_node_name",
          "actions": [
            {
              "actionId": "edm_action_id",
              "actionType": "add",
              "parentName": "edm_parent_node_name"
            },
            {
              "actionId": "edm_action_id",
              "actionType": "delete",
              "parentName": "edm_parent_node_name"
            },
            {
              "actionId": "edm_action_id",
              "actionType": "insert",
              "parentName": "edm_parent_node_name"
            },
            {
              "actionId": "edm_action_id",
              "actionType": "remove",
              "parentName": "edm_parent_node_name"
            },
            {
              "actionId": "edm_action_id",
              "actionType": "move",
              "parentName": "edm_parent_name",
              "oldParentName": "edm_old_parent_name"
            },
            {
              "actionId": "edm_action_id",
              "actionType": "reorder",
              "parentName": "edm_parent_node_name",
              "previousSibling": "edm_previous_sibling"
            },
            {
              "actionId": "edm_action_id",
              "actionType": "rename",
              "parentName": "edm_parent_node_name",
              "newName": "edm_new_name"
            },
            {
              "actionId": "edm_action_id",
              "actionType": "update",
              "propertyName": "edm_property_name",
              "propertyFromValue": "edm_property_from_value",
              "propertyToValue": "edm_property_to_value",
              "parentName": "edm_parent_node_name"
            }
          ]
        }
      ]
    }
  ]
}

API 回應

支援的媒體類型：application/json

回應範例

{
  "requestId": "edm_request_id",
  "applicationId": "edm_application_id",
  "validationId": "edm_custom_validation_id",
  "validationKey": "external_program_name",
  "data": [
    {
      "dimensionId": "edm_dimension_id",
      "nodeTypeId": "edm_node_type_id",
      "dataSetKey": "external_data_set_name",
      "nodes": [
        {
          "nodeName": "edm_node_name",
          "message": "external_validation_message",
          "severity": "warning",
          "validationMessages": [
            {
              "actionId": "edm_action_id",
              "actionType": "delete",
              "message": "external_validation_message",
              "severity": "error"
            }
          ]
        }
      ]
    }
  ]
}

範例

下列範例顯示如何透過 cURL 在 REST 資源上提交 POST 要求，以執行外部驗證。

cURL 命令

curl --user external_user -X POST -H "Content-Type: application/json" -d @example_request_payload.json https://externalhostname.example.com/api/rest/externalValidation