응답 템플릿 API

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

    • 응답 템플릿 API는 응답 템플릿 [sn_templated_snip_note_template] 테이블의 기록을 처리하기 위한 엔드포인트를 제공합니다.

    이 스크립트 포함에는 기본적으로 활성화되고 sn_templated_snip 네임스페이스 내에서 실행되는 템플릿 응답 플러그인(com.sn_templated_snip)이 필요합니다.

    응답 템플릿에 대한 자세한 내용은 응답 템플릿을 참조하십시오.

    응답 템플릿 - POST /response_templates/get_templates

    응답 템플릿 [sn_templated_snip_note_template] 테이블에서 기록을 반환합니다.

    URL 형식

    기본 URL: /api/sn_templated_snip/response_templates/get_templates

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    없음
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    오류 형식 오류에 사용할 HTML 서식입니다.

    데이터 유형: 문자열

    기본값: "<span style='color:#ff0000'>${%s}</span>"
    includeEvaluatedBody 템플릿 변수를 렌더링할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • false: 템플릿 변수를 렌더링하지 않습니다. 응답에는 메시지 변수가 포함되어 있습니다.
      예: 
      케이스 ${number}이(가) ${assignment_group}(으)로 에스컬레이션되었습니다.
    • true: 템플릿 변수를 렌더링하고 반환 결과에 반환합니다 evaluated_response .
      예: 
      케이스 INC100001 시설로 에스컬레이션되었습니다.

    데이터 유형: 부울

    기본값: false
    제한 반환할 응답 템플릿의 최대 수입니다.

    데이터 유형: 숫자

    기본값: 50
    오프셋 페이지 매김의 경우 검색을 시작할 인덱스입니다.

    데이터 유형: 숫자

    기본값: 0
    옵션 sn_templated_snip.response_template 확장점에 전달할 매개변수입니다. 이러한 매개변수의 형식과 내용은 확장점의 구현에 따라 달라집니다. 확장점에 대한 자세한 내용은 확장점을 사용하여 애플리케이션 기능 확장을 참조하십시오.

    데이터 유형: 객체
    recordId 필수 응답 템플릿에서 변수를 렌더링하는 데 사용할 기록의 Sys_id입니다.

    데이터 유형: 문자열
    searchTerm 일치하는 응답 템플릿 목록을 필터링하는 데 사용할 텍스트입니다.

    엔드포인트는 이름 및 본문 필드에서 이 텍스트의 CONTAINS 검색을 수행하고 짧은 이름 필드에서 STARTS WITH 검색을 수행합니다. 예를 들어 검색어가 "crash"인 경우 엔드포인트는 쿼리 조건과 일치하고 이름이나 본문에 crash가 있거나 짧은 이름이 crash로 시작하는 응답 템플릿을 반환합니다.

    짧은 이름과 정확히 일치하는 응답 템플릿이 반환 결과에 먼저 나타납니다. 반환된 다른 모든 응답 템플릿은 이름별로 정렬됩니다.

    데이터 유형: 문자열

    기본값: 일치하는 모든 응답 템플릿을 반환합니다.
    tableName 필수 응답 템플릿 테이블을 검색하여 해당 응답 템플릿을 찾는 데 사용할 테이블의 이름입니다. 예: "인시던트" 또는 "sn_hr_core_case".

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    컨텐츠-형식 요청 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과

    지정된 검색 기준과 일치하는 모든 템플릿을 나열하는 객체의 배열입니다.

    데이터 유형: 배열

    "result": [
  {Object}
]
    결과.<object>

    짧은 이름과 정확히 일치하는 응답 템플릿이 반환 결과에 먼저 나타납니다. 반환된 다른 모든 응답 템플릿은 이름별로 정렬됩니다.

    데이터 유형: 객체

    {
  "evaluated_response": [Array],
  "name": "String",
  "short_name": "String",
  "short_name_match": Boolean,
  "sys_id": "String",
  "template_body": "String"
}
    결과.<object>. evaluated_response

    템플릿 평가 결과를 나열하는 배열입니다.

    데이터 유형: 배열

    "elevated_response":[
  "error": [Array],
  "evaluated_body": "String",
  "success": Boolean
]
    결과.<object>. evaluated_response.오류

    발생한 각 평가 오류에 대한 항목 목록입니다.

    데이터 유형: 배열

    "error":[
  "inAccessibleVariables": "String",
  "message": "String",
  "unEvaluatedVariables": "String"
]
    결과.<object>. evaluated_response.error.inAccessibleVariables 확인할 수 없는 응답 템플릿 본문의 변수입니다.

    데이터 유형: 문자열
    결과.<object>. evaluated_response.오류.메시지 오류 메시지.

    데이터 유형: 문자열
    결과.<object>. evaluated_response.error.unEvaluatedVariables 평가되지 않은 응답 템플릿 본문의 변수입니다.

    데이터 유형: 문자열
    결과.<object>. evaluated_response.평가된_본문 HTML로 된 응답 템플릿 본문을 평가했습니다.

    데이터 유형: 문자열
    결과.<object>. evaluated_response.성공

    모든 변수가 제대로 렌더링되었는지 여부를 나타내는 플래그입니다.

    가능한 값:
    • true: 모든 변수가 제대로 렌더링됩니다.
    • false: 변수가 제대로 렌더링되지 않았습니다.

    데이터 유형: 부울
    결과.<object>. 이름 응답 템플릿의 이름입니다.

    데이터 유형: 문자열
    결과.<object>. short_name 응답 템플릿의 짧은 이름입니다.

    데이터 유형: 문자열
    결과.<object>. short_name_match

    응답 템플릿의 짧은 이름에서 정확히 일치가 발생했는지 여부를 나타내는 플래그입니다.

    가능한 값:
    • true: 검색어가 정확히 일치합니다.
    • false: 검색어가 정확하게 일치하지 않습니다.

    데이터 유형: 부울
    결과.<object>. sys_id 응답 템플릿의 Sys_id입니다.

    데이터 유형: 문자열
    결과.<object>. template_body HTML의 응답 템플릿 본문입니다.

    데이터 유형: 문자열

    샘플 cURL 요청

    curl "https://instance.service-now.com/api/sn_templated_snip/response_templates/get_templates" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"tableName\": \"sn_hr_core_case_total_rewards\",
  \"recordId\": \"2c9e43320b30220097432da0d5673a9c\"
}" \
--user "username":"password"
    {
   "result": [
      {
         "sys_id": "2552c4ec0b03320036e62c7885673a5a",
         "name": "Escalation Notes - Total Rewards",
         "short_name": "Escalation Notes - Total Rewards",
         "template_body": "<p>Dear ${subject_person},<\/p>\n<p>Please note that your case ${number} has been escalated to ${assignment_group}. An agent will be assigned on your case and will keep you updated. If you have more questions please reach out to our team.<\/p>\n<p>Regards,<\/p>\n<p>${sys_updated_by}<\/p>"
      },
      {
         "sys_id": "698388ec0b03320036e62c7885673ab5",
         "name": "Resolution Notes - Phone Inquiry",
         "short_name": "Resolution Notes - Phone Inquiry",
         "template_body": "<p>Thank you ${subject_person} for reaching out to the Global HR Services Team for your inquiry. As discussed over the phone, we have resolved your case ${number}.<\/p>\n<p>We are happy to help if you have more questions for our team. Please reach out and mention the case number ${number} on the call.<\/p>\n<p>Regards,<\/p>\n<p>${assigned_to}<\/p>"
      }
   ]
}