API de anexo do CSM

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 23 min. de leitura

    • A API de anexos do CSM 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 na propriedade do sistema glide.rest.attachment_csm_api.allowed_tables são válidos 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 as propriedades com.glide.attachment.max_size e glide.attachment.extensions.

    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 - DELETE /now/attachment_csm/{sys_id}

    Exclui o anexo indicado.

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/attachment_csm/{sys_id}

    URL padrão: /api/now/v1/attachment_csm/{sys_id}

    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. 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 na propriedade glide.rest.attachment_csm_api.allowed_tables ] na tabela Propriedades do sistema [sys_properties].

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

    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
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 6. Códigos de status
    Código de 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 na propriedade do sistema glide.rest.attachment_csm_api.allowed_tables.
    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

    Exemplo de solicitação cURL

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

    Anexo CSM - GET /now/attachment_csm

    Retorna os metadados de vários anexos.

    Nota:
    Você pode fazer referência a todos os parâmetros de consulta sysparm usando o nome completo ou o nome abreviado (sem o prefixo sysparm_ ). Por exemplo, para sysparm_limit você também pode usar limit.

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/attachment_csm

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

    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. 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 o parâmetro sysparm_offset para paginar a recuperação do 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 dos registros para que os registros aos quais você tenha acesso sejam retornados primeiro.

    Nota:
    Valores extraordinariamente grandes sysparm_limit podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 10000
    sysparm_offset Índice de registro inicial para o qual iniciar a recuperação de registros. Use este valor para paginar a recuperação do 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ê chama este endpoint, sysparm_offset é definido como "0". Para simplesmente paginar todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limit, até chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    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_name=<table> em que <table> só pode ser as tabelas especificadas na propriedade glide.rest.attachment_csm_api.allowed_tables localizada na tabela Propriedades do sistema [sys_properties]. Por exemplo: sysparm_query=file_name=kb_knowledge.

    Sintaxe: sysparm_query=<col_name><operator><value> .
    • <col_name>: Nome da coluna da tabela para filtrar.
    • <operator>: oferece suporte aos seguintes valores:
      • =: corresponde exatamente a<value> .
      • !=: não corresponde<value> .
      • ^: logicamente E várias declarações de consulta.
      • ^OR: logicamente OU várias declarações de consulta.
      • CURTA:<col_name> contém a cadeia de caracteres especificada. Só funciona para<col_name> campos cujo tipo de dados é cadeia de caracteres.
      • COMEÇA COM:<col_name> começa com a cadeia de caracteres especificada. Só funciona para<col_name> campos cujo tipo de dados é cadeia de caracteres.
      • ENDSWITH:<col_name> termina com a cadeia de caracteres especificada. Só funciona para<col_name> 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. As consultas podem conter mais de uma entrada, como sysparm_query =<col_name><operator><value> [ ] .

    Por exemplo:

    (sysparm_query=caller_id=javascript:gs.getUserID()^active=true)

    As consultas codificadas também oferecem suporte à funcionalidade de ordenação. Para classificar respostas com base em determinados campos, use as cláusulas ORDERBY e ORDERBYDESC em sysparm_query.

    Sintaxe:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    Por exemplo: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory

    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. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    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
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

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

    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"
}
    resultado.média_imagem_cor Se o anexo for uma imagem, a soma de todas as cores.

    Tipo de dados: cadeia de caracteres

    Unidade: RGB ou número de pixels.
    resultado.compactado Sinalizador que indica se o arquivo de anexo foi compactado.
    Valores válidos:
    • verdadeiro: o arquivo foi compactado.
    • falso: o arquivo não foi compactado.

    Tipo de dados: cadeia de caracteres
    result.content_type Tipo de conteúdo do arquivo de anexo associado, como imagem, jpeg ou aplicação/x-shockondas-flash.

    Tipo de dados: cadeia de caracteres
    resultado.criado_por_nome 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 na instância ServiceNow.

    Tipo de dados: cadeia de caracteres
    result.file_name Nome do arquivo do anexo.

    Tipo de dados: cadeia de caracteres
    resultado.image_height Se for um arquivo de imagem, a altura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.image_width Se for um arquivo de imagem, a largura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.size_bytes Tamanho do anexo.

    Tipo de dados: cadeia de caracteres

    Unidade: bytes
    resultado.size_compressed 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
    resultado.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 para a instância).

    Tipo de dados: cadeia de caracteres
    resultado.sys_tags Quaisquer 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
    resultado.atualizado_por_nome Nome completo da entidade que atualizou o arquivo de anexo pela última vez.

    Tipo de dados: cadeia de caracteres

    Exemplo de solicitação cURL

    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 - GET /now/attachment_csm/{sys_id}/file

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

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/attachment_csm/{sys_id}/file

    URL padrão: /api/now/v1/attachment_csm/{sys_id}/file

    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 acessada. 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 listado na tabela Anexos [sys_attachment]. Este anexo deve pertencer a uma das tabelas listadas na propriedade glide.rest.attachment_csm_api.allowed_tables ] na tabela Propriedades do sistema [sys_properties].
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    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 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: */*
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    X-Anexo-Metadados Metadados sobre o arquivo retornado, como tamanho, nome e tipo de arquivo.

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 18. Códigos de status
    Código de 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 na propriedade do sistema glide.rest.attachment_csm_api.allowed_tables.
    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.

    Exemplo de solicitação cURL

    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 - GET /now/attachment_csm/{sys_id}

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

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/attachment_csm/{sys_id}

    URL padrão: /api/now/v1/attachment_csm/{sys_id}

    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. 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 na propriedade glide.rest.attachment_csm_api.allowed_tables ] na tabela Propriedades do sistema [sys_properties].

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

    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

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 24. Códigos de status
    Código de 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 na propriedade do sistema glide.rest.attachment_csm_api.allowed_tables.
    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 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"
}
    resultado.média_imagem_cor Se o anexo for uma imagem, a soma de todas as cores.

    Tipo de dados: cadeia de caracteres

    Unidade: RGB ou número de pixels.
    resultado.compactado Sinalizador que indica se o arquivo de anexo foi compactado.
    Valores válidos:
    • verdadeiro: o arquivo foi compactado.
    • falso: o arquivo não foi compactado.

    Tipo de dados: cadeia de caracteres
    result.content_type Tipo de conteúdo do arquivo de anexo associado, como imagem, jpeg ou aplicação/x-shockondas-flash.

    Tipo de dados: cadeia de caracteres
    resultado.criado_por_nome 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 na instância ServiceNow.

    Tipo de dados: cadeia de caracteres
    result.file_name Nome do arquivo do anexo.

    Tipo de dados: cadeia de caracteres
    resultado.image_height Se for um arquivo de imagem, a altura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.image_width Se for um arquivo de imagem, a largura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.size_bytes Tamanho do anexo.

    Tipo de dados: cadeia de caracteres

    Unidade: bytes
    resultado.size_compressed 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
    resultado.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 para a instância).

    Tipo de dados: cadeia de caracteres
    resultado.sys_tags Quaisquer 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
    resultado.atualizado_por_nome Nome completo da entidade que atualizou o arquivo de anexo pela última vez.

    Tipo de dados: cadeia de caracteres

    Exemplo de solicitação cURL

    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 anexo para um registro especificado.

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

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/attachment_csm/file

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

    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. 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
    criptografia_contexto 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 Encryption Support.

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

    Tipo de dados: cadeia de caracteres
    table_name Obrigatório. Nome da tabela à qual você deseja anexar o arquivo. Esta tabela deve ser listada na propriedade do sistema glide.rest.attachment_csm_api.allowed_tables ] na tabela Propriedades do sistema [sys_properties].

    Tipo de dados: cadeia de caracteres
    sys_id_tabela Obrigatório. Sys_id do registro na tabela especificada à qual você deseja anexar o arquivo.

    Tipo de dados: cadeia de caracteres
    Tabela 27. Parâmetros do corpo da solicitação (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/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Obrigatório. Formato de dados do arquivo a ser publicado. Por exemplo, use image/jpeg ou image/png para publicar arquivos de imagem JPEG ou PNG exclusivamente. Para permitir todos os tipos de imagem, especifique image/*; para permitir qualquer tipo de arquivo, especifique */*.
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 30. Códigos de status
    Código de 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 na propriedade do sistema glide.rest.attachment_csm_api.allowed_tables.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. Indica que o registro especificado pelos parâmetros table_name e table_sys_id não existe ou não pode ser acessado 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"
}
    resultado.média_imagem_cor Se o anexo for uma imagem, a soma de todas as cores.

    Tipo de dados: cadeia de caracteres

    Unidade: RGB ou número de pixels.
    resultado.compactado Sinalizador que indica se o arquivo de anexo foi compactado.
    Valores válidos:
    • verdadeiro: o arquivo foi compactado.
    • falso: o arquivo não foi compactado.

    Tipo de dados: cadeia de caracteres
    result.content_type Tipo de conteúdo do arquivo de anexo associado, como imagem, jpeg ou aplicação/x-shockondas-flash.

    Tipo de dados: cadeia de caracteres
    resultado.criado_por_nome 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 na instância ServiceNow.

    Tipo de dados: cadeia de caracteres
    result.file_name Nome do arquivo do anexo.

    Tipo de dados: cadeia de caracteres
    resultado.image_height Se for um arquivo de imagem, a altura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.image_width Se for um arquivo de imagem, a largura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.size_bytes Tamanho do anexo.

    Tipo de dados: cadeia de caracteres

    Unidade: bytes
    resultado.size_compressed 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
    resultado.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 para a instância).

    Tipo de dados: cadeia de caracteres
    resultado.sys_tags Quaisquer 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
    resultado.atualizado_por_nome Nome completo da entidade que atualizou o arquivo de anexo pela última vez.

    Tipo de dados: cadeia de caracteres

    Exemplo de solicitação cURL

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

    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 multipartes não aceita parâmetros. 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 abaixo para obter uma amostra de uma solicitação de dados de formulário/várias partes.
    Nota:
    Ao usar o POST multipartes, certifique-se de que o conteúdo do arquivo esteja contido somente na parte final da mensagem. As peças anteriores devem conter somente metadados, como o nome da tabela e o sys_id do registro.
    Ao enviar uma solicitação POST de dados de formulário/várias partes 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 Tipo de conteúdo do arquivo, incluído no corpo da mensagem para uploads de várias partes.
    Nota:
    Você deve definir o tipo de conteúdo 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 na propriedade glide.rest.attachment_csm_api.allowed_tables ] na tabela Propriedades do sistema [sys_properties].

    Tipo de dados: cadeia de caracteres
    sys_id_tabela 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ões: /api/now/{api_version}/attachment_csm/upload

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

    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 acessada. 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
    Tabela 34. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    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 multipart/form-data ao usar o método POST multipart.
    Tabela 36. Cabeçalhos de resposta
    Cabeçalho Descrição
    Local URL do novo anexo na instância da plataforma ServiceNow.

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 37. Códigos de status
    Código de 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 na propriedade do sistema glide.rest.attachment_csm_api.allowed_tables.
    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"
}
    resultado.média_imagem_cor Se o anexo for uma imagem, a soma de todas as cores.

    Tipo de dados: cadeia de caracteres

    Unidade: RGB ou número de pixels.
    resultado.compactado Sinalizador que indica se o arquivo de anexo foi compactado.
    Valores válidos:
    • verdadeiro: o arquivo foi compactado.
    • falso: o arquivo não foi compactado.

    Tipo de dados: cadeia de caracteres
    result.content_type Tipo de conteúdo do arquivo de anexo associado, como imagem, jpeg ou aplicação/x-shockondas-flash.

    Tipo de dados: cadeia de caracteres
    resultado.criado_por_nome 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 na instância ServiceNow.

    Tipo de dados: cadeia de caracteres
    result.file_name Nome do arquivo do anexo.

    Tipo de dados: cadeia de caracteres
    resultado.image_height Se for um arquivo de imagem, a altura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.image_width Se for um arquivo de imagem, a largura da imagem.

    Tipo de dados: cadeia de caracteres

    Unidade: pixels
    resultado.size_bytes Tamanho do anexo.

    Tipo de dados: cadeia de caracteres

    Unidade: bytes
    resultado.size_compressed 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
    resultado.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 para a instância).

    Tipo de dados: cadeia de caracteres
    resultado.sys_tags Quaisquer 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
    resultado.atualizado_por_nome Nome completo da entidade que atualizou o arquivo de anexo pela última vez.

    Tipo de dados: cadeia de caracteres

    Exemplo de solicitação cURL

    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"
  }
}