API de anexos
-
- Atualizado30 de jan. de 2025
- 14 min. de leitura
- Yokohama
- "Implementação e referência de API"
A API de anexos fornece endpoints que permitem carregar e consultar anexos de arquivo.
Você pode carregar ou recuperar um único arquivo com cada solicitação.
A API de anexos respeita todas as limitações do sistema em arquivos carregados, como tamanho máximo de arquivo e tipos de anexo permitidos. Você pode controlar essas configurações usando as propriedades com.glide.attachment.max_size, 1024 MB por padrão e glide.attachment.extensions.
O vídeo a seguir fornece mais informações sobre a API de anexos :
Requisitos de função da API de anexos
Para criar anexos, o registro de usuário usado para autenticar a solicitação HTTP com ServiceNow deve ter todas as funções necessárias para criar registros de Anexo [sys_attachment]. Ele também deve ter todas as funções necessárias para ler e gravar registros na tabela de destino, como a função itil para adicionar anexos a registros de incidentes.
Por padrão, não há uma função única que permita que um usuário adicione anexos. Você pode criar uma função para permitir explicitamente a adição de anexos e atribuir essa função à conta de usuário que está sendo usada para fazer a solicitação.
Anexo - DELETE /now/attachment/{sys_id}
Este método exclui o anexo com um valor de sys_id específico.
Formato da URL
URL com controle de versão: /api/now/v1/attachment/{sys_id}
URL padrão: /api/now/attachment/{sys_id}
Parâmetros de solicitação compatíveis
Nome | Descrição |
---|---|
sys_id | Valor de Sys_id do anexo a ser excluído. Tipo de dados: cadeia de caracteres |
Nome | Descrição |
---|---|
Nenhum(a) |
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.
Cabeçalho | Descrição |
---|---|
Nenhum(a) |
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.
Parâmetros do corpo da resposta (JSON ou XML)
Nome | Descrição |
---|---|
Nenhum(a) |
Exemplo: Solicitação de cURL
Anexo - GET /now/attachment
Retorna os metadados de vários anexos.
Formato da URL
URL com controle de versão: api/now/v1/attachment
URL padrão: api/now/attachment
Parâmetros de solicitação compatíveis
Nome | Descrição |
---|---|
Nenhum(a) |
Nome | Descrição |
---|---|
sysparm_limit | Limite a ser aplicado na paginação. Nota: Valores de sysparm_limit incomumente grandes podem afetar o desempenho do sistema.Tipo de dados: cadeia de caracteres Padrão: 1000 |
sysparm_offset | Número de registros a serem excluídos da consulta. Use este parâmetro para obter mais registros do que o especificado no parâmetro sysparm_limit. Por exemplo, se sysparm_limit estiver definido como 500, mas houver registros adicionais que você deseja consultar, você poderá especificar um valor de parâmetro sysparm_offset de 500 para obter o segundo conjunto de registros. Tipo de dados: cadeia de caracteres Padrão: 0 |
sysparm_query | Consulta codificada. As consultas para a API de anexos são relativas à tabela Anexos [sys_attachment]. Por exemplo: (sysparm_query=file_name=attachment.doc) A consulta codificada fornece suporte para ordenar por. Para classificar respostas com base em determinados campos, use as cláusulas ORDERBY e ORDERBYDESC em sysparm_query. Por exemplo, Tipo de dados: cadeia de caracteres |
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.
Cabeçalho | Descrição |
---|---|
Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Cabeçalho | Descrição |
---|---|
Tipo de conteúdo | Tipo de conteúdo da resposta. Para solicitações de metadados, este é o tipo de conteúdo dos metadados, não o tipo de conteúdo dos arquivos de anexo. |
Link | Links para baixar os anexos. |
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.
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. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
Nome | Descrição |
---|---|
As informações retornadas dependem dos anexos selecionados. |
Exemplo: Solicitação de cURL
Anexo - GET /now/attachment/{sys_id}/file
Retorna o anexo de arquivo binário com um valor de sys_id específico.
Formato da URL
URL com controle de versão: /api/now/v1/attachment/{sys_id}/file
URL padrão: /api/now/attachment/{sys_id}/file
Parâmetros de solicitação compatíveis
Nome | Descrição |
---|---|
sys_id | Sys_id do registro de anexo do qual os dados binários serão retornados. |
Nome | Descrição |
---|---|
Nenhum(a) |
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.
Cabeçalho | Descrição |
---|---|
Aceitar | Formato de dados do corpo da resposta. Por exemplo, use image/jpeg ou image/png para aceitar exclusivamente arquivos de imagem JPEG ou PNG. Para permitir todos os tipos de imagem, especifique image/* ; para permitir qualquer tipo de arquivo, especifique */* .Padrão: */* |
Cabeçalho | Descrição |
---|---|
X-Anexo-Metadados | Metadados sobre o arquivo retornado, como tamanho, nome e tipo de arquivo. |
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.
Parâmetros do corpo da resposta (JSON ou XML)
Nome | Descrição |
---|---|
Anexo de arquivo binário |
Exemplo: Solicitação de cURL
Anexo - GET /now/attachment/{sys_id}
Retorna os metadados do arquivo de anexo com um valor sys_id específico.
Formato da URL
URL com controle de versão: /api/now/v1/attachment/{sys_id}
URL padrão: /api/now/attachment/{sys_id}
Parâmetros de solicitação compatíveis
Nome | Descrição |
---|---|
sys_id | Sys_id do registro de anexo para o qual os metadados serão recuperados. |
Nome | Descrição |
---|---|
Nenhum(a) |
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.
Cabeçalho | Descrição |
---|---|
Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Cabeçalho | Descrição |
---|---|
Tipo de conteúdo | O tipo de conteúdo da resposta. Para solicitações de metadados, este é o tipo de conteúdo dos metadados, não o tipo de conteúdo dos arquivos de anexo. |
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.
Parâmetros do corpo da resposta (JSON ou XML)
Nome | Descrição |
---|---|
Metadados específicos para o anexo especificado. |
Exemplo: Solicitação de cURL
Anexo - POST /now/attachment/file
Carrega um arquivo binário especificado como um anexo para um registro especificado.
Formato da URL
URL com controle de versão: /api/now/v1/attachment/file
URL padrão: /api/now/attachment/file
Parâmetros de solicitação compatíveis
Nome | Descrição |
---|---|
Nenhum(a) |
Nome | Descrição |
---|---|
<String> | Caminho para o arquivo binário a ser anexado ao registro especificado. |
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.
Cabeçalho | Descrição |
---|---|
Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Tipo de conteúdo | Tipo de conteúdo do arquivo a ser anexado, como imagem/jpeg ou */*. Este cabeçalho é obrigatório para publicar anexos de arquivo. |
Cabeçalho | Descrição |
---|---|
Local | URL do novo anexo. |
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.
Parâmetros do corpo da resposta (JSON ou XML)
Exemplo: Solicitação de cURL
Anexo - POST /now/attachment/upload
Carrega um anexo de arquivo de várias partes.
O método POST multipartes não aceita nenhum parâmetro. Você deve especificar o nome da tabela e os valores de sys_id do registro no corpo do formulário. Consulte o exemplo de cURL para obter uma amostra de uma solicitação de dados de formulário/várias partes.
Formato da URL
URL com controle de versão: /api/now/v1/attachment/upload
URL padrão: /api/now/attachment/upload
Parâmetros de solicitação compatíveis
Nome | Descrição |
---|---|
Nenhum(a) |
Nome | Descrição |
---|---|
Nenhum(a) |
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.
Cabeçalho | Descrição |
---|---|
Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
Tipo de conteúdo | Tipo de conteúdo da solicitação. Defina este valor como multipart/form-data ao usar o método POST multipart. |
Cabeçalho | Descrição |
---|---|
Local | URL do novo anexo. |
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.
Parâmetros do corpo da resposta (JSON ou XML)
Valores obrigatórios de várias partes de POST
Valor | Descrição |
---|---|
Tipo de conteúdo | Tipo de conteúdo do arquivo, incluído no corpo da mensagem para carregamentos de várias partes. Nota: O tipo de conteúdo deve ser definido na parte do arquivo da mensagem POST, não nos dados do formulário. Consulte a amostra de mensagem multipartes POST para obter um exemplo de uma mensagem multipartes.
Tipo de dados: cadeia de caracteres |
table_name | Nome da tabela à qual você deseja anexar o arquivo. Tipo de dados: cadeia de caracteres |
table_sys_id | Sys_id do registro na tabela especificada à qual você deseja anexar o arquivo. Tipo de dados: cadeia de caracteres |