---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API de modelos de resposta

# API de modelos de resposta {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 min. de leitura

A API de Modelos de resposta fornece endpoints para lidar com registros na tabela Modelos de resposta \[sn_templated_snip_note_template\].
Esta inclusão de script requer o plug-in Templated Responses (com.sn_templated_snip), que é ativado por padrão e é executado no namespace `sn_templated_snip`.

Para obter informações adicionais sobre modelos de resposta, consulte [Modelos](https://www.servicenow.com/docs/access?context=response-templates-templated-snippets&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)de resposta .

## Modelos de resposta - POST /response_templates/get_templates {#ariaid-title2}

Retorna registros da tabela Modelos de resposta \[sn_templated_snip_note_template\].

### Formato da URL {#response_temp-POST-get_templates__section_nz2_qyp_3mb}

URL padrão: /api/sn_templated_snip/response_templates/get_templates

### Parâmetros de solicitação compatíveis

{#response_temp-POST-get_templates__entry__2}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 1. Parâmetros de caminho]

{#response_temp-POST-get_templates__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#response_temp-POST-get_templates__entry__10}

| Nome | Descrição |
|-|-|
| errorFormat | Formatação HTML a ser usada para erros. Tipo de dados: cadeia de caracteres Padrão: `"<span style='color:#ff0000'>${%s}</span>"` |
| includeEvaluatedBody | Sinalizador que indica se as variáveis do modelo devem ser renderizadas. Valores válidos: * falso: não renderiza as variáveis do modelo. A resposta contém as variáveis de mensagem. Por exemplo: ``` Observe que seu caso ${number} foi escalado para ${assignment_group}. ``` * verdadeiro: renderiza as variáveis do modelo e retorna evaluated_response nos resultados de retorno. Por exemplo: ``` Observe que seu caso INC100001 foi escalado para Instalações. ``` {#response_temp-POST-get_templates__ul_esl_jh4_ylb} Tipo de dados: booliano Padrão: falso |
| limite | Número máximo de modelos de resposta a serem retornados. Tipo de dados: número Padrão: 50 |
| deslocamento | Para paginação, o índice no qual a pesquisa será iniciada. Tipo de dados: número Padrão: 0 |
| opções | Parâmetros a serem passados para o ponto de extensão sn_templated_snip.response_template. O formato e o conteúdo desses parâmetros dependem da implementação do ponto de extensão. Para obter informações adicionais sobre pontos de extensão, consulte [Como usar pontos de extensão para estender a funcionalidade da aplicação](https://servicenow-prod.fluidtopics.net/ItedJghnFrSfOOiWnOQqgA "Use pontos de extensão para estender a funcionalidade de uma aplicação sem alterar o código da aplicação original. Você pode usar pontos de extensão pré-existentes disponíveis em aplicações Now Platform selecionadas ou pode adicionar pontos de extensão ao desenvolver aplicações personalizadas em sua própria instância."). Tipo de dados: objeto |
| recordId | Obrigatório. Sys_id do registro a ser usado para renderizar as variáveis no modelo de resposta. Tipo de dados: cadeia de caracteres |
| searchTerm | Texto a ser usado para filtrar a lista de modelos de resposta correspondentes. O endpoint executa uma pesquisa "CONTÉM" deste texto nos campos de nome e corpo e uma pesquisa "INÍCIA COM" no campo de nome curto. Por exemplo, se o termo de pesquisa for "crash", o endpoint retornará qualquer modelo de resposta que corresponda aos critérios de consulta e tenha falha no nome ou no corpo, ou o nome curto comece com "crash". Modelos de resposta com correspondências exatas no nome curto aparecem primeiro nos resultados de retorno. Todos os outros modelos de resposta retornados são classificados por nome. Tipo de dados: cadeia de caracteres Padrão: retorna todos os modelos de resposta correspondentes. |
| tableName | Obrigatório. Nome da tabela a ser usada para pesquisar a tabela Modelos de resposta para localizar os modelos de resposta correspondentes. Por exemplo, "incidente" ou "sn_hr_core_case". Tipo de dados: cadeia de caracteres |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#response_temp-POST-get_templates__entry__28}{#response_temp-POST-get_templates__accept-JSON-only-entry-RESTAPI}{#response_temp-POST-get_templates__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]

{#response_temp-POST-get_templates__entry__34}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#response_temp-POST-get_templates__entry__38}{#response_temp-POST-get_templates__entry-200-status-code}{#response_temp-POST-get_templates__entry-401-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]

### Parâmetros do corpo da resposta (JSON ou XML)

{#response_temp-POST-get_templates__entry__46}

| Nome | Descrição |
|-|-|
| resultado | Matriz de objetos que lista todos os modelos que correspondem aos critérios de pesquisa especificados. Tipo de dados: matriz "result": [ {Object} ] |
| resultado.\<object\> | Modelos de resposta com correspondências exatas no nome curto aparecem primeiro nos resultados de retorno. Todos os outros modelos de resposta retornados são classificados por nome. Tipo de dados: objeto { "evaluated_response": [Array], "name": "String", "short_name": "String", "short_name_match": Boolean, "sys_id": "String", "template_body": "String" } |
| resultado.\<object\>.evaluated_response | Matriz que lista os resultados da avaliação do modelo. Tipo de dados: matriz "elevated_response":[ "error": [Array], "evaluated_body": "String", "success": Boolean ] |
| resultado.\<object\>.evaluated_response.error | Lista de entradas para cada erro de avaliação ocorrido. Tipo de dados: matriz "error":[ "inAccessibleVariables": "String", "message": "String", "unEvaluatedVariables": "String" ] |
| resultado.\<object\>.evaluated_response.error.inAccessibleVariables | Variáveis no corpo do modelo de resposta que não puderam ser resolvidas. Tipo de dados: cadeia de caracteres |
| resultado.\<object\>.evaluated_response.error.message | Mensagens de erro Tipo de dados: cadeia de caracteres |
| resultado.\<object\>.evaluated_response.error.unEvaluatedVariables | Variáveis no corpo do modelo de resposta que não foram avaliadas. Tipo de dados: cadeia de caracteres |
| resultado.\<object\>.evaluated_response.evaluated_body | Corpo do modelo de resposta avaliado em HTML. Tipo de dados: cadeia de caracteres |
| resultado.\<object\>.evaluated_response.success | Sinalizador que indica se todas as variáveis foram renderizadas corretamente. Valores possíveis: * verdadeiro: todas as variáveis renderizadas corretamente. * falso: as variáveis não foram renderizadas corretamente. {#response_temp-POST-get_templates__ul_wvc_d5s_xlb} Tipo de dados: booliano |
| resultado.\<object\>.nome | Nome do modelo de resposta. Tipo de dados: cadeia de caracteres |
| resultado.\<object\>.short_name | Nome curto do modelo de resposta. Tipo de dados: cadeia de caracteres |
| resultado.\<object\>.short_name_match | Sinalizador que indica se ocorreu uma correspondência exata no nome curto do modelo de resposta. Valores possíveis: * verdadeiro: o termo de pesquisa é uma correspondência exata. * falso: o termo de pesquisa não é uma correspondência exata. {#response_temp-POST-get_templates__ul_yby_5ts_xlb} Tipo de dados: booliano |
| resultado.\<object\>.sys_id | Sys_id do modelo de resposta. Tipo de dados: cadeia de caracteres |
| resultado.\<object\>.template_body | Corpo do modelo de resposta em HTML. Tipo de dados: cadeia de caracteres |
[ ]

### Amostra de solicitação 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>"
          }
       ]
    }