LeadAPIValidationUtilOOB - 범위 지정됨

  • 릴리스 버전: Yokohama
  • 업데이트 날짜 2025년 01월 30일
  • 읽기5분

    • LeadAPIValidationUtilOOB 스크립트 포함은 리드 기록 및 관련 리드 라인 항목 기록이 생성(POST) 또는 업데이트(PATCH)될 때 해당 기록을 확인하기 위해 리드 REST API에서 호출하는 메서드를 제공합니다.

    메서드가 호출될 때 리드 API 리드 기록의 유효성을 검사하는 방법을 사용자 지정하려면 LeadAPIValidationUtil 스크립트 포함에 포함된 이 스크립트의 메서드를 재정의합니다. LeadAPIValidationUtil 스크립트 포함에서 재정의하는 메서드의 이름은 LeadAPIValidationUtilOOB 스크립트 포함 파일의 이름과 같아야 합니다.

    이 API는 sn_lead_mgmt_core 네임스페이스 내에서 제공됩니다. API에 액세스하려면 인스턴스에서 sn_lead_mgmt_core(리드 관리 데이터 모델) 플러그인을 활성화해야 하며 호출 사용자에게 sn_lead_mgmt_core.lead_integrator 역할이 있어야 합니다.

    에 대한 리드 관리자세한 내용은 를 참조하십시오 Using Lead Management.

    LeadAPIValidationUtilOOB - validateLeadObjectForPatchCall(객체 leadObject)

    리드 API의 PATCH 엔드포인트를 사용하여 리드 기록을 업데이트할 때 지정된 리드 및 관련 라인 항목에 대해 전달된 필드를 확인합니다.

    이 메서드는 LeadAPIValidationUtilOOB 스크립트 포함의 processUpdateLead() 메서드에 의해 트리거됩니다. 이 메서드는 다음과 같은 다양한 유효성 검사를 수행합니다.
    • 필수 필드 확인
    • 전화 번호와 이메일 주소의 형식이 올바른지 확인합니다.
    • 잘못된 값을 무시하고 선택 및 참조 필드를 검사합니다.
    • 스테이지를 확인하고 사용자가 리드를 우량으로 선별하려고 하면 오류가 발생합니다.
    표 1. 매개변수
    이름 유형 설명
    leadObject 객체 지정된 리드 기록 및 관련 리드 라인 항목 기록에서 업데이트할 필드입니다. 전달할 수 있는 필드 목록과 관련 요구 사항은 문서를 lead - 패치 /sn_lead_mgmt_core/lead/{sys_id}참조하십시오.
    표 2. 반환
    유형 설명
    <JSON 객체> 유효성 검사 결과입니다.
    {
  "errors": [Array],
  "indexesOfleadLineItemsForInsertion": [Array] 
}
    <JSON 객체>.errors 통과된 리드 및 리드 라인 항목 객체를 확인하는 동안 탐지된 오류의 상세 정보입니다. 오류가 탐지되지 않으면 빈 배열을 반환합니다.
    예:
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    이러한 오류 메시지는 LeadAPIConstantsOOB 스크립트 포함에 있습니다.

    데이터 유형: 객체 배열
    <JSON object>.indexesOfleadLineItemsForInsertion leadObject에 삽입해야 하는 새 리드 라인 항목의 인덱스입니다.

    데이터 유형: 정수 배열

    다음 코드 예제에서는 LeadAPIValidationUtil 스크립트 포함에서 validateLeadObjectForPatchCall() 메서드에 대한 사용자 지정 코드를 추가할 위치를 보여 줍니다.

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here

validateLeadObjectForPatchCall: function(leadObject) { 
// Add your custom code here
}, 

type: 'LeadAPIValidationUtil' 

});

    LeadAPIValidationUtilOOB - validateLeadObjectForPostCall(객체 leadObject)

    리드 API의 POST 엔드포인트를 사용하여 리드 기록을 생성할 때 지정된 리드 및 관련 라인 항목에 대해 전달된 필드를 확인합니다.

    이 메서드는 LeadAPIValidationUtilOOB 스크립트 포함의 processCreateLead() 메서드에 의해 트리거됩니다. 이 메서드는 다음과 같은 다양한 유효성 검사를 수행합니다.
    • 필수 필드를 확인합니다.
    • 전화 번호와 이메일 주소의 형식이 올바른지 확인합니다.
    • 잘못된 값을 무시하고 선택 및 참조 필드를 검사합니다.
    표 3. 매개변수
    이름 유형 설명
    leadObject 객체 새 리드 기록 및 관련 리드 라인 항목 기록에 삽입할 필드입니다. 전달할 수 있는 필드 목록과 관련 요구 사항은 문서를 리드 - POST /sn_lead_mgmt_core/리드참조하십시오.
    표 4. 반환
    유형 설명
    배열 통과된 리드 및 리드 라인 항목 객체를 확인하는 동안 탐지된 오류의 상세 정보입니다. 오류가 탐지되지 않으면 빈 배열을 반환합니다.
    예:
    [
  {"email":"Invalid email address."},
  {"last_name":"Mandatory field is either missing or invalid."},
  {"lead_line_items[0]/product_offering":"Mandatory field is either missing or invalid."}
]

    이러한 오류 메시지는 LeadAPIConstantsOOB 스크립트 포함에 있습니다.

    다음 코드 예제에서는 LeadAPIValidationUtil 스크립트 포함에서 validateLeadObjectForPostCall() 메서드에 대한 사용자 지정 코드를 추가할 위치를 보여 줍니다.

    var LeadAPIValidationUtil = Class.create(); 

LeadAPIValidationUtil.prototype = Object.extendsObject(LeadAPIValidationUtilOOB, { 

// Define overriding functions here 

validateLeadObjectForPostCall: function(leadObject) { 
// Add your custom code
}, 

type: 'LeadAPIValidationUtil' 

});