API de anexo CSM

. Anexo CSM A API fornece endpoints que permitem que usuários internos e externos carreguem, baixem e removam anexos associados a uma tabela e recuperem metadados de anexo.

Somente anexos associados a tabelas especificadas em glide.rest.attachment_csm_api.allowed_tablesas propriedades do sistema são válidas em qualquer uma das chamadas de endpoint associadas. Qualquer usuário conectado, snc_internal e snc_external, pode acessar esta API. Convidados e usuários públicos não têm direitos de acesso.

Esta API 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 com.glide.attachment.max_sizee. glide.attachment.extensionspropriedades.

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 .

Anexo CSM - EXCLUA /now/attachment_csm/

Exclui o anexo indicado.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/v1/attachment_csm/

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
sys_id	Sys_id do anexo a ser excluído. Este anexo deve pertencer a uma das tabelas listadas em glide.rest.attachment_csm_api.allowed_tablesPropriedade na tabela Propriedades do sistema [sys_properties]. Tipo de dados: Cadeia de caracteres

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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
Nenhum(a)

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
204	Bem-sucedido. Indica que a solicitação foi concluída com sucesso.
400	Solicitação Incorreta. Indica que o anexo desta tabela pode não estar acessível. Verifique se a tabela associada está incluída no glide.rest.attachment_csm_api.allowed_tablespropriedade do sistema.
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 (JSON ou XML)

Nome	Descrição
Nenhum(a)

Solicitação de cURL de amostra

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5" \
--request DELETE \
--user 'username':'password'

None

Anexo CSM - OBTENHA /now/attachment_csm

Retorna os metadados de vários anexos.

Nota:

Você pode fazer referência a todos os parâmetros de consulta do sysparm usando o nome completo ou o nome abreviado (sem sysparm_prefixo). Por exemplo, para sysparm_limitvocê também pode usar limit.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/v1/attachment_csm

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

Tabela 8. Parâmetros de consulta

Nome	Descrição
sysparm_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use sysparm_offsetparâmetro para paginar a recuperação de registro. Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem do registro para que os registros que você tenha acesso sejam retornados primeiro. Nota: Incomum grande sysparm_limitos valores podem afetar o desempenho do sistema. Tipo de dados: Número Padrão: 20 Máximo: 100
sysparm_offset	Í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 você chamar este endpoint, sysparm_offsetdefinido como "0". Para simplesmente percorrer todos os registros disponíveis, use se você não tiver certeza de que você está usando o sysparm_offset até chegar ao final de todos os registros. Não passe um número negativo em sysparm_offsetparâmetro. Tipo de dados: Número Padrão: 0
sysparm_query	Obrigatório. Consulta codificada a ser usada para pesquisar anexos. Este parâmetro deve conter pelo menos sysparm_query <table>onde <table>só podem ser as tabelas especificadas em glide.rest.attachment_csm_api.allowed_tablesPropriedade localizada na tabela Propriedades do sistema [sys_properties]. Por exemplo: sysparm_query . Sintaxe: sysparm_query_query_<col_name> <operator> <value> . <col_name>: Nome da coluna da tabela a ser filtrada. Compatível com os seguintes valores <operator>: Corresponde exatamente ao <value>. Não corresponde ao <value>. Declarações de consulta lógica E múltipla. OU: Declarações de consulta lógica OU múltipla. CURTIR: O <col_name> contém a cadeia de caracteres especificada. Funciona somente para campos do <col_name> cujo tipo de dados é cadeia de caracteres. STARTSWITH: O <col_name> começa com a cadeia de caracteres especificada. Funciona somente para campos do <col_name> cujo tipo de dados é cadeia de caracteres. ENDSWITH: O <col_name> termina com a cadeia de caracteres especificada. Funciona somente para campos do <col_name> cujo tipo de dados é cadeia de caracteres. <value>: Valor a ser correspondido. Todos os parâmetros diferenciam maiúsculas de minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query_<col_name> <operator> <value>[<operator> <col_name> <operator> <value>] . Por exemplo: (Sysparm_query_caller_id_id_javascript:gs.getUserID() "ative_true") As consultas codificadas também são compatíveis com a funcionalidade ordenar por. Para classificar respostas com base em determinados campos, use ORDERBY e. ORDERBYDESC cláusulas em sysparm_query. Sintaxe: ORDERBY<col_name> ORDERBYDESC<col_name> Por exemplo: SYsparm_query Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Tipo de dados: Cadeia de caracteres

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
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 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.
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)

Elemento	Descrição
resultado	Metadados do anexo solicitado. Tipo de dados: Objeto "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
average_image_color	Se o anexo for uma imagem, a soma de todas as cores. Tipo de dados: Cadeia de caracteres RGB ou número de pixels.
result.compressed	Sinalizador que indica se o arquivo de anexo foi compactado. Valores possíveis: Verdadeiro: O arquivo foi compactado. Falso: O arquivo não foi compactado. Tipo de dados: Cadeia de caracteres
result.content_type	Content-type do arquivo de anexo associado, como image ou jpeg ou application/x-shockwave-flash. Tipo de dados: Cadeia de caracteres
created_by_name	Nome completo da entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.download_link	URL de download do anexo no ServiceNow instância. Tipo de dados: Cadeia de caracteres
result.file_name	Nome do arquivo do anexo. Tipo de dados: Cadeia de caracteres
result.image_height	Se for um arquivo de imagem, a altura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.image_width	Se for um arquivo de imagem, a largura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.size_bytes	Tamanho do anexo. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.size_compacted	Tamanho do arquivo de anexo compactado. Se o arquivo não estiver compactado, vazio. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.sys_created_by	Entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_created_on	Data e hora em que o arquivo de anexo foi salvo inicialmente na instância. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	Sys_id do arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_mod_count	Número de vezes que o arquivo de anexo foi modificado (carregado na instância). Tipo de dados: Cadeia de caracteres
result.sys_tags	Marcadores do sistema associados ao arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_by	Entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_on	Data e hora em que o arquivo de anexo foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
result.table_name	Nome da tabela à qual o anexo está associado. Tipo de dados: Cadeia de caracteres
result.table_sys_id	Sys_id da tabela associada ao anexo. Tipo de dados: Cadeia de caracteres
result.updated_by_name	Nome completo da entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

curl "https://instance.service-now.com/api/now/v1/attachment_csm?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
      "size_bytes": "462",
      "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5/file",
      "sys_updated_on": "2009-05-21 04:12:21",
      "sys_id": "615ea769c0a80166001cf5f2367302f5",
      "image_height": "",
      "sys_created_on": "2009-05-21 04:12:21",
      "file_name": "blocks.swf",
      "sys_created_by": "glide.maint",
      "compressed": "true",
      "average_image_color": "",
      "sys_updated_by": "glide.maint",
      "sys_tags": "",
      "table_name": "content_block_programmatic",
      "image_width": "",
      "sys_mod_count": "0",
      "content_type": "application/x-shockwave-flash",
      "size_compressed": "485",
      "created_by_name": "John Smith",
      "updated_by_name": "John Smith"
    }
  ]
}

Anexo CSM - OBTENHA /now/attachment_csm//file

Retorna o anexo de arquivo para o sys_id do anexo especificado.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/v1/attachment_csm//file

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 13. 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
sys_id	Sys_id do anexo. Este anexo deve pertencer a uma das tabelas listadas em glide.rest.attachment_csm_api.allowed_tablesPropriedade na tabela Propriedades do sistema [sys_properties]. Tipo de dados: Cadeia de caracteres Tabela: Anexos [sys_attachment]

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. 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 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Por exemplo, use imagem/jpeg ou imagem/png Para aceitar arquivos de imagem JPEG ou PNG exclusivamente. Para permitir todos os tipos de imagem, especifique imagem/* ; para permitir qualquer tipo de arquivo, especifique */* . Padrão: */*

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
X-Attachment-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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Indica que o anexo desta tabela pode não estar acessível. Verifique se a tabela associada está incluída no glide.rest.attachment_csm_api.allowed_tablespropriedade do sistema.
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

Nome	Descrição
	Conteúdo do anexo.

Solicitação de cURL de amostra

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/<attachment_sys_id>/file" \
--request GET \
--header "Accept:*/*" \
--user 'username':'password'

Recipient list Internal users Sheet1
sys_id	email
 Recipient list Internal users.xlsx

Anexo CSM - OBTENHA /now/attachment_csm/

Retorna os metadados do arquivo de anexo com o sys_id do anexo específico.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/v1/attachment_csm/

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
sys_id	Sys_id do registro de anexo para o qual os metadados serão retornados. Este anexo deve pertencer a uma das tabelas listadas em glide.rest.attachment_csm_api.allowed_tablesPropriedade na tabela Propriedades do sistema [sys_properties]. Tipo de dados: Cadeia de caracteres

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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.
400	Solicitação Incorreta. Indica que o anexo desta tabela pode não estar acessível. Verifique se a tabela associada está incluída no glide.rest.attachment_csm_api.allowed_tablespropriedade do sistema.
401	Não autorizado. As credenciais do usuário estão incorretas.
404	Não encontrado. Indica que o anexo especificado não existe ou que o usuário atual não tem os direitos para acessá-lo.
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)

Elemento	Descrição
resultado	Metadados do anexo solicitado. Tipo de dados: Objeto "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
average_image_color	Se o anexo for uma imagem, a soma de todas as cores. Tipo de dados: Cadeia de caracteres RGB ou número de pixels.
result.compressed	Sinalizador que indica se o arquivo de anexo foi compactado. Valores possíveis: Verdadeiro: O arquivo foi compactado. Falso: O arquivo não foi compactado. Tipo de dados: Cadeia de caracteres
result.content_type	Content-type do arquivo de anexo associado, como image ou jpeg ou application/x-shockwave-flash. Tipo de dados: Cadeia de caracteres
created_by_name	Nome completo da entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.download_link	URL de download do anexo no ServiceNow instância. Tipo de dados: Cadeia de caracteres
result.file_name	Nome do arquivo do anexo. Tipo de dados: Cadeia de caracteres
result.image_height	Se for um arquivo de imagem, a altura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.image_width	Se for um arquivo de imagem, a largura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.size_bytes	Tamanho do anexo. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.size_compacted	Tamanho do arquivo de anexo compactado. Se o arquivo não estiver compactado, vazio. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.sys_created_by	Entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_created_on	Data e hora em que o arquivo de anexo foi salvo inicialmente na instância. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	Sys_id do arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_mod_count	Número de vezes que o arquivo de anexo foi modificado (carregado na instância). Tipo de dados: Cadeia de caracteres
result.sys_tags	Marcadores do sistema associados ao arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_by	Entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_on	Data e hora em que o arquivo de anexo foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
result.table_name	Nome da tabela à qual o anexo está associado. Tipo de dados: Cadeia de caracteres
result.table_sys_id	Sys_id da tabela associada ao anexo. Tipo de dados: Cadeia de caracteres
result.updated_by_name	Nome completo da entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
    "size_bytes": "462",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/615ea769c0a80166001cf5f2367302f5/file",
    "sys_updated_on": "2019-05-21 04:12:21",
    "sys_id": "615ea769c0a80166001cf5f2367302f5",
    "image_height": "",
    "sys_created_on": "2019-05-21 04:12:21",
    "file_name": "blocks.swf",
    "sys_created_by": "glide.maint",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "glide.maint",
    "sys_tags": "",
    "table_name": "content_block_programmatic",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "application/x-shockwave-flash",
    "size_compressed": "485",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}

Anexo CSM - POST /now/attachment_csm/file

Carrega um arquivo binário especificado como um anexo para um registro especificado.

O endpoint também retorna os metadados do anexo salvo.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/v1/attachment_csm/file

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
encryption_context	Sys_id de um registro de contexto de criptografia. Especifique este parâmetro para permitir que somente usuários com o contexto de criptografia especificado acessem o anexo. Para obter informações adicionais sobre registros de contexto de criptografia, consulte Field Encryption. Tipo de dados: Cadeia de caracteres Padrão: O arquivo anexado não é criptografado com nenhum contexto de criptografia.
file_name	Obrigatório. Nome a ser fornecido ao anexo. Nota: O arquivo a ser anexado deve ser especificado após o último parâmetro na lista de parâmetros de consulta aprovados. Tipo de dados: Cadeia de caracteres
table_name	Obrigatório. Nome da tabela à qual você deseja anexar o arquivo. Esta tabela deve ser listada em glide.rest.attachment_csm_api.allowed_tablesPropriedade do sistema na tabela Propriedades do sistema [sys_properties]. Tipo de dados: Cadeia de caracteres
table_sys_id	Obrigatório. Sys_id do registro na tabela especificada à qual você deseja anexar o arquivo. Tipo de dados: Cadeia de caracteres

Tabela 27. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
<String>	Caminho para o arquivo binário a ser anexado ao registro especificado. Tipo de dados: Cadeia de caracteres

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
Tipo de conteúdo	Obrigatório. Formato de dados do arquivo a ser publicado. Por exemplo, use imagem/jpeg ou imagem/png Publicar arquivos de imagem JPEG ou PNG exclusivamente. Para permitir todos os tipos de imagem, especifique imagem/* ; para permitir qualquer tipo de arquivo, especifique */* .

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.
400	Solicitação Incorreta. Indica que o anexo desta tabela pode não estar acessível. Verifique se a tabela associada está incluída no glide.rest.attachment_csm_api.allowed_tablespropriedade do sistema.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. Indica o registro especificado pelo table_namee. table_sys_idos parâmetros não existem ou não podem ser acessados pelo usuário atual.
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)

Elemento	Descrição
resultado	Metadados do anexo solicitado. Tipo de dados: Objeto "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
average_image_color	Se o anexo for uma imagem, a soma de todas as cores. Tipo de dados: Cadeia de caracteres RGB ou número de pixels.
result.compressed	Sinalizador que indica se o arquivo de anexo foi compactado. Valores possíveis: Verdadeiro: O arquivo foi compactado. Falso: O arquivo não foi compactado. Tipo de dados: Cadeia de caracteres
result.content_type	Content-type do arquivo de anexo associado, como image ou jpeg ou application/x-shockwave-flash. Tipo de dados: Cadeia de caracteres
created_by_name	Nome completo da entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.download_link	URL de download do anexo no ServiceNow instância. Tipo de dados: Cadeia de caracteres
result.file_name	Nome do arquivo do anexo. Tipo de dados: Cadeia de caracteres
result.image_height	Se for um arquivo de imagem, a altura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.image_width	Se for um arquivo de imagem, a largura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.size_bytes	Tamanho do anexo. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.size_compacted	Tamanho do arquivo de anexo compactado. Se o arquivo não estiver compactado, vazio. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.sys_created_by	Entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_created_on	Data e hora em que o arquivo de anexo foi salvo inicialmente na instância. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	Sys_id do arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_mod_count	Número de vezes que o arquivo de anexo foi modificado (carregado na instância). Tipo de dados: Cadeia de caracteres
result.sys_tags	Marcadores do sistema associados ao arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_by	Entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_on	Data e hora em que o arquivo de anexo foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
result.table_name	Nome da tabela à qual o anexo está associado. Tipo de dados: Cadeia de caracteres
result.table_sys_id	Sys_id da tabela associada ao anexo. Tipo de dados: Cadeia de caracteres
result.updated_by_name	Nome completo da entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

Mostra como carregar o arquivo .jpg Issue_screenshot.jpg em /images diretório.

curl "https://instance.servicenow.com/api/now/v1/attachment_csm/file?table_name=incident&table_sys_id=d71f7935c0a8016700802b64c67c11c6&file_name=Issue_screenshot" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type: image/jpeg" \
--user "username":"password" \
--data-binary "@/images/Issue_screenshot.jpg"

{
  "result": {
    "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
    "size_bytes": "36597",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/6ea10fe64f411200adf9f8e18110c739/file",
    "sys_updated_on": "2019-01-22 15:14:07",
    "sys_id": "6ea10fe64f411200adf9f8e18110c739",
    "image_height": "",
    "sys_created_on": "2019-01-22 15:14:07",
    "file_name": "Issue_screenshot",
    "sys_created_by": "username",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "username",
    "sys_tags": "",
    "table_name": "incident",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "image/jpeg",
    "size_compressed": "25130",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}

Anexo CSM - POST /now/attachment_csm/upload

Carrega um anexo de arquivo de várias partes.

O método POST DE várias partes não aceita parâmetros. Você deve especificar o nome da tabela e os valores sys_id do registro no corpo do formulário. Consulte o exemplo de cURL abaixo para obter uma amostra de uma solicitação multipart/form-data.

Nota:

Ao usar POST DE várias partes, certifique-se de que o conteúdo do arquivo esteja contido somente na parte final da mensagem. Peças anteriores devem conter somente metadados, como nome da tabela e sys_id do registro.

Ao enviar uma solicitação POST multipart/form-data para carregar um anexo de arquivo, inclua os dados do anexo no corpo do formulário, não nos parâmetros de URL ou no corpo da solicitação.

Tabela 31. Valores obrigatórios

Valor	Descrição
Tipo de conteúdo	Content-Type do arquivo, incluído no corpo da mensagem para carregamentos de várias partes. Nota: Você deve definir o Content-Type na parte do arquivo da mensagem POST, não nos dados do formulário. Tipo de dados: Cadeia de caracteres
table_name	Nome da tabela à qual você deseja anexar o arquivo. Esta tabela deve ser especificada em glide.rest.attachment_csm_api.allowed_tablesPropriedade na tabela Propriedades do sistema [sys_properties]. 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

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/v1/attachment_csm/upload

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 32. 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 33. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 34. 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 35. Cabeçalhos da solicitação

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Defina este valor como dados de formulário/várias partes Ao usar o método POST de várias partes.

Tabela 36. Cabeçalhos de resposta

Cabeçalho	Descrição
Local	URL do novo anexo no ServiceNow instância da plataforma.

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 37. Códigos de status

Código do status	Descrição
201	Bem-sucedido. Indica que a solicitação foi concluída com sucesso.
400	Solicitação Incorreta. Indica que o anexo desta tabela pode não estar acessível. Verifique se a tabela associada está incluída no glide.rest.attachment_csm_api.allowed_tablespropriedade do sistema.
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.

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

Elemento	Descrição
resultado	Metadados do anexo solicitado. Tipo de dados: Objeto "result": { "average_image_color": "String", "compressed": "String", "content_type": "String", "created_by_name": "String", "download_link": "String", "file_name": "String", "image_height": "String", "image_width": "String", "size_bytes": "String", "size_compressed": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "table_name": "String", "table_sys_id": "String", "updated_by_name": "String" }
average_image_color	Se o anexo for uma imagem, a soma de todas as cores. Tipo de dados: Cadeia de caracteres RGB ou número de pixels.
result.compressed	Sinalizador que indica se o arquivo de anexo foi compactado. Valores possíveis: Verdadeiro: O arquivo foi compactado. Falso: O arquivo não foi compactado. Tipo de dados: Cadeia de caracteres
result.content_type	Content-type do arquivo de anexo associado, como image ou jpeg ou application/x-shockwave-flash. Tipo de dados: Cadeia de caracteres
created_by_name	Nome completo da entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.download_link	URL de download do anexo no ServiceNow instância. Tipo de dados: Cadeia de caracteres
result.file_name	Nome do arquivo do anexo. Tipo de dados: Cadeia de caracteres
result.image_height	Se for um arquivo de imagem, a altura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.image_width	Se for um arquivo de imagem, a largura da imagem. Tipo de dados: Cadeia de caracteres Unidade: Pixels
result.size_bytes	Tamanho do anexo. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.size_compacted	Tamanho do arquivo de anexo compactado. Se o arquivo não estiver compactado, vazio. Tipo de dados: Cadeia de caracteres Unidade: Bytes
resultado.sys_created_by	Entidade que criou originalmente o arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_created_on	Data e hora em que o arquivo de anexo foi salvo inicialmente na instância. Tipo de dados: Cadeia de caracteres
sys_id.result.sys_id	Sys_id do arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_mod_count	Número de vezes que o arquivo de anexo foi modificado (carregado na instância). Tipo de dados: Cadeia de caracteres
result.sys_tags	Marcadores do sistema associados ao arquivo de anexo. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_by	Entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres
resultado.sys_updated_on	Data e hora em que o arquivo de anexo foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
result.table_name	Nome da tabela à qual o anexo está associado. Tipo de dados: Cadeia de caracteres
result.table_sys_id	Sys_id da tabela associada ao anexo. Tipo de dados: Cadeia de caracteres
result.updated_by_name	Nome completo da entidade que atualizou o arquivo de anexo pela última vez. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

curl "https://instance.service-now.com/api/now/v1/attachment_csm/upload" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:multipart/form-data" \
--user "username":"password" \
 -F "table_name=incident" \
 -F "table_sys_id=d71f7935c0a8016700802b64c67c11c6" \
 -F "uploadFile=@/image/banner-CS0001345_v1_1.jpeg"

{
  "result": {
    "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
    "size_bytes": "36597",
    "download_link": "https://instance.service-now.com/api/now/v1/attachment_csm/994adbc64f511200adf9f8e18110c796/file",
    "sys_updated_on": "2019-02-02 14:00:21",
    "sys_id": "994adbc64f511200adf9f8e18110c796",
    "image_height": "",
    "sys_created_on": "2019-02-02 14:00:21",
    "file_name": "banner-CS0001345_v1_1.jpeg",
    "sys_created_by": "username",
    "compressed": "true",
    "average_image_color": "",
    "sys_updated_by": "username",
    "sys_tags": "",
    "table_name": "incident",
    "image_width": "",
    "sys_mod_count": "0",
    "content_type": "image/jpeg",
    "size_compressed": "25130",
    "created_by_name": "John Smith",
    "updated_by_name": "John Smith"
  }
}