REST API da Gestão de conhecimento

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 27 min. de leitura

    • A API da Gestão de conhecimento fornece endpoints para pesquisar, exibir e buscar listas dos artigos de conhecimento mais vistos e em destaque.

    Você só pode usar esta API quando o plug-in Knowledge API (sn_km_api) está ativado. A REST API da Gestão de conhecimento foi lançada originalmente em Orlando usando o app Knowledge API disponível em ServiceNow Store.

    Nota:
    A REST API da Gestão de conhecimento pode ser acessada publicamente e disponibiliza qualquer base de conhecimento publicamente acessível para todos os usuários, incluindo usuários não autenticados. Para a versão 1.0.1 e posterior, a API se tornou editável, permitindo que os administradores configurem cada endpoint para proibir o acesso não autenticado selecionando o sinalizador Requer autenticação na guia Segurança do serviço REST com script associada à API.

    Para habilitar outros domínios para usar endpoints de REST API da Gestão de conhecimento, defina uma regra de Compartilhamento de recursos de origem cruzada (CORS). Para obter mais informações, consulte Definir uma regra CORS.

    Para exibir um artigo da base de conhecimento com escopo usando esta REST API, permita o acesso de leitura do escopo sn_km_api a partir do escopo solicitante na tabela Privilégios de acesso de solicitante restrito [sys_restricted_caller_access]. Para obter mais informações, consulte Definir acesso entre escopos a um recurso de aplicação.

    Por padrão, esta API tem um limite de taxa de 500 por hora para usuários não autenticados e snc_external. Para obter mais informações sobre limitação de taxa, consulte Limitação de taxa da REST API de entrada.

    Gestão de conhecimento - GET /knowledge/articles

    Retorna uma lista de artigos da base de conhecimento (KB) que pode ser pesquisada e filtrada usando vários parâmetros.

    Formato da URL

    URL com controle de versão: /api/sn_km_api/{api_version}/knowledge/articles

    URL padrão: /api/sn_km_api/knowledge/articles

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    filtros Consulta codificada a ser usada para filtrar o conjunto de resultados.

    Sintaxe: filter=<attr><operator><value> .

    • <attr>: Nome da coluna da tabela.
    • <operator>:
      Valores válidos:
      • =: Corresponde exatamente a<value> .
      • !=: não corresponde<value> .
      • ^: permite que você especifique mais de uma condição e faça E logicamente.
      • ^OR: permite que você especifique mais de uma condição e logicamente OU.
      • CURTIR:<attr> contém a cadeia de caracteres especificada. Só funciona para<attr> campos cujo tipo de dados é cadeia de caracteres.
      • COMEÇA COM:<attr> começa com a cadeia de caracteres especificada. Só funciona para<attr> campos cujo tipo de dados é cadeia de caracteres.
      • TERMINACOM:<attr> termina com a cadeia de caracteres especificada. Só funciona para<attr> campos cujo tipo de dados é cadeia de caracteres.
    • <value>: valor a ser correspondido.

    Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. A consulta pode conter mais de uma entrada, como filtro=<attr><operator><value> [ ] .

    Tipo de dados: cadeia de caracteres

    Padrão: vazio
    campos Lista separada por vírgulas de campos da tabela Conhecimento [kb_knowledge] para mostrar detalhes nos resultados.

    Tipo de dados: cadeia de caracteres

    Padrão: nenhum
    KB Lista separada por vírgulas de sys_ids da base de conhecimento da tabela Bases de conhecimento [kb_knowledge_base] para restringir os resultados.

    Tipo de dados: cadeia de caracteres
    idioma Lista de idiomas separados por vírgulas no formato de código de idioma ISO 639-1 de duas letras para restringir os resultados. Como alternativa, digite "todos" para pesquisar em todos os idiomas válidos instalados em uma instância.

    Tipo de dados: cadeia de caracteres

    Padrão: idioma da sessão do usuário ou en
    limite Número máximo de registros a serem retornados. Valores limit extraordinariamente grandes podem afetar o desempenho do sistema. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro.

    Tipo de dados: número

    Padrão: 30
    deslocamento Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez em que este endpoint é chamado, offset é definido como "0". Para percorrer todos os registros disponíveis, use deslocamento=deslocamento+limite até que o fim de todos os registros seja atingido.

    Tipo de dados: número

    Padrão: 0
    consulta O texto a ser pesquisado pode estar vazio.

    Tipo de dados: cadeia de caracteres
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 6. Códigos de status
    Código do 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.

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

    Nome Descrição
    artigos Lista de artigos retornados em resposta.

    Tipo de dados: matriz

    "articles": [
  {
    "fields": {Object},
    "link": "String",
    "id": "String",
    "number": "String",
    "rank": Number,
    "score": Number,
    "snippet": "String",
    "title": "String"
  }
]
    artigos.campos Valores dos campos solicitados, se houver.

    Tipo de dados: objeto

    "fields": {
  "<field_name>": {Object}
}
    artigos.campos.<field_name> Lista cada campo solicitado usando o parâmetro de campos, se houver.

    Tipo de dados: objeto

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    artigos.campos.<field_name> .display_value Valor de exibição do campo solicitado.

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .rótulo Rótulo que representa o campo solicitado. Por exemplo, Conhecimento.

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .nome Nome do campo solicitado. Corresponde a <field_name>.

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .tipo Tipo de dados do campo solicitado.

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .valor Valor do campo solicitado.

    Tipo de dados: cadeia de caracteres
    articles.id sys_id do artigo de conhecimento da tabela Conhecimento [kb_knowledge].

    Tipo de dados: cadeia de caracteres
    artigos.link Link para o artigo.

    Tipo de dados: cadeia de caracteres
    artigos.número Número do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    artigos.classificação Classificação de pesquisa do artigo específico para esta pesquisa.

    Tipo de dados: número (flutuante)
    artigos.snippet Texto que mostra uma pequena parte do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    artigos.pontuação Pontuação de relevância, resultados classificados em ordem decrescente por pontuação.

    Tipo de dados: cadeia de caracteres
    artigos.título Descrição resumida ou título do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    meta Metainformações dos resultados e parâmetros de solicitação.

    Tipo de dados: objeto

    "meta": {
  "count": Number,
  "end": Number,
  "fields": "String",
  "filter": "String",
  "kb": "String",
  "language": "String",
  "query": "String",
  "start": Number,
  "status": {Object},
  "ts_query_id": "String"
}
    meta.contagem Número de artigos da base de conhecimento disponíveis.

    Tipo de dados: número
    meta.fim Índice final do conjunto de resultados.

    Tipo de dados: número
    meta.campos Campos no artigo.

    Tipo de dados: cadeia de caracteres
    meta.filtro Filtro usado para adquirir os dados.

    Tipo de dados: cadeia de caracteres
    meta.kb Lista de artigos da base de conhecimento sys_ids.

    Tipo de dados: cadeia de caracteres
    meta.idioma Lista de idiomas separados por vírgulas dos artigos da base de conhecimento que foram solicitados.

    Tipo de dados: cadeia de caracteres
    meta.consulta Consulta de solicitação especificada.

    Tipo de dados: cadeia de caracteres
    meta.início Índice inicial do conjunto de resultados.

    Tipo de dados: número
    meta.status Status da chamada.

    Tipo de dados: cadeia de caracteres
    meta.ts_query_id Sys_id da consulta.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles?query=Windows&limit=2&fields=short_description&fields=sys_class_name" \
--request GET \
--header "Accept:application/xml" \
--user "username":"password"
    {
  "result": {
    "meta": {
      "start": 0,
      "end": 2,
      "fields": "short_description,sys_class_name",
      "query": "Windows",
      "filter": "",
      "kb": "",
      "language": "en",
      "count": 19,
      "ts_query_id": "7976f36129c30410f877796e70786991",
      "status": {
        "code": 200
      }
    },
    "articles": [
      {
        "link": "?sys_kb_id=9e528db1474321009db4b5b08b9a71a6&id=kb_article_view&sysparm_rank=1&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
        "rank": 1,
        "id": "kb_knowledge:9e528db1474321009db4b5b08b9a71a6",
        "title": "Windows: Should I upgrade to Windows 8.x?",
        "snippet": "    Should I upgrade to <B>Windows</B> 8.x? <B>Windows</B> 8.x is designed for using touch, mouse, and keyboard the <B>Windows</B> Store and access apps such as Calendar, Mail, and Messaging. By most accounts, <B>Windows</B> boot times, smaller memory footprint, and more free memory for the programs you run. <B>Windows</B>",
        "score": 14.869,
        "number": "KB0000020",
        "fields": {
          "short_description": {
            "display_value": "Windows: Should I upgrade to Windows 8.x?\n\t\t",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "Windows: Should I upgrade to Windows 8.x?\n\t\t"
          },
          "sys_class_name": {
            "display_value": "Knowledge",
            "name": "sys_class_name",
            "label": "Class",
            "type": "sys_class_name",
            "value": "kb_knowledge"
          }
        }
      },
      {
        "link": "?sys_kb_id=3b07857187032100deddb882a2e3ec20&id=kb_article_view&sysparm_rank=2&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
        "rank": 2,
        "id": "kb_knowledge:3b07857187032100deddb882a2e3ec20",
        "title": "What is the Windows key?",
        "snippet": "What is the <B>Windows</B> key? The <B>Windows</B> key is a standard key on most keyboards on computers built to use a <B>Windows</B> operating system. It is labeled with a <B>Windows</B> logo, and is usually placed between on the right side as well. Pressing Win (the <B>Windows</B> key) on its own will do the following: <B>Windows</B> 8.x: Toggle",
        "score": 13.4826,
        "number": "KB0000017",
        "fields": {
          "short_description": {
            "display_value": "What is the Windows key?\t\t",
            "name": "short_description",
            "label": "Short description",
            "type": "string",
            "value": "What is the Windows key?\t\t"
          },
          "sys_class_name": {
            "display_value": "Knowledge",
            "name": "sys_class_name",
            "label": "Class",
            "type": "sys_class_name",
            "value": "kb_knowledge"
          }
        }
      }
    ]
  }
}

    Gestão de conhecimento - GET /knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}

    Retorna um anexo de artigo de conhecimento como um arquivo.

    Formato da URL

    URL com controle de versão: /api/sn_km_api/{api_version}/knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}

    URL padrão: /api/sn_km_api/knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    artigo_sys_id Sys_id do artigo de conhecimento com o anexo que você pretende recuperar.

    Tipo de dados: cadeia de caracteres

    Tabela: Bases de conhecimento [kb_knowledge]
    attachment_sys_id Sys_id do registro ao qual o anexo pertence.

    Tipo de dados: cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo O tipo de conteúdo da resposta, por exemplo, image/gif ou */*.

    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.

    Tabela 12. Códigos de status
    Código do 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.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta

    Nome Descrição
    O arquivo é retornado como uma resposta.

    Amostra de solicitação cURL

    curl "https://instance.service-now.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2/attachments/fedf5614294f4010f877796e70786956" \
--request GET \
--header "Accept:*/*" \
--user "username":"password"
    Binary response not shown (file is returned as a response).

    Gestão de conhecimento - GET /knowledge/articles/{id}

    Retorna o conteúdo específico do artigo de conhecimento e seus valores de campo.

    Formato da URL

    URL com controle de versão: /api/sn_km_api/{api_version}/knowledge/articles/{id}

    URL padrão: /api/sn_km_api/knowledge/articles/{id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    id Sys_id ou número da base de conhecimento (KB) de um artigo de conhecimento.

    Tipo de dados: cadeia de caracteres

    Tabela: Conhecimento [kb_knowledge]
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    campos Lista separada por vírgulas de campos da tabela Conhecimento [kb_knowledge] para mostrar detalhes nos resultados.

    Tipo de dados: cadeia de caracteres

    Padrão: nenhum
    idioma Código de idioma ISO 639-1 de duas letras; por exemplo, "fr" para francês. Os resultados são exibidos somente quando as pesquisas usam o número da base de conhecimento do artigo de conhecimento como id e uma versão traduzida do artigo está disponível no idioma especificado.
    Nota:
    Válido somente ao definir o parâmetro id como um número da base de conhecimento (não sys_id).

    Tipo de dados: cadeia de caracteres
    search_id Opcional, a menos que esteja usando search_rank. Identificador exclusivo da pesquisa que retornou este artigo.
    Você pode recuperar search_id usando uma das seguintes APIs que retorna o elemento articles.id :

    Passar os parâmetros search_id e search_rank incrementa a contagem de exibições do artigo e registra uma entrada para o artigo na tabela Uso de conhecimento [kb_use]. Você também pode verificar as contagens de exibições incrementadas na página Base de conhecimento [kb_view2].

    Tipo de dados: cadeia de caracteres
    pesquisa_classificação Opcional, a menos que esteja usando search_id. Classificação de pesquisa de artigo por taxa de cliques que você pode recuperar usando uma das seguintes APIs que retorna o elemento articles.rank :

    Tipo de dados: número
    update_view Atualize a contagem de exibições e registre uma entrada para o artigo na tabela Uso de conhecimento [kb_use]. Verdadeiro, se presente como um parâmetro autônomo ou definido como verdadeiro.
    Nota:
    Se você passar update_view com search_id e search_rank, update_view será ignorado porque a contagem de exibições já terá sido incrementada.

    Tipo de dados: booliano que é sempre tratado como verdadeiro quando passado, esteja definido como "verdadeiro", "falso"ou não definido.
    Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 24. Códigos de status
    Código do 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.

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

    Nome Descrição
    anexos Fornece detalhes de anexo para cada instância se houver anexo.

    Somente será exibido se display_attachments = verdadeiro.

    Tipo de dados: matriz de objetos

    "attachments": [
  {
    "file_name": "String",
    "size_bytes": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    anexos.file_name Nome do arquivo do anexo.

    Tipo de dados: cadeia de caracteres
    anexos.tamanho_bytes Tamanho do arquivo.

    Tipo de dados: cadeia de caracteres

    Unidade: bytes
    anexos.estado Estado.
    Valores possíveis:
    • disponível
    • disponível_condição
    • não_disponível
    • pendente

    Tipo de dados: cadeia de caracteres
    anexos.sys_id Sys_id do anexo.

    Tipo de dados: cadeia de caracteres
    conteúdo Todo o conteúdo HTML do artigo.

    Tipo de dados: cadeia de caracteres
    exibir_anexos Sinalizador que indica se o sinalizador display_attachments está ativo para esse artigo. Os anexos serão retornados somente se display_attachments for verdadeiro (ativo) no registro do artigo de conhecimento.
    • verdadeiro: display_attachments está ativo.
    • falso: display_attachments está inativo.

    Tipo de dados: booliano
    conteúdo_integrado Lista cada anexo que contém conteúdo incorporado por sys_id e inclui informações relevantes do anexo.

    Somente será exibido se display_attachments = verdadeiro.

    Tipo de dados: matriz de objetos

    "attachments": [
  {
    "file_name": "String",
    "size_bytes": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    conteúdo_integrado.nome_do_arquivo Nome do arquivo do anexo.

    Tipo de dados: cadeia de caracteres
    conteúdo_incorporado.tamanho_bytes Tamanho do anexo.

    Tipo de dados: cadeia de caracteres

    Unidade: bytes
    conteúdo_incorporado.estado Estado do anexo.
    Valores possíveis:
    • disponível
    • disponível_condição
    • não_disponível
    • pendente

    Tipo de dados: cadeia de caracteres
    conteúdo_integrado.sys_id Sys_id do anexo.

    Tipo de dados: cadeia de caracteres
    campos Valores dos campos solicitados (se houver).

    Tipo de dados: objeto

    "fields": {
  "<field_name>": {Object}
}
    campos.<field_name> Lista cada campo solicitado usando o parâmetro de campos, se houver.

    Tipo de dados: objeto

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    campos.<field_name> .display_value Valor de exibição do campo solicitado.

    Tipo de dados: cadeia de caracteres
    campos.<field_name> .rótulo Rótulo que representa o campo solicitado. Por exemplo, Conhecimento.

    Tipo de dados: cadeia de caracteres
    campos.<field_name> .nome Nome do campo solicitado. Corresponde a <field_name>.

    Tipo de dados: cadeia de caracteres
    campos.<field_name> .tipo Tipo de dados do campo solicitado.

    Tipo de dados: cadeia de caracteres
    campos.<field_name> .valor Valor do campo solicitado.

    Tipo de dados: cadeia de caracteres
    idioma Código de idioma ISO 639-1 de duas letras para o artigo atual (se houver tradução disponível).

    Tipo de dados: cadeia de caracteres
    idiomas Para cada versão traduzida de um artigo de conhecimento (se traduzido):
    "languages": [
  {
    "label": "String",
    "language": "String",
    "sys_id": "String"
  }
]

    Tipo de dados: matriz
    idiomas.rótulo Representação de cadeia de caracteres para idioma.

    Tipo de dados: cadeia de caracteres
    idiomas.idioma Idioma do código ISO 639-1 de duas letras.

    Tipo de dados: cadeia de caracteres
    idiomas.sys_id Identificador exclusivo da versão traduzida do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    número Número do artigo.

    Tipo de dados: cadeia de caracteres
    short_description Descrição resumida ou título do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    sys_id sys_id do artigo de conhecimento da tabela Conhecimento [kb_knowledge].

    Tipo de dados: cadeia de caracteres
    modelo Sinalizador que indica se um artigo retornado é um modelo.
    Valores possíveis:
    • verdadeiro: o artigo é um modelo.
    • falso: o artigo não é um modelo.

    Tipo de dados: booliano
    template_table Nome da tabela de modelo, retorna somente se o artigo de conhecimento for um modelo.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2?search_id=spam&search_rank=26.426" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "content": "<p><span style=\"font-size: 18pt;\"><strong>How to Deal with Spam</strong></span></p>\r\n<p>Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email  addresses posted to web sites or in newsgroups and chat rooms attract the most spam.</p>\r\n<p>To reduce the amount of spam you receive:</p>\r\n<p>
    "template": false,
    "number": "KB0000011",
    "sys_id": "0b48fd75474321009db4b5b08b9a71c2",
    "short_description": "How to Deal with Spam",
    "display_attachments": true,
    "attachments": [
      {
        "sys_id": "dc27ae18294f4010f877796e707869c8",
        "file_name": "image.jpg",
        "size_bytes": "66792",
        "state": "available_conditionally"
      },
      {
        "sys_id": "fedf5614294f4010f877796e70786956",
        "file_name": "attachment.txt",
        "size_bytes": "75",
        "state": "available_conditionally"
      }
    ],
    "embedded_content": []
  }
}

    Amostra de solicitação cURL (update_view)

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/KB0000020?update_view=' \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "content": "<p> </p>\r\n<p> </p>\r\n<p><strong><span style=\"font-size: 18pt;\">Should I upgrade to Windows 8.x?</span></strong></p>\r\n<p>Windows 8.x is designed for using touch, mouse, and keyboard together, on hardware ranging from touch-enabled tablets and laptops to PCs and all-in-one computers...(intentionally truncated)</p>",
    "template": false,
    "number": "KB0000020",
    "sys_id": "9e528db1474321009db4b5b08b9a71a6",
    "short_description": "Windows: Should I upgrade to Windows 8.x?\t\t",
    "display_attachments": true,
    "attachments": [],
    "embedded_content": []
  }
}

    Gestão de conhecimento - GET knowledge/articles/most_viewed

    Retorna uma lista de artigos de conhecimento priorizados por mais vistos.

    Formato da URL

    URL com controle de versão: /api/sn_km_api/{api_version}/knowledge/articles/most_viewed

    URL padrão: /api/sn_km_api/knowledge/articles/most_viewed

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    campos Lista separada por vírgulas de campos da tabela Conhecimento [kb_knowledge] para mostrar detalhes nos resultados.

    Tipo de dados: cadeia de caracteres

    Padrão: nenhum
    KB Lista separada por vírgulas de sys_ids da base de conhecimento da tabela Bases de conhecimento [kb_knowledge_base] para restringir os resultados.

    Tipo de dados: cadeia de caracteres
    idioma Lista de idiomas separados por vírgulas no formato de código de idioma ISO 639-1 de duas letras para restringir os resultados. Como alternativa, digite "todos" para pesquisar em todos os idiomas válidos instalados em uma instância.

    Tipo de dados: cadeia de caracteres

    Padrão: idioma da sessão do usuário ou en
    limite Número máximo de registros a serem retornados. Valores limit extraordinariamente grandes podem afetar o desempenho do sistema. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro.

    Tipo de dados: número

    Padrão: 30
    deslocamento Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez em que este endpoint é chamado, offset é definido como "0". Para percorrer todos os registros disponíveis, use deslocamento=deslocamento+limite até que o fim de todos os registros seja atingido.

    Tipo de dados: número

    Padrão: 0
    Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 30. Códigos de status
    Código do 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.

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

    Nome Descrição
    artigos Lista de artigos retornados em resposta.

    Tipo de dados: matriz

    [
  {
    "fields": {Object},
    "id": "String",
    "link": "String",
    "number": "String",
    "rank": Number,
    "score": Float,
    "snippet": "String",
    "title": "String"
  }
]
    artigos.campos Valores dos campos solicitados (se houver).

    Tipo de dados: objeto

    "fields": {
  "<field_name>": {Object}
}
    artigos.campos.<field_name> Lista cada campo solicitado usando o parâmetro de campos, se houver.

    Tipo de dados: objeto

    "<field_name>": {
  "display_value": "String",
  "label": "String",
  "name": "String",
  "type": "String",
  "value": "String"
}
    artigos.campos.<field_name> .display_value Valor de exibição do campo solicitado.

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .rótulo Rótulo que representa o campo solicitado. Por exemplo, Conhecimento.

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .nome Nome do campo solicitado. Correspondências<field_name> .

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .tipo Tipo de dados do campo solicitado.

    Tipo de dados: cadeia de caracteres
    artigos.campos.<field_name> .valor Valor do campo solicitado.

    Tipo de dados: cadeia de caracteres
    articles.id sys_id do artigo de conhecimento da tabela Conhecimento [kb_knowledge].

    Tipo de dados: cadeia de caracteres
    artigos.link Link para o artigo.

    Tipo de dados: cadeia de caracteres
    artigos.número Número do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    artigos.classificação Classificação de pesquisa do artigo específico para esta pesquisa.

    Tipo de dados: Flutuante
    artigos.pontuação Pontuação de relevância, resultados classificados em ordem decrescente por pontuação.

    Tipo de dados: cadeia de caracteres
    artigos.snippet Texto que mostra uma pequena parte do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    artigos.título Descrição resumida ou título do artigo de conhecimento.

    Tipo de dados: cadeia de caracteres
    meta Metainformações dos resultados e parâmetros de solicitação.

    Tipo de dados: objeto

    "meta": {
  "count": Number,
  "end": Number,
  "fields": "String",
  "filter": "String",
  "kb": "String",
  "language": "String",
  "query": "String",
  "start": Number,
  "status": {Object},
  "ts_query_id": "String"
}
    meta.contagem Número de artigos da base de conhecimento disponíveis.

    Tipo de dados: número
    meta.fim Índice final do conjunto de resultados.

    Tipo de dados: número
    meta.campos Campos no artigo.

    Tipo de dados: cadeia de caracteres
    meta.filtro Filtro usado para adquirir os dados.

    Tipo de dados: cadeia de caracteres
    meta.kb Lista de artigos da base de conhecimento sys_ids.

    Tipo de dados: cadeia de caracteres
    meta.idioma Lista de idiomas separados por vírgulas dos artigos da base de conhecimento que foram solicitados.

    Tipo de dados: cadeia de caracteres
    meta.consulta Consulta de solicitação especificada.

    Tipo de dados: cadeia de caracteres
    meta.início Índice inicial do conjunto de resultados.

    Tipo de dados: número
    meta.status Status HTTP da chamada.

    Tipo de dados: cadeia de caracteres
    meta.ts_query_id Sys_id da consulta.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/most_viewed?limit=5" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "meta": {
      "start": 0,
      "end": 5,
      "fields": "",
      "query": "",
      "filter": "workflow_state=published^valid_to>=javascript:gs.beginningOfToday()^active=true^sys_class_name!=kb_knowledge_block^sys_view_count>0^ORDERBYDESCsys_view_count^ORDERBYshort_description",
      "kb": "",
      "count": 2,
      "status": {
        "code": 200
      },
      "language": "en"
    },
    "articles": [
      {
        "link": "?id=kb_article_view&sys_kb_id=0b48fd75474321009db4b5b08b9a71c2",
        "id": "kb_knowledge:0b48fd75474321009db4b5b08b9a71c2",
        "title": "How to Deal with Spam",
        "snippet": "How to Deal with Spam Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email addresses posted to web sites or in newsgroups and chat rooms attract the most spam. To reduce the amount of spam you receive: Don't reply to spam Be careful releasing your email address, and know how it will be used ",
        "score": 7,
        "tags": [],
        "number": "KB0000011"
      },
      {
        "link": "?id=kb_article_view&sys_kb_id=c85cd2519f77230088aebde8132e70c2",
        "id": "kb_knowledge:c85cd2519f77230088aebde8132e70c2",
        "title": "Microsoft Outlook Issues",
        "snippet": "Microsoft Outlook Issues This article explains how to use automatic replies in Outlook 2010 for Exchange accounts. Setting Up Automatic Replies Click the File tab. Click Automatic Replies. Select Send automatic replies. If desired, select the Only send during this time range check box to schedule when your out of office replies are active. If yo",
        "score": 6,
        "tags": [],
        "number": "KB99999999"
      }
    ]
  }
}