외부 사용자정의 검증 REST API 사양

Cloud EDM은 외부 사용자정의 검증을 사용하여 요청 항목이 검증될 때 이 API를 호출합니다. 외부 시스템은 요청 데이터를 검증하고 검증에 실패한 요청 항목 또는 작업에 대한 검증 메시지를 반환합니다. 그런 다음, Cloud EDM에서 응답을 사용하여 사용자정의 검증에 지정된 심각도와 함께 검증 이슈를 표시합니다.

REST 리소스

외부 사용자정의 검증을 실행하려면:

HTTP 메소드: POST

경로: Configured external validation path as defined in the External Validation global connection(외부 검증 글로벌 연결에 정의된 대로 구성된 외부 검증 경로)

경로 예: /api/rest/externalValidation

외부 검증 글로벌 연결을 테스트하려면:(글로벌 연결 생성 참조)

HTTP 메소드: GET

경로: Configured external validation path as defined in the External Validation global connection(외부 검증 글로벌 연결에 정의된 대로 구성된 외부 검증 경로)

경로 예: /api/rest/externalValidation

인증

외부 시스템에 대한 HTTP 요청은 Authorization 헤더를 통해 HTTP 기본 인증 인증서를 제공해야 합니다.

API 요청

지원되는 미디어 유형: application/json

다음 표에 클라이언트 요청이 요약되어 있습니다.

예제 요청

{
  "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 응답

지원되는 미디어 유형: application/json

예제 응답

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

예

다음 예제에서는 cURL을 통해 REST 리소스에 대한 게시 요청을 제출하여 외부 검증을 실행하는 방법을 보여줍니다.

cURL 명령

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