REST API da Gestão de conhecimento

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 27 min. de leitura

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

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

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

    Para habilitar outros domínios a serem usados REST API da Gestão de conhecimento Endpoints, defina uma regra de Compartilhamento de recursos entre origens (CORS). Para obter mais informações, consulte Defina 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 do escopo da solicitação na tabela Privilégios de acesso restrito do solicitante [sys_restricted_caller_access]. Para obter mais informações, consulte Defina o acesso entre escopos a um recurso da 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 de REST API de entrada .

    Gestão de conhecimento - OBTENHA /knowledge/articles

    Retorna uma lista de artigos da base de conhecimento (KB) que podem ser pesquisados e filtrados usando vários parâmetros.

    Formato de URL

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

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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: filtro: <attr> <operator> <value> .

    • <attr> Nome da coluna da tabela.
    • <operator> :
      Valores válidos:
      • Corresponde exatamente ao <value>.
      • Não corresponde ao <value>.
      • Permite especificar mais de uma condição e logicamente E elas.
      • OU: Permite especificar mais de uma condição e logicamente OU elas.
      • CURTIR: O <attr> contém a cadeia de caracteres especificada. Funciona somente para campos do <attr> cujo tipo de dados é cadeia de caracteres.
      • STARTSWITH: O <attr> começa com a cadeia de caracteres especificada. Funciona somente para campos do <attr> cujo tipo de dados é cadeia de caracteres.
      • ENDSWITH: O <attr> termina com a cadeia de caracteres especificada. Funciona somente para campos do <attr> cujo tipo de dados é cadeia de caracteres.
    • <value> Valor a ser correspondido.

    Todos os parâmetros diferenciam maiúsculas de minúsculas. A consulta pode conter mais de uma entrada, como <attr> <operator> <value>[<operator> <attr> <operator> <value>] .

    Tipo de dados: Cadeia de caracteres

    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
    base de conhecimento 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. Incomum grande limitos valores podem afetar o desempenho do sistema. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro.

    Tipo de dados: Número

    Padrão: 30
    deslocamento Índice de registro inicial para o qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta 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 que este endpoint é chamado, offsetdefinido como "0". Para percorrer todos os registros disponíveis, use deslocamento: deslocamento e limite até que o final de todos os registros seja atingido.

    Tipo de dados: Número

    Padrão: 0
    consulta O texto a ser pesquisado pode ficar em branco.

    Tipo de dados: Cadeia de caracteres
    Tabela 3. Solicitar parâmetros do corpo (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/jsonou 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 na resposta.

    Tipo de dados: Matriz

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

    Tipo de dados: Objeto

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

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.label Rótulo que representa o campo solicitado. Por exemplo, Conhecimento .

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.name Nome do campo solicitado. Correspondências <field_name>.

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.type Tipo de dados do campo solicitado.

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.value 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
    articles.link Link para o artigo.

    Tipo de dados: Cadeia de caracteres
    articles.number Número do artigo de conhecimento.

    Tipo de dados: Cadeia de caracteres
    articles.rank Classificação de pesquisa do artigo específico para esta pesquisa.

    Tipo de dados: Número (flutuante)
    articles.snippet Texto mostrando uma pequena parte do artigo de conhecimento.

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

    Tipo de dados: Cadeia de caracteres
    articles.title Descrição resumida ou título do artigo de conhecimento.

    Tipo de dados: Cadeia de caracteres
    meta Metadados dos parâmetros de resultados e 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.count Número de artigos da base de conhecimento disponíveis.

    Tipo de dados: Número
    meta.end Índice final do conjunto de resultados.

    Tipo de dados: Número
    meta.fields Campos no artigo.

    Tipo de dados: Cadeia de caracteres
    meta.filter Filtro usado para adquirir os dados.

    Tipo de dados: Cadeia de caracteres
    meta.kb Lista de sys_ids do artigo da base de conhecimento.

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

    Tipo de dados: Cadeia de caracteres
    meta.query Consulta de solicitação especificada.

    Tipo de dados: Cadeia de caracteres
    meta.start Í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 - OBTENHA /knowledge/articles//attachments/(attachment_sys_id)

    Retorna um anexo de artigo de conhecimento como um arquivo.

    Formato de URL

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

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres
    article_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. Solicitar parâmetros do corpo (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/jsonou 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, imagem/gif ou */* .

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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.

    Solicitação de cURL de amostra

    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 - OBTENHA /knowledge/articles/

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

    Formato de URL

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

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 ide uma versão traduzida do artigo está disponível no idioma especificado.
    Nota:
    Válido somente ao definir idParâmetro 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_idUsando uma das seguintes APIs que retorna o. articles.idelemento:

    Passando o. search_ide. search_rankO parâmetro incrementa a contagem de exibição do artigo e registra uma entrada para o artigo na tabela Uso de conhecimento [kb_use]. Você também pode verificar contagens de exibições incrementadas na página Base de conhecimento [kb_view2].

    Tipo de dados: Cadeia de caracteres
    search_rank Opcional, a menos que esteja usando search_id. Artigo classificação de pesquisa Por taxa de cliques que você pode recuperar usando uma das seguintes APIs que retorna o. articles.rankelemento:

    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]. Presente como um parâmetro autônomo ou definido como verdadeiro.
    Nota:
    Se você passar update_viewcom search_ide. search_rank, update_viewé ignorado porque a contagem de exibições já será incrementada.

    Tipo de dados: Booliano que sempre é tratado como verdadeiro quando passado, seja definido como "verdadeiro" , "falso" ou não definido.
    Tabela 21. Solicitar parâmetros do corpo (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/jsonou 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 do anexo para cada instância, se houver anexo.

    Exibido somente se display_attachments: verdadeiro .

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Cadeia de caracteres
    attachments.size_bytes Tamanho do arquivo.

    Tipo de dados: Cadeia de caracteres

    Unidade: Bytes
    attachments.state Estado.
    Valores possíveis:
    • disponível
    • available_condicionalmente
    • not_available
    • pendente(s)

    Tipo de dados: Cadeia de caracteres
    attachments.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
    display_attachments Sinalizador que indica se display_attachmentso sinalizador está ativo para esse artigo. Os anexos serão retornados somente se display_attachmentsé verdadeiro (ativo) no registro do artigo de conhecimento.
    • verdadeiro: display_attachmentsativo.
    • falso: display_attachmentsestá inativo.

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

    Exibido somente se display_attachments: verdadeiro .

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Cadeia de caracteres
    embedded_content.size_bytes Tamanho do anexo.

    Tipo de dados: Cadeia de caracteres

    Unidade: Bytes
    embedded_content.state Estado do anexo.
    Valores possíveis:
    • disponível
    • available_condicionalmente
    • not_available
    • pendente(s)

    Tipo de dados: Cadeia de caracteres
    embedded_content.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}
}
    fields.<field_name> Lista cada campo solicitado usando o parâmetro fields, se houver.

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres
    fields.<field_name>.label Rótulo que representa o campo solicitado. Por exemplo, Conhecimento .

    Tipo de dados: Cadeia de caracteres
    fields.<field_name>.name Nome do campo solicitado. Correspondências <field_name>.

    Tipo de dados: Cadeia de caracteres
    fields.<field_name>.type Tipo de dados do campo solicitado.

    Tipo de dados: Cadeia de caracteres
    fields.<field_name>.value 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 a tradução estiver 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
    languages.label Representação de cadeia de caracteres para idioma.

    Tipo de dados: Cadeia de caracteres
    languages.language Idioma do código ISO 639-1 de duas letras.

    Tipo de dados: Cadeia de caracteres
    languages.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, retornará 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": []
  }
}

    Solicitação de cURL de amostra (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 - OBTENHA knowledge/articles/most_viewed

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

    Formato de URL

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

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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
    base de conhecimento 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. Incomum grande limitos valores podem afetar o desempenho do sistema. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro.

    Tipo de dados: Número

    Padrão: 30
    deslocamento Índice de registro inicial para o qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta 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 que este endpoint é chamado, offsetdefinido como "0". Para percorrer todos os registros disponíveis, use deslocamento: deslocamento e limite até que o final de todos os registros seja atingido.

    Tipo de dados: Número

    Padrão: 0
    Tabela 27. Solicitar parâmetros do corpo (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/jsonou 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 na resposta.

    Tipo de dados: Matriz

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

    Tipo de dados: Objeto

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

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.label Rótulo que representa o campo solicitado. Por exemplo, Conhecimento .

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.name Nome do campo solicitado. Corresponde ao <field_name>.

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.type Tipo de dados do campo solicitado.

    Tipo de dados: Cadeia de caracteres
    articles.fields.<field_name>.value 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
    articles.link Link para o artigo.

    Tipo de dados: Cadeia de caracteres
    articles.number Número do artigo de conhecimento.

    Tipo de dados: Cadeia de caracteres
    articles.rank Classificação de pesquisa do artigo específico para esta pesquisa.

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

    Tipo de dados: Cadeia de caracteres
    articles.snippet Texto mostrando uma pequena parte do artigo de conhecimento.

    Tipo de dados: Cadeia de caracteres
    articles.title Descrição resumida ou título do artigo de conhecimento.

    Tipo de dados: Cadeia de caracteres
    meta Metadados dos parâmetros de resultados e 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.count Número de artigos da base de conhecimento disponíveis.

    Tipo de dados: Número
    meta.end Índice final do conjunto de resultados.

    Tipo de dados: Número
    meta.fields Campos no artigo.

    Tipo de dados: Cadeia de caracteres
    meta.filter Filtro usado para adquirir os dados.

    Tipo de dados: Cadeia de caracteres
    meta.kb Lista de sys_ids do artigo da base de conhecimento.

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

    Tipo de dados: Cadeia de caracteres
    meta.query Consulta de solicitação especificada.

    Tipo de dados: Cadeia de caracteres
    meta.start Í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"
      }
    ]
  }
}