Spezifikation für externe benutzerdefinierte Validierungs-REST-API

Cloud EDM ruft diese API auf, wenn Anforderungselemente mit einer externen benutzerdefinierten Validierung validiert werden. Das externe System validiert die Anforderungsdaten und gibt Validierungsmeldungen für alle Anforderungselemente oder Aktionen zurück, für die die Validierung nicht erfolgreich war. Die Antwort wird dann von Cloud EDM verwendet, um die Validierungsprobleme mit dem in der benutzerdefinierten Validierung angegebenen Schweregrad anzuzeigen.

REST-Ressource

So führen Sie externe benutzerdefinierte Validierungen aus:

HTTP-Methode: POST

Pfad: Configured external validation path as defined in the External Validation global connection

Pfadbeispiel: /api/rest/externalValidation

So testen Sie die globale Verbindung für die externe Validierung (siehe Globale Verbindungen erstellen):

HTTP-Methode: GET

Pfad: Configured external validation path as defined in the External Validation global connection

Pfadbeispiel: /api/rest/externalValidation

Authentifizierung

HTTP-Anforderungen an das externe System müssen Zugangsdaten zur HTTP-Basisauthentifizierung über den Authorization-Header bereitstellen.

API-Anforderung

Unterstützte Medientypen: application/json

Die folgende Tabelle enthält eine Übersicht der Clientanforderung.

Beispielanforderung

{
  "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-Antwort

Unterstützter Medientyp: application/json

Beispielantwort

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Beispiel

Das folgende Beispiel zeigt, wie Sie eine externe Validierung ausführen, indem Sie eine POST-Anforderung für die REST-Ressource mit cURL weiterleiten.

cURL-Befehl

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