Spécification d'API REST de validation personnalisée externe

Cloud EDM appelle cette API lorsque des éléments de demande sont validés à l'aide d'une validation personnalisée externe. Le système externe valide les données de la demande et renvoie des messages de validation pour tout élément ou toute action de demande dont la validation échoue. La réponse est ensuite utilisée par Cloud EDM pour afficher les problèmes de validation avec la gravité indiquée dans la validation personnalisée.

Ressource REST

Pour exécuter des validations personnalisées externes :

Méthode HTTP : POST

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

Exemple de chemin : /api/rest/externalValidation

Pour tester la connexion globale de validation externe (reportez-vous à la section Création de connexions globales) :

Méthode HTTP : GET

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

Exemple de chemin : /api/rest/externalValidation

Authentification

Les demandes HTTP adressées au système externe doivent fournir les informations d'identification d'authentification de base HTTP via l'en-tête Authorization.

Demande d'API

Types de support pris en charge : application/json

Le tableau suivant récapitule la demande client.

Exemples de demande

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

Réponse d'API

Type de support pris en charge : application/json

Exemple de réponse

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

Exemple

L'exemple suivant montre comment exécuter une validation externe en soumettant une requête POST sur la ressource REST à l'aide de cURL.

Commande cURL

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