外部カスタム検証REST API仕様

クラウドEDMは、外部カスタム検証を使用して要求アイテムが検証されるときに、このAPIをコールします。外部システムは要求データを検証し、検証に失敗した要求アイテムまたはアクションに対して検証メッセージを返します。この応答はCloud EDMによって使用され、カスタム検証で指定された重大度の検証の問題が表示されます。

RESTリソース

外部カスタム検証を実行するには:

HTTPメソッド: POST

パス: 「外部検証」グローバル接続で定義されている、構成済の外部検証パス

パスの例: /api/rest/externalValidation

「外部検証」グローバル接続をテストするには: (グローバル接続の作成を参照)

HTTPメソッド: GET

パス: 「外部検証」グローバル接続で定義されている、構成済の外部検証パス

パスの例: /api/rest/externalValidation

認証

外部システムへのHTTP要求では、Authorizationヘッダーを介してHTTP Basic認証の資格証明を提供する必要があります。

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