Specifica API REST convalida customizzata esterna

Cloud EDM chiama questa API quando gli elementi richiesta vengono convalidati utilizzando una convalida customizzata esterna. Il sistema esterno convalida i dati della richiesta e restituisce i messaggi di convalida per eventuali elementi o azioni della richiesta che non superano la convalida. La risposta viene quindi utilizzata da Cloud EDM per visualizzare i problemi di convalida con la severità specificata nella convalida customizzata.

Risorsa REST

Per eseguire convalide customizzate esterne, procedere come segue.

Metodo HTTP: POST

Percorso: percorso di convalida esterna configurato così come è stato definito nella connessione globale di convalida esterna

Esempio di percorso: /api/rest/externalValidation

Per testare la connessione globale di convalida esterna, procedere come segue (fare riferimento a Creazione di connessioni globali).

Metodo HTTP: GET

Percorso: percorso di convalida esterna configurato così come è stato definito nella connessione globale di convalida esterna

Esempio di percorso: /api/rest/externalValidation

Autenticazione

Le richieste HTTP al sistema esterno devono fornire le credenziali di autenticazione di base HTTP tramite l'intestazione Autorizzazione.

Richiesta API

Tipi di supporti disponibili: application/json

Nella seguente tabella è riepilogata la richiesta client.

Richiesta di esempio

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

Risposta API

Tipo di supporto supportato: application/json

Risposta di esempio

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

Esempio

L'esempio seguente mostra come eseguire una convalida esterna sottomettendo una richiesta di invio per la risorsa REST utilizzando 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