Especificação da API REST de Validação Personalizada Externa

O Cloud EDM chama essa API quando os itens de solicitação são validados usando uma validação personalizada Externa. O sistema externo valida os dados da solicitação e retorna mensagens de validação para quaisquer itens ou ações de solicitação que falhem na validação. Em seguida, a resposta é usada pelo Cloud EDM para exibir os problemas de validação com a severidade especificada na validação personalizada.

Recurso REST

Para executar validações personalizadas externas:

Método HTTP: POST

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

Exemplo de caminho: /api/rest/externalValidation

Para testar a conexão global de Validação Externa: (consulte Criação de Conexões Globais)

Método HTTP: POST

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

Exemplo de caminho: /api/rest/externalValidation

Autenticação

As solicitações HTTP para o sistema externo devem fornecer credenciais de Autenticação Básica HTTP por meio do cabeçalho Authorization.

Solicitação de API

Tipos de Mídia Suportados: application/json

A tabela a seguir resume a solicitação do cliente.

Solicitação de Exemplo

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

Resposta da API

Tipos de Mídia Suportados: application/json

Exemplo de Resposta

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

Exemplo

O exemplo a seguir mostra como executar uma validação externa enviando uma solicitação de postagem no recurso REST usando o 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