Especificación de API de REST de validaciones personalizadas externas

Cloud EDM llama a esta API cuando los elementos de solicitud se validan mediante una validación personalizada externa. El sistema externo valida los datos de la solicitud y devuelve mensajes de validación para cualquier elemento de solicitud o acción que falle la validación. A continuación, Cloud EDM utiliza la respuesta para mostrar las incidencias de validación con la gravedad especificada en la validación personalizada.

Recurso REST

Para ejecutar validaciones personalizadas externas:

Método HTTP: POST

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

Ejemplo de ruta: /api/rest/externalValidation

Para probar la conexión global de validación externa: (consulte Creación de conexiones globales)

Método HTTP: GET

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

Ejemplo de ruta: /api/rest/externalValidation

Autentificación

Las solicitudes HTTP al sistema externo deben proporcionar las credenciales de autenticación HTTP básica a través de la cabecera Authorization.

Solicitud de API

Tipos de medio admitidos: application/json

En la siguiente tabla se resume la solicitud del cliente.

Solicitud de ejemplo

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

Respuesta de API

Tipo de medio soportado: application/json

Ejemplo de respuesta

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

Ejemplo

En el siguiente ejemplo, se muestra cómo ejecutar una validación externa mediante el envío de una solicitud POST en el recurso de REST mediante cURL.

Comando cURL

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