LeadAPIProcessUtilOOB - 범위 지정됨

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 07월 31일
  • 소요 시간: 10분

    • LeadAPIProcessUtilOOB 스크립트 포함은 리드 REST API에서 호출하여 리드 기록 및 관련 리드 라인 항목 기록을 검색하는 메서드를 제공합니다.

    메서드가 호출될 때 리드 API 리드 기록을 검색하는 방법을 사용자 지정하려면 LeadAPIProcessUtil 스크립트 포함에 있는 이 스크립트 포함의 메서드를 재정의하십시오. LeadAPIProcessUtil 스크립트 포함에서 재정의하는 메서드의 이름은 LeadAPIProcessUtilOOB 스크립트 포함 파일의 이름과 같아야 합니다.

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

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

    LeadAPIProcessUtilOOB - processCreateLead(객체 requestBody)

    요청 본문을 처리하고 전달된 매개변수를 기반으로 리드 및 모든 관련 라인 항목을 생성합니다.

    기록은 다음 테이블에 삽입됩니다.
    • 리드 [sn_lead_mgmt_core_lead]
    • 리드 라인 항목 [sn_lead_mgmt_core_lead_line_item]
    표 1. 매개변수
    이름 유형 설명
    requestBody 객체 생성할 리드 및 관련 리드 라인 항목의 본문을 요청합니다.

    이 객체의 내용에 대한 자세한 내용은 을 참조하십시오 리드 - POST /sn_lead_mgmt_core/리드.
    표 2. 반환
    유형 설명
    JSON 객체 저장된 리드 및 리드 라인 항목 기록의 상세 정보입니다.

    데이터 유형: 객체

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.body 응답 본문.

    성공적인 응답: 요청된 리드 기록 내의 모든 필드와 연결된 리드 라인 항목 레코드의 모든 필드입니다. 반환되는 필드에 대한 설명은 을 리드 - POST /sn_lead_mgmt_core/리드참조하십시오.

    오류 응답: 요청을 처리하려고 할 때 감지된 오류 목록입니다. 이러한 오류 메시지는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 객체
    <JSONobject>.status 응답 상태 코드입니다.

    이러한 상태 코드는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 문자열

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

processCreateLead: function(requestBody) { 
// Add your custom code 
}, 

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB - processGetAllLeads(객체 queryParams, 문자열 requestUrl)

    전달된 필터 기준에 따라 모든 리드 기록 및 관련 라인 항목 기록을 검색합니다. 이 메서드는 연결된 기록 내의 모든 필드를 반환합니다.

    기록 상세 정보는 다음 테이블에서 가져옵니다.
    • 리드 [sn_lead_mgmt_core_lead]
    • 리드 라인 항목 [sn_lead_mgmt_core_lead_line_item]
    표 3. 매개변수
    이름 유형 설명
    queryParams 객체 리드 기록을 검색할 때 적용할 쿼리 매개변수를 포함하는 객체입니다. 엔드포인트에 전달되는 쿼리 매개변수입니다 리드 - GET /sn_lead_mgmt_core/리드 .
    예: 
    {
  "sysparm_fields":["first_name,last_name,sys_id,lead_line_items"],
  "sysparm_query":["lead_type=new_business"],
  "sysparm_offset":["2"],"sysparm_limit":["25"]
}
    requestUrl 문자열 URL 요청 메서드가 응답의 모든 페이지에 대한 링크를 갖도록 페이지 매김된 응답을 처리할 때 이 URL을 전달합니다.
    표 4. 반환
    유형 설명
    JSON 객체 요청된 리드 및 리드 라인 항목 기록의 상세 정보입니다.

    데이터 유형: 객체

    {
  "body": [Array],
  "contentRange": "String",
  "links": "String", 
  "status": "String",
  "totalCount": "Number" 
}

    요청을 처리하는 동안 오류가 발생하면 JSON 객체에는 body 및 status 매개변수만 포함됩니다.
    <JSONobject>.body 응답 본문.

    성공적인 응답: 각 객체가 리드 기록과 연결된 모든 리드 라인 항목 기록을 포함하는 객체의 배열입니다. 요청된 리드 기록 내의 모든 필드와 연결된 리드 라인 항목 레코드의 모든 필드가 반환됩니다. 반환되는 필드에 대한 설명은 을 리드 - GET /sn_lead_mgmt_core/리드참조하십시오.

    오류 응답: 요청을 처리하려고 할 때 감지된 오류 목록입니다. 이러한 오류 메시지는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 객체 배열
    <JSONobject>.contentRange 페이지 매김된 호출에서 반환된 콘텐츠의 범위입니다.

    예를 들어, offset=2 및 limit=3인 경우 이 매개변수의 값은 항목 3-5입니다.

    데이터 유형: 문자열
    <JSONobject>.links 페이지 매김된 응답의 경우 응답에 포함된 각 페이지에 대한 링크(쉼표로 구분됨)입니다.
    예:
    <https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=0&sysparm_limit=20>;rel="self",
<https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=20&sysparm_limit=20>;rel="last",
<https://servicenow-instance/api/sn_lead_mgmt_core/lead?sysparm_offset=20&sysparm_limit=20>;rel="next"

    데이터 유형: 문자열
    <JSONobject>.status 응답 상태 코드입니다.

    이러한 상태 코드는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 문자열
    <JSONobject>.totalCount 메서드에서 반환한 총 리드 기록 수입니다.

    데이터 유형: 숫자(정수)

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here 

processGetAllLeads: function(queryParams, requestUrl) { 
// Add your custom code here 
}, 

type: 'LeadAPIProcessUtil' 
});

    LeadAPIProcessUtilOOB - processGetLeadById(문자열 ID)

    지정된 리드 기록과 관련 라인 항목 기록을 조회합니다. 이 메서드는 연결된 기록 내의 모든 필드를 반환합니다.

    기록 상세 정보는 다음 테이블에서 가져옵니다.
    • 리드 [sn_lead_mgmt_core_lead]
    • 리드 라인 항목 [sn_lead_mgmt_core_lead_line_item]
    표 5. 매개변수
    이름 유형 설명
    ID 문자열 검색할 리드 기록의 Sys_id입니다.

    테이블: 리드 [sn_lead_mgmt_core_lead]
    표 6. 반환
    유형 설명
    JSON 객체 요청된 리드 및 리드 라인 항목 기록의 상세 정보입니다.

    데이터 유형: 객체

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.body 응답 본문.

    성공적인 응답: 요청된 리드 기록 내의 모든 필드와 연결된 리드 라인 항목 레코드의 모든 필드입니다. 반환되는 필드에 대한 설명은 을 리드 - GET /sn_lead_mgmt_core/lead/{sys_id}참조하십시오.

    오류 응답: 요청을 처리하려고 할 때 감지된 오류 목록입니다. 이러한 오류 메시지는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 객체
    <JSONobject>.status 응답 상태 코드입니다.

    이러한 상태 코드는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 문자열

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

    var LeadAPIProcessUtil = Class.create(); 

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { 

// Define overriding functions here

processGetLeadById: function(id) { 
  // Add your custom code here
}, 

type: 'LeadAPIProcessUtil' 

});

    LeadAPIProcessUtilOOB - processUpdateLead(객체 requestBody, 문자열 ID)

    요청 본문을 처리하고 전달된 매개변수를 기반으로 지정된 리드 및 연관된 모든 라인 항목을 업데이트합니다.

    기록은 다음 테이블에서 업데이트됩니다.
    • 리드 [sn_lead_mgmt_core_lead]
    • 리드 라인 항목 [sn_lead_mgmt_core_lead_line_item]
    표 7. 매개변수
    이름 유형 설명
    requestBody 객체 업데이트할 리드의 본문과 관련 리드 라인 항목 필드를 요청합니다.

    이 객체의 내용에 대한 자세한 내용은 을 참조하십시오 lead - 패치 /sn_lead_mgmt_core/lead/{sys_id}.
    ID 문자열 업데이트할 리드 기록의 Sys_id입니다.

    테이블: 리드 [sn_lead_mgmt_core_lead]
    표 8. 반환
    유형 설명
    JSON 객체 저장된 리드 및 리드 라인 항목 기록의 상세 정보입니다.

    데이터 유형: 객체

    {
  "body": {Object},
  "status": "String"
}
    <JSONobject>.body 응답 본문.

    성공적인 응답: 업데이트된 잠재 고객 기록의 모든 필드 및 연결된 잠재 고객 라인 항목 기록의 모든 필드(업데이트 여부와 무관함). 반환되는 필드에 대한 설명은 을 lead - 패치 /sn_lead_mgmt_core/lead/{sys_id}참조하십시오.

    오류 응답: 요청을 처리하려고 할 때 감지된 오류 목록입니다. 이러한 오류 메시지는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 객체
    <JSONobject>.status 응답 상태 코드입니다.

    이러한 상태 코드는 LeadAPIConstants 스크립트 포함에 정의되어 있습니다.

    데이터 유형: 문자열

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

    var LeadAPIProcessUtil = Class.create();

LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, {

// Define overriding functions here 

processUpdateLead: function(requestBody, id) { 
// Add your custom code here
},

type: 'LeadAPIProcessUtil' 

});