API da tabela

Seguir

Salvar como PDF

Compartilhar esta página

Feedback

Imprimir

Índice

Implementação e referência de API

Página inicialReferência de API do YokohamaImplementação e referência de APIReferência de APIReferência de REST APIAPI da tabela

Sumário

API da tabela

Versão:
Yokohama
Xanadu
Washington DC
Vancouver
Atualizado30 de jan. de 2025
27 min. de leitura

Yokohama
"Implementação e referência de API"

Algumas partes deste tópico podem ter sido traduzidas automaticamente.

A API da tabela fornece endpoints que permitem executar operações de criação, leitura, atualização e exclusão (CRUD) em tabelas existentes.

O usuário que faz a chamada deve ter funções suficientes para acessar os dados na tabela especificada na solicitação.

Tabela - DELETE /now/table/{tableName}/{sys_id}

Exclui o registro especificado da tabela especificada.

Formato da URL

URL com controle de versão: /api/now/{api_version}/table/{tableName}/{sys_id}

URL padrão: /api/now/table/{tableName}/{sys_id}

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

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro a ser excluído. Tipo de dados: cadeia de caracteres
tableName	Nome da tabela da qual o registro especificado será excluído, como "incidente" ou "ativo". Tipo de dados: cadeia de caracteres

Tabela 2. Parâmetros de consulta
Nome	Descrição
sysparm_query_no_domain	Sinalizador que indica se a pesquisa de registro deve ser restrita somente aos domínios para os quais o usuário conectado está configurado. Valores válidos: falso: exclua o registro se ele estiver em um domínio que o usuário conectado no momento não esteja configurado para acessar. verdadeiro: inclui o registro mesmo se ele estiver em um domínio que o usuário conectado no momento não está configurado para acessar. Tipo de dados: booliano Padrão: falso Nota: O parâmetro sysparm_query_no_domain está disponível somente para administradores do sistema ou usuários que tenham a função query_no_domain_table_api.

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

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

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

Tabela 5. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 6. Códigos de status
Código do status	Descrição
204	Indica que a solicitação foi concluída com sucesso.

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


Nome	Descrição
Nenhum(a)

Exemplo: Solicitação de cURL

Exclua um registro da tabela Incidente.

curl "https://instance.servicenow.com/api/now/table/incident/d977b66a4f411200adf9f8e18110c7b2" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

Não há corpo de resposta.

None

Tabela - GET /now/table/{tableName}

Recupera vários registros da tabela especificada.

Para obter instruções básicas, consulte Recuperar incidentes existentes.

Formato da URL

URL com controle de versão: /api/now/{api_version}/table/{tableName}

URL padrão: /api/now/table/{tableName}

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

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Dependendo da versão, este endpoint retorna resultados diferentes em uma consulta válida. A versão 1 retorna o código de erro 404 sem resultados. A versão 2 retorna o código de sucesso 200 e uma matriz vazia como o corpo da resposta. Tipo de dados: cadeia de caracteres
tableName	Nome da tabela da qual os registros serão recuperados. Tipo de dados: cadeia de caracteres

Search:

Tabela 8. Parâmetros de consulta
Nome	Descrição
pares de nome-valor	Pares de nome-valor a serem usados para filtrar o conjunto de resultados. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar `&sysparm_query=active=true`, você pode simplificar a declaração de chamada usando `&active=true`. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como `&state=closed` em vez de `&state=7`. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como `&active=true&assigned_to=john.smith`. Tipo de dados: cadeia de caracteres
sysparm_display_value	Determina o tipo de dados retornados, os valores reais do banco de dados ou os valores de exibição dos campos. Os valores de exibição são manipulados com base no valor real no banco de dados e nas configurações e preferências do usuário ou do sistema. Se estiver retornando valores de exibição, o valor retornado dependerá do tipo de campo. Campos de opção: o valor do banco de dados pode ser um número, mas o valor de exibição será mais descritivo. Campos de data: o valor do banco de dados está no formato UTC, enquanto o valor de exibição é baseado no fuso horário do usuário. Texto criptografado: o valor do banco de dados é criptografado, enquanto o valor exibido não é criptografado com base no contexto de criptografia do usuário. Campos de referência: o valor do banco de dados é sys_id, mas o valor de exibição é um campo de exibição do registro referenciado. Tipo de dados: cadeia de caracteres Valores válidos: verdadeiro: retorna os valores de exibição de todos os campos. falso: retorna os valores reais do banco de dados. all: retorna valores reais e de exibição. Padrão: falso Nota: Não há nenhum método preferencial para definir este parâmetro. No entanto, especificar o valor de exibição pode causar problemas de desempenho, já que ele não está lendo diretamente do banco de dados e pode incluir referência a outros campos e registros. Para obter mais informações sobre valores de exibição e valores reais, consulte Perguntas frequentes da API da tabela (KB0534905).
sysparm_exclude_reference_link	Sinalizador que indica se os links da API da tabela devem ser excluídos para campos de referência. Valores válidos: verdadeiro: excluir links de API de tabela para campos de referência. falso: incluir links de API de tabela para campos de referência. Tipo de dados: booliano Padrão: falso
sysparm_fields	Lista separada por vírgulas de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: cadeia de caracteres Padrão: retornar todos os campos.
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ê tem acesso sejam retornados primeiro. Nota: Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema. Tipo de dados: número Padrão: 20 Máximo: 100
sysparm_no_count	Sinalizador que indica se uma consulta de `contagem de seleção()` deve ser executada na tabela para retornar o número de linhas na tabela associada. Valores válidos: verdadeiro: não executa uma `contagem de seleção ()`. falso: executa uma `contagem de seleção(*)`. Tipo de dados: booliano Padrão: falso
sysparm_offset	Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer 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	Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. 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. CURTIR:<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. TERMINACOM:<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 à ordem por funcionalidade. 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. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres
sysparm_query_category	Nome da categoria a ser usada para consultas. Tipo de dados: cadeia de caracteres
sysparm_query_no_domain	Sinalizador que indica se a pesquisa de registro deve ser restrita somente aos domínios para os quais o usuário conectado está configurado. Valores válidos: falso: exclua o registro se ele estiver em um domínio que o usuário conectado no momento não esteja configurado para acessar. verdadeiro: inclui o registro mesmo se ele estiver em um domínio que o usuário conectado no momento não está configurado para acessar. Tipo de dados: booliano Padrão: falso Nota: O parâmetro sysparm_query_no_domain está disponível somente para administradores do sistema ou usuários que tenham a função query_no_domain_table_api.
sysparm_suppress_pagination_header	Sinalizador que indica se o cabeçalho do link deve ser removido da resposta. O cabeçalho Link fornece vários URLs para páginas relativas no conjunto de registros que você pode usar para paginar o conjunto de registros retornado. Valores válidos: verdadeiro: remova o cabeçalho do link da resposta. falso: não remova o cabeçalho do link da resposta. Tipo de dados: booliano Padrão: falso
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

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

Cabeçalhos

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
Link	URLs relativos, com base na solicitação anterior, que você pode usar para percorrer o conjunto de registros disponível. Por exemplo: `https://`<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=1000>;rel="next" , `https://`<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=1000>;rel="prev" , `https://`<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=0&sysparm_limit=1000>;rel="first" , `https://<instance name> .servicenow.com/api/now/table/cmdb_ci?sysparm_offset=2780&sysparm_limit=1000>;rel="last"` Para obter informações adicionais sobre o parâmetro rel, consulte https://html.spec.whatwg.org/multipage/links.html#linkTypes.
X-Total-Contagem	Contagem total de registros retornados pela consulta.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 12. Códigos de status
Código do status	Descrição
200	Solicitação concluída com sucesso. Se uma consulta válida não retornou resultados, o corpo da resposta conterá apenas uma matriz de resultados vazia.

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


Parâmetro	Descrição
pares de nome-valor	Nomes de campo e valores de todos os parâmetros no registro especificado ou naqueles especificados nos parâmetros de consulta.

Exemplo: Solicitação de cURL

Recupere o primeiro registro da tabela Problema.

curl "https://instance.servicenow.com/api/now/table/problem?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

A resposta contém os pares de nome-valor do registro solicitado.

{
  "result": [
    {
      "parent": "",
      "made_sla": "true",
      "watch_list": "",
      "upon_reject": "cancel",
      "sys_updated_on": "2016-01-19 04:52:04",
      "approval_history": "",
      "number": "PRB0000050",
      "sys_updated_by": "glide.maint",
      "opened_by": {
        "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
        "value": "glide.maint"
      },
      "user_input": "",
      "sys_created_on": "2016-01-19 04:51:19",
      "sys_domain": {
        "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
        "value": "global"
      },
      "state": "4",
      "sys_created_by": "glide.maint",
      "knowledge": "false",
      "order": "",
      "closed_at": "2016-01-19 04:52:04",
      "cmdb_ci": {
        "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/55b35562c0a8010e01cff22378e0aea9",
        "value": "55b35562c0a8010e01cff22378e0aea9"
      },
      "delivery_plan": "",
      "impact": "3",
      "active": "false",
      "work_notes_list": "",
      "business_service": "",
      "priority": "4",
      "sys_domain_path": "/",
      "time_worked": "",
      "expected_start": "",
      "rejection_goto": "",
      "opened_at": "2016-01-19 04:49:47",
      "business_duration": "1970-01-01 00:00:00",
      "group_list": "",
      "work_end": "",
      "approval_set": "",
      "wf_activity": "",
      "work_notes": "",
      "short_description": "Switch occasionally drops connections",
      "correlation_display": "",
      "delivery_task": "",
      "work_start": "",
      "assignment_group": "",
      "additional_assignee_list": "",
      "description": "Switch occasionally drops connections",
      "calendar_duration": "1970-01-01 00:02:17",
      "close_notes": "updated firmware",
      "sys_class_name": "problem",
      "closed_by": "",
      "follow_up": "",
      "sys_id": "04ce72c9c0a8016600b5b7f75ac67b5b",
      "contact_type": "phone",
      "urgency": "3",
      "company": "",
      "reassignment_count": "",
      "activity_due": "",
      "assigned_to": "",
      "comments": "",
      "approval": "not requested",
      "sla_due": "",
      "comments_and_work_notes": "",
      "due_date": "",
      "sys_mod_count": "1",
      "sys_tags": "",
      "escalation": "0",
      "upon_approval": "proceed",
      "correlation_id": "",
      "location": ""
    }
  ]
}

Tabela - GET /now/table/{tableName}/{sys_id}

Recupera o registro identificado pelo sys_id especificado da tabela especificada.

Formato da URL

URL com controle de versão: /api/now/{api_version}/table/{tableName}/{sys_id}

URL padrão: /api/now/table/{tableName}/{sys_id}

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

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro a ser recuperado. Tipo de dados: cadeia de caracteres
tableName	Nome da tabela da qual o registro será recuperado. Tipo de dados: cadeia de caracteres

Search:

Tabela 14. Parâmetros de consulta
Nome	Descrição
sysparm_display_value	Determina o tipo de dados retornados, os valores reais do banco de dados ou os valores de exibição dos campos. Os valores de exibição são manipulados com base no valor real no banco de dados e nas configurações e preferências do usuário ou do sistema. Se estiver retornando valores de exibição, o valor retornado dependerá do tipo de campo. Campos de opção: o valor do banco de dados pode ser um número, mas o valor de exibição será mais descritivo. Campos de data: o valor do banco de dados está no formato UTC, enquanto o valor de exibição é baseado no fuso horário do usuário. Texto criptografado: o valor do banco de dados é criptografado, enquanto o valor exibido não é criptografado com base no contexto de criptografia do usuário. Campos de referência: o valor do banco de dados é sys_id, mas o valor de exibição é um campo de exibição do registro referenciado. Tipo de dados: cadeia de caracteres Valores válidos: verdadeiro: retorna os valores de exibição de todos os campos. falso: retorna os valores reais do banco de dados. all: retorna valores reais e de exibição. Padrão: falso Nota: Não há nenhum método preferencial para definir este parâmetro. No entanto, especificar o valor de exibição pode causar problemas de desempenho, já que ele não está lendo diretamente do banco de dados e pode incluir referência a outros campos e registros. Para obter mais informações sobre valores de exibição e valores reais, consulte Perguntas frequentes da API da tabela (KB0534905).
sysparm_exclude_reference_link	Sinalizador que indica se os links da API da tabela devem ser excluídos para campos de referência. Valores válidos: verdadeiro: excluir links de API de tabela para campos de referência. falso: incluir links de API de tabela para campos de referência. Tipo de dados: booliano Padrão: falso
sysparm_fields	Lista separada por vírgulas de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: cadeia de caracteres Padrão: retornar todos os campos.
sysparm_query_no_domain	Sinalizador que indica se a pesquisa de registro deve ser restrita somente aos domínios para os quais o usuário conectado está configurado. Valores válidos: falso: exclua o registro se ele estiver em um domínio que o usuário conectado no momento não esteja configurado para acessar. verdadeiro: inclui o registro mesmo se ele estiver em um domínio que o usuário conectado no momento não está configurado para acessar. Tipo de dados: booliano Padrão: falso Nota: O parâmetro sysparm_query_no_domain está disponível somente para administradores do sistema ou usuários que tenham a função query_no_domain_table_api.
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

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

Cabeçalhos

Tabela 16. 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 17. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 18. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
404	Não encontrado. O item solicitado não foi encontrado.

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


Parâmetro	Descrição
pares de nome-valor	Nomes de campo e valores de todos os parâmetros no registro especificado ou naqueles especificados nos parâmetros de consulta.

Exemplo: Solicitação de cURL

Recupere um registro da tabela Incidente.

curl "https://instance.servicenow.com/api/now/table/incident/a9e30c7dc61122760116894de7bcc7bd" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

A resposta contém os pares de nome-valor do registro solicitado.

{
  "result": {
    "upon_approval": "",
    "location": {
      "link": "https://instance.servicenow.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba",
      "value": "105cf7f3c611227501e75e08b14a38ba"
    },
    "expected_start": "",
    "reopen_count": "",
    "close_notes": "",
    "additional_assignee_list": "",
    "impact": "1",
    "urgency": "3",
    "correlation_id": "",
    "sys_tags": "",
    "sys_domain": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
      "value": "global"
    },
    "description": "",
    "group_list": "",
    "priority": "3",
    "delivery_plan": "",
    "sys_mod_count": "4",
    "work_notes_list": "",
    "business_service": "",
    "follow_up": "",
    "closed_at": "",
    "sla_due": "2015-11-11 22:04:15",
    "delivery_task": "",
    "sys_updated_on": "2015-11-01 22:37:27",
    "parent": "",
    "work_end": "",
    "number": "INC0000046",
    "closed_by": "",
    "work_start": "",
    "calendar_stc": "",
    "category": "software",
    "business_duration": "",
    "incident_state": "1",
    "activity_due": "",
    "correlation_display": "",
    "company": "",
    "active": "true",
    "due_date": "",
    "assignment_group": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7",
      "value": "8a4dde73c6112278017a6a4baf547aa7"
    },
    "caller_id": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
      "value": "46c6f9efa9fe198101ddf5eed9adf6e7"
    },
    "knowledge": "false",
    "made_sla": "false",
    "comments_and_work_notes": "",
    "parent_incident": "",
    "state": "1",
    "user_input": "",
    "sys_created_on": "2015-11-01 22:05:30",
    "approval_set": "",
    "reassignment_count": "1",
    "rfc": "",
    "child_incidents": "",
    "opened_at": "2015-11-02 22:04:15",
    "short_description": "Can't access SFA software",
    "order": "",
    "sys_updated_by": "glide.maint",
    "resolved_by": "",
    "notify": "1",
    "upon_reject": "",
    "approval_history": "",
    "problem_id": {
      "link": "https://instance.servicenow.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74",
      "value": "a9e4890bc6112276003d7a5a5c774a74"
    },
    "work_notes": "",
    "calendar_duration": "",
    "close_code": "",
    "sys_id": "a9e30c7dc61122760116894de7bcc7bd",
    "approval": "not requested",
    "caused_by": "",
    "severity": "3",
    "sys_created_by": "admin",
    "resolved_at": "",
    "assigned_to": "",
    "business_stc": "",
    "wf_activity": "",
    "sys_domain_path": "/",
    "cmdb_ci": {
      "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0",
      "value": "a9c0c8d2c6112276018f7705562f9cb0"
    },
    "opened_by": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
      "value": "46c6f9efa9fe198101ddf5eed9adf6e7"
    },
    "subcategory": "",
    "rejection_goto": "",
    "sys_class_name": "incident",
    "watch_list": "",
    "time_worked": "",
    "contact_type": "phone",
    "escalation": "0",
    "comments": ""
  }
}

Tabela - PATCH /now/table/{tableName}/{sys_id}

Atualiza o registro especificado com os pares de nome-valor incluídos no corpo da solicitação.

Formato da URL

URL com controle de versão: /api/now/{api_version}/table/{tableName}/{sys_id}

URL padrão: /api/now/table/{tableName}/{sys_id}

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

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro a ser atualizado. Tipo de dados: cadeia de caracteres
tableName	Nome da tabela na qual o registro especificado está localizado. Tipo de dados: cadeia de caracteres

Search:

Tabela 20. Parâmetros de consulta
Nome	Descrição
sysparm_display_value	Determina o tipo de dados retornados, os valores reais do banco de dados ou os valores de exibição dos campos. Os valores de exibição são manipulados com base no valor real no banco de dados e nas configurações e preferências do usuário ou do sistema. Se estiver retornando valores de exibição, o valor retornado dependerá do tipo de campo. Campos de opção: o valor do banco de dados pode ser um número, mas o valor de exibição será mais descritivo. Campos de data: o valor do banco de dados está no formato UTC, enquanto o valor de exibição é baseado no fuso horário do usuário. Texto criptografado: o valor do banco de dados é criptografado, enquanto o valor exibido não é criptografado com base no contexto de criptografia do usuário. Campos de referência: o valor do banco de dados é sys_id, mas o valor de exibição é um campo de exibição do registro referenciado. Tipo de dados: cadeia de caracteres Valores válidos: verdadeiro: retorna os valores de exibição de todos os campos. falso: retorna os valores reais do banco de dados. all: retorna valores reais e de exibição. Padrão: falso Nota: Não há nenhum método preferencial para definir este parâmetro. No entanto, especificar o valor de exibição pode causar problemas de desempenho, já que ele não está lendo diretamente do banco de dados e pode incluir referência a outros campos e registros. Para obter mais informações sobre valores de exibição e valores reais, consulte Perguntas frequentes da API da tabela (KB0534905).
sysparm_fields	Lista separada por vírgulas de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: cadeia de caracteres Padrão: retornar todos os campos.
sysparm_input_display_value	Sinalizador que indica se os valores de campos devem ser definidos usando o valor de exibição ou o valor real. Dependendo dos diferentes tipos de campos, o endpoint pode manipular os valores de exibição passados para armazenar os valores apropriados no banco de dados. Por exemplo, se você enviar o nome de exibição de um campo de referência, o endpoint armazenará o sys_id desse valor no banco de dados. Para campos de data e hora, quando este parâmetro é verdadeiro, o valor de data e hora é ajustado para o fuso horário do usuário atual. Quando falso, o valor de data e hora é inserido usando o fuso horário GMT. Valores válidos: verdadeiro: trata os valores de entrada como valores de exibição e eles são manipulados para que sejam armazenados corretamente no banco de dados. falso: trata os valores de entrada como valores reais e os armazena no banco de dados sem manipulação. Tipo de dados: booliano Padrão: falso - corresponde ao tipo de dados retornado durante a recuperação de dados (métodos GET), que são os valores reais. Nota: Para definir o valor de um campo criptografado, você deve definir este parâmetro como `verdadeiro`. Se este parâmetro não estiver definido como verdadeiro, os valores enviados para campos criptografados não serão salvos. Além disso, o usuário solicitante deve ter o contexto de criptografia apropriado antes de enviar a solicitação. Os campos criptografados ficam ocultos para usuários sem o contexto de criptografia apropriado. Para obter mais informações sobre criptografia de campo, consulte Criptografia.
sysparm_query_no_domain	Sinalizador que indica se a pesquisa de registro deve ser restrita somente aos domínios para os quais o usuário conectado está configurado. Valores válidos: falso: exclua o registro se ele estiver em um domínio que o usuário conectado no momento não esteja configurado para acessar. verdadeiro: inclui o registro mesmo se ele estiver em um domínio que o usuário conectado no momento não está configurado para acessar. Tipo de dados: booliano Padrão: falso Nota: O parâmetro sysparm_query_no_domain está disponível somente para administradores do sistema ou usuários que tenham a função query_no_domain_table_api.
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
pares de nome-valor	Nome do campo e o novo valor de cada parâmetro a ser atualizado no registro especificado. Nota: Nem todos os campos em um registro podem estar disponíveis para atualização. Por exemplo, os campos que têm um prefixo "sys_" são normalmente parâmetros do sistema que são gerados automaticamente e não podem ser atualizados.

Cabeçalhos

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
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json
X-no-response-body	Por padrão, as respostas incluem o conteúdo do corpo detalhando o registro modificado. Defina este cabeçalho de solicitação como verdadeiro para suprimir o corpo da resposta.

Tabela 23. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 24. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
404	Não encontrado. O item solicitado não foi encontrado.

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


Nome	Descrição
pares de nome-valor	Nomes de campo e valores de todos os parâmetros no registro especificado ou naqueles especificados nos parâmetros de consulta.

Exemplo: Solicitação de cURL

Atualize um registro na tabela Incidente.

curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
--user 'username':'password'

A resposta contém os pares de nome-valor do registro atualizado.

{
  "result": {
    "upon_approval": "proceed",
    "location": {
      "link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
      "value": "108752c8c611227501d4ab0e392ba97f"
    },
    "expected_start": "",
    "reopen_count": "",
    "close_notes": "",
    "additional_assignee_list": "",
    "impact": "1",
    "urgency": "1",
    "correlation_id": "",
    "sys_tags": "",
    "sys_domain": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
      "value": "global"
    },
    "description": "",
    "group_list": "",
    "priority": "1",
    "delivery_plan": "",
    "sys_mod_count": "7",
    "work_notes_list": "",
    "business_service": "",
    "follow_up": "",
    "closed_at": "",
    "sla_due": "2017-07-05 05:58:24",
    "delivery_task": "",
    "sys_updated_on": "2016-01-22 14:12:37",
    "parent": "",
    "work_end": "",
    "number": "INC0000050",
    "closed_by": "",
    "work_start": "",
    "calendar_stc": "",
    "category": "hardware",
    "business_duration": "",
    "incident_state": "2",
    "activity_due": "2016-01-22 16:12:37",
    "correlation_display": "",
    "company": {
      "link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
      "value": "31bea3d53790200044e0bfc8bcbe5dec"
    },
    "active": "true",
    "due_date": "",
    "assignment_group": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
      "value": "8a5055c9c61122780043563ef53438e3"
    },
    "caller_id": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
      "value": "5b7c200d0a640069006b3845b5d0fa7c"
    },
    "knowledge": "false",
    "made_sla": "true",
    "comments_and_work_notes": "",
    "parent_incident": "",
    "state": "2",
    "user_input": "",
    "sys_created_on": "2015-11-02 18:05:40",
    "approval_set": "",
    "reassignment_count": "0",
    "rfc": "",
    "child_incidents": "",
    "opened_at": "2015-11-02 21:58:24",
    "short_description": "Can't access Exchange server - is it down?",
    "order": "",
    "sys_updated_by": "admin",
    "resolved_by": "",
    "notify": "1",
    "upon_reject": "cancel",
    "approval_history": "",
    "problem_id": "",
    "work_notes": "",
    "calendar_duration": "",
    "close_code": "",
    "sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
    "approval": "not requested",
    "caused_by": "",
    "severity": "3",
    "sys_created_by": "glide.maint",
    "resolved_at": "",
    "assigned_to": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
      "value": "681b365ec0a80164000fb0b05854a0cd"
    },
    "business_stc": "",
    "wf_activity": "",
    "sys_domain_path": "/",
    "cmdb_ci": {
      "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
      "value": "281190e3c0a8000b003f593aa3f20ca6"
    },
    "opened_by": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
      "value": "glide.maint"
    },
    "subcategory": "",
    "rejection_goto": "",
    "sys_class_name": "incident",
    "watch_list": "",
    "time_worked": "",
    "contact_type": "phone",
    "escalation": "3",
    "comments": ""
  }
}

Tabela - POST /now/table/{tableName}

Insere um registro na tabela especificada. A inserção de vários registros não é compatível com este método.

Formato da URL

URL com controle de versão: /api/now/{api_version}/table/{tableName}

URL padrão: /api/now/table/{tableName}

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

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
tableName	Nome da tabela na qual o registro será salvo. Tipo de dados: cadeia de caracteres

Search:

Tabela 26. Parâmetros de consulta
Nome	Descrição
sysparm_display_value	Determina o tipo de dados retornados, os valores reais do banco de dados ou os valores de exibição dos campos. Os valores de exibição são manipulados com base no valor real no banco de dados e nas configurações e preferências do usuário ou do sistema. Se estiver retornando valores de exibição, o valor retornado dependerá do tipo de campo. Campos de opção: o valor do banco de dados pode ser um número, mas o valor de exibição será mais descritivo. Campos de data: o valor do banco de dados está no formato UTC, enquanto o valor de exibição é baseado no fuso horário do usuário. Texto criptografado: o valor do banco de dados é criptografado, enquanto o valor exibido não é criptografado com base no contexto de criptografia do usuário. Campos de referência: o valor do banco de dados é sys_id, mas o valor de exibição é um campo de exibição do registro referenciado. Tipo de dados: cadeia de caracteres Valores válidos: verdadeiro: retorna os valores de exibição de todos os campos. falso: retorna os valores reais do banco de dados. all: retorna valores reais e de exibição. Padrão: falso Nota: Não há nenhum método preferencial para definir este parâmetro. No entanto, especificar o valor de exibição pode causar problemas de desempenho, já que ele não está lendo diretamente do banco de dados e pode incluir referência a outros campos e registros. Para obter mais informações sobre valores de exibição e valores reais, consulte Perguntas frequentes da API da tabela (KB0534905).
sysparm_exclude_reference_link	Sinalizador que indica se os links da API da tabela devem ser excluídos para campos de referência. Valores válidos: verdadeiro: excluir links de API de tabela para campos de referência. falso: incluir links de API de tabela para campos de referência. Tipo de dados: booliano Padrão: falso
sysparm_fields	Lista separada por vírgulas de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: cadeia de caracteres Padrão: retornar todos os campos.
sysparm_input_display_value	Sinalizador que indica se os valores de campos devem ser definidos usando o valor de exibição ou o valor real. Dependendo dos diferentes tipos de campos, o endpoint pode manipular os valores de exibição passados para armazenar os valores apropriados no banco de dados. Por exemplo, se você enviar o nome de exibição de um campo de referência, o endpoint armazenará o sys_id desse valor no banco de dados. Para campos de data e hora, quando este parâmetro é verdadeiro, o valor de data e hora é ajustado para o fuso horário do usuário atual. Quando falso, o valor de data e hora é inserido usando o fuso horário GMT. Valores válidos: verdadeiro: trata os valores de entrada como valores de exibição e eles são manipulados para que sejam armazenados corretamente no banco de dados. falso: trata os valores de entrada como valores reais e os armazena no banco de dados sem manipulação. Tipo de dados: booliano Padrão: falso - corresponde ao tipo de dados retornado durante a recuperação de dados (métodos GET), que são os valores reais. Nota: Para definir o valor de um campo criptografado, você deve definir este parâmetro como `verdadeiro`. Se este parâmetro não estiver definido como verdadeiro, os valores enviados para campos criptografados não serão salvos. Além disso, o usuário solicitante deve ter o contexto de criptografia apropriado antes de enviar a solicitação. Os campos criptografados ficam ocultos para usuários sem o contexto de criptografia apropriado. Para obter mais informações sobre criptografia de campo, consulte Criptografia.
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
pares de nome-valor	Nome do campo e o valor associado a cada parâmetro a ser definido no registro especificado. Nota: Nem todos os campos em um registro podem estar disponíveis para atualização. Por exemplo, os campos que têm um prefixo "sys_" são normalmente parâmetros do sistema que são gerados automaticamente e não podem ser atualizados. Os campos que não são especificados e não são gerados automaticamente pelo sistema são definidos com o valor nulo do tipo de dados associado.

Cabeçalhos

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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json
X-no-response-body	Por padrão, as respostas incluem o conteúdo do corpo que detalha o novo registro. Defina este cabeçalho como verdadeiro na solicitação para suprimir o corpo da resposta.

Tabela 29. Cabeçalhos de resposta
Cabeçalho	Descrição
Local	Local do recurso criado.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 30. Códigos de status
Código do status	Descrição
201	Indica que a solicitação foi concluída com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
404	Não encontrado. O item solicitado não foi encontrado.

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


Nome	Descrição
pares de nome-valor	Nomes de campo e valores de todos os parâmetros no registro recém-criado ou especificados nos parâmetros de consulta.

Exemplo: Solicitação de cURL

Insira um novo registro na tabela Incidente.

curl "https://instance.servicenow.com/api/now/table/incident" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'short_description':'Unable to connect to office wifi','assignment_group':'287ebd7da9fe198100f92cc8d1d2154e','urgency':'2','impact':'2'}" \
--user 'username':'password'

A resposta contém os pares de nome-valor do novo registro.

{
  "result": {
    "upon_approval": "proceed",
    "location": "",
    "expected_start": "",
    "reopen_count": "0",
    "close_notes": "",
    "additional_assignee_list": "",
    "impact": "2",
    "urgency": "2",
    "correlation_id": "",
    "sys_tags": "",
    "sys_domain": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
      "value": "global"
    },
    "description": "",
    "group_list": "",
    "priority": "3",
    "delivery_plan": "",
    "sys_mod_count": "0",
    "work_notes_list": "",
    "business_service": "",
    "follow_up": "",
    "closed_at": "",
    "sla_due": "",
    "delivery_task": "",
    "sys_updated_on": "2016-01-22 14:28:24",
    "parent": "",
    "work_end": "",
    "number": "INC0010002",
    "closed_by": "",
    "work_start": "",
    "calendar_stc": "",
    "category": "inquiry",
    "business_duration": "",
    "incident_state": "1",
    "activity_due": "",
    "correlation_display": "",
    "company": "",
    "active": "true",
    "due_date": "",
    "assignment_group": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e",
      "value": "287ebd7da9fe198100f92cc8d1d2154e"
    },
    "caller_id": "",
    "knowledge": "false",
    "made_sla": "true",
    "comments_and_work_notes": "",
    "parent_incident": "",
    "state": "1",
    "user_input": "",
    "sys_created_on": "2016-01-22 14:28:24",
    "approval_set": "",
    "reassignment_count": "0",
    "rfc": "",
    "child_incidents": "0",
    "opened_at": "2016-01-22 14:28:24",
    "short_description": "Unable to connect to office wifi",
    "order": "",
    "sys_updated_by": "admin",
    "resolved_by": "",
    "notify": "1",
    "upon_reject": "cancel",
    "approval_history": "",
    "problem_id": "",
    "work_notes": "",
    "calendar_duration": "",
    "close_code": "",
    "sys_id": "c537bae64f411200adf9f8e18110c76e",
    "approval": "not requested",
    "caused_by": "",
    "severity": "3",
    "sys_created_by": "admin",
    "resolved_at": "",
    "assigned_to": "",
    "business_stc": "",
    "wf_activity": "",
    "sys_domain_path": "/",
    "cmdb_ci": "",
    "opened_by": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441",
      "value": "6816f79cc0a8016401c5a33be04be441"
    },
    "subcategory": "",
    "rejection_goto": "",
    "sys_class_name": "incident",
    "watch_list": "",
    "time_worked": "",
    "contact_type": "phone",
    "escalation": "0",
    "comments": ""
  }
}

Tabela - PUT /now/table/{tableName}/{sys_id}

Atualiza o registro especificado com o corpo da solicitação.

Formato da URL

URL com controle de versão: /api/now/{api_version}/table/{tableName}/{sys_id}

URL padrão: /api/now/table/{tableName}/{sys_id}

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

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Identificador exclusivo do registro a ser atualizado. Tipo de dados: cadeia de caracteres
tableName	Nome da tabela na qual o registro está localizado. Tipo de dados: cadeia de caracteres

Search:

Tabela 32. Parâmetros de consulta
Nome	Descrição
sysparm_display_value	Determina o tipo de dados retornados, os valores reais do banco de dados ou os valores de exibição dos campos. Os valores de exibição são manipulados com base no valor real no banco de dados e nas configurações e preferências do usuário ou do sistema. Se estiver retornando valores de exibição, o valor retornado dependerá do tipo de campo. Campos de opção: o valor do banco de dados pode ser um número, mas o valor de exibição será mais descritivo. Campos de data: o valor do banco de dados está no formato UTC, enquanto o valor de exibição é baseado no fuso horário do usuário. Texto criptografado: o valor do banco de dados é criptografado, enquanto o valor exibido não é criptografado com base no contexto de criptografia do usuário. Campos de referência: o valor do banco de dados é sys_id, mas o valor de exibição é um campo de exibição do registro referenciado. Tipo de dados: cadeia de caracteres Valores válidos: verdadeiro: retorna os valores de exibição de todos os campos. falso: retorna os valores reais do banco de dados. all: retorna valores reais e de exibição. Padrão: falso Nota: Não há nenhum método preferencial para definir este parâmetro. No entanto, especificar o valor de exibição pode causar problemas de desempenho, já que ele não está lendo diretamente do banco de dados e pode incluir referência a outros campos e registros. Para obter mais informações sobre valores de exibição e valores reais, consulte Perguntas frequentes da API da tabela (KB0534905).
sysparm_exclude_reference_link	Sinalizador que indica se os links da API da tabela devem ser excluídos para campos de referência. Valores válidos: verdadeiro: excluir links de API de tabela para campos de referência. falso: incluir links de API de tabela para campos de referência. Tipo de dados: booliano Padrão: falso
sysparm_fields	Lista separada por vírgulas de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: cadeia de caracteres Padrão: retornar todos os campos.
sysparm_input_display_value	Sinalizador que indica se os valores de campos devem ser definidos usando o valor de exibição ou o valor real. Valores válidos: verdadeiro: trata os valores de entrada como valores de exibição e eles são manipulados para que possam ser armazenados corretamente no banco de dados. falso: trata os valores de entrada como valores reais e os armazena no banco de dados sem manipulação. Tipo de dados: booliano Padrão: falso Nota: Se este parâmetro estiver definido como verdadeiro, preste atenção aos valores de entrada, especialmente os valores de data, pois eles são interpretados como fornecidos por meio da preferência de fuso horário do usuário e são transformados no formato UTC. Para definir o valor de um campo criptografado, você deve definir este parâmetro como `verdadeiro`. Se este parâmetro não estiver definido como verdadeiro, os valores enviados para campos criptografados não serão salvos. Além disso, o usuário solicitante deve ter o contexto de criptografia apropriado antes de enviar a solicitação. Os campos criptografados ficam ocultos para usuários sem o contexto de criptografia apropriado. Para obter mais informações sobre valores de exibição e valores reais, consulte Perguntas frequentes da API da tabela (KB0534905). Para obter mais informações sobre criptografia de campo, consulte Criptografia de campo.
sysparm_query_no_domain	Sinalizador que indica se a pesquisa de registro deve ser restrita somente aos domínios para os quais o usuário conectado está configurado. Valores válidos: falso: exclua o registro se ele estiver em um domínio que o usuário conectado no momento não esteja configurado para acessar. verdadeiro: inclui o registro mesmo se ele estiver em um domínio que o usuário conectado no momento não está configurado para acessar. Tipo de dados: booliano Padrão: falso Nota: O parâmetro sysparm_query_no_domain está disponível somente para administradores do sistema ou usuários que tenham a função query_no_domain_table_api.
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
pares de nome-valor	Pares de nome-valor dos campos a serem atualizados na tabela associada. Por exemplo, para atualizar o arquivo de descrição resumida, insira um par de nome-valor semelhante ao seguinte: `--data "{"short_description": "my short desc" }" \`.

Cabeçalhos

Tabela 34. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.
X-no-response-body	Por padrão, as respostas incluem o conteúdo do corpo detalhando o registro modificado. Defina este cabeçalho como verdadeiro na solicitação para suprimir o corpo da resposta.

Tabela 35. Cabeçalhos de resposta
Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 36. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
404	Não encontrado. O item solicitado não foi encontrado.

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


Nome	Descrição
pares de nome-valor	Todos os campos (não apenas modificados) com seus valores associados para a solicitação de mudança.

Exemplo: Solicitação de cURL

Atualize um registro na tabela Incidente.

curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
--user 'username':'password'

A resposta contém os pares de nome-valor do registro atualizado.

{
  "result": {
    "upon_approval": "proceed",
    "location": {
      "link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
      "value": "108752c8c611227501d4ab0e392ba97f"
    },
    "expected_start": "",
    "reopen_count": "",
    "close_notes": "",
    "additional_assignee_list": "",
    "impact": "1",
    "urgency": "1",
    "correlation_id": "",
    "sys_tags": "",
    "sys_domain": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
      "value": "global"
    },
    "description": "",
    "group_list": "",
    "priority": "1",
    "delivery_plan": "",
    "sys_mod_count": "7",
    "work_notes_list": "",
    "business_service": "",
    "follow_up": "",
    "closed_at": "",
    "sla_due": "2017-07-05 05:58:24",
    "delivery_task": "",
    "sys_updated_on": "2016-01-22 14:12:37",
    "parent": "",
    "work_end": "",
    "number": "INC0000050",
    "closed_by": "",
    "work_start": "",
    "calendar_stc": "",
    "category": "hardware",
    "business_duration": "",
    "incident_state": "2",
    "activity_due": "2016-01-22 16:12:37",
    "correlation_display": "",
    "company": {
      "link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
      "value": "31bea3d53790200044e0bfc8bcbe5dec"
    },
    "active": "true",
    "due_date": "",
    "assignment_group": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
      "value": "8a5055c9c61122780043563ef53438e3"
    },
    "caller_id": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
      "value": "5b7c200d0a640069006b3845b5d0fa7c"
    },
    "knowledge": "false",
    "made_sla": "true",
    "comments_and_work_notes": "",
    "parent_incident": "",
    "state": "2",
    "user_input": "",
    "sys_created_on": "2015-11-02 18:05:40",
    "approval_set": "",
    "reassignment_count": "0",
    "rfc": "",
    "child_incidents": "",
    "opened_at": "2015-11-02 21:58:24",
    "short_description": "Can't access Exchange server - is it down?",
    "order": "",
    "sys_updated_by": "admin",
    "resolved_by": "",
    "notify": "1",
    "upon_reject": "cancel",
    "approval_history": "",
    "problem_id": "",
    "work_notes": "",
    "calendar_duration": "",
    "close_code": "",
    "sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
    "approval": "not requested",
    "caused_by": "",
    "severity": "3",
    "sys_created_by": "glide.maint",
    "resolved_at": "",
    "assigned_to": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
      "value": "681b365ec0a80164000fb0b05854a0cd"
    },
    "business_stc": "",
    "wf_activity": "",
    "sys_domain_path": "/",
    "cmdb_ci": {
      "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
      "value": "281190e3c0a8000b003f593aa3f20ca6"
    },
    "opened_by": {
      "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
      "value": "glide.maint"
    },
    "subcategory": "",
    "rejection_goto": "",
    "sys_class_name": "incident",
    "watch_list": "",
    "time_worked": "",
    "contact_type": "phone",
    "escalation": "3",
    "comments": ""
  }
}

Nesta página

Tabela - DELETE /now/table/{tableName}/{sys_id}
Tabela - GET /now/table/{tableName}
Tabela - GET /now/table/{tableName}/{sys_id}
Tabela - PATCH /now/table/{tableName}/{sys_id}
Tabela - POST /now/table/{tableName}
Tabela - PUT /now/table/{tableName}/{sys_id}

Esse tópico foi útil?

Sim Não

Sistema para API de gestão de identidade entre domínios (SCIM)

API aberta de qualificação de serviço técnico

Sistema para API de gestão de identidade entre domínios (SCIM)

API aberta de qualificação de serviço técnico

Log in to get a better experience

Fazer login

Referência de API do Yokohama

Filters

Versions

Produtos

API da tabela

Tabela - DELETE /now/table/{tableName}/{sys_id}

Formato da URL

Parâmetros de solicitação compatíveis

Cabeçalhos

Códigos de status

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

Exemplo: Solicitação de cURL

Tabela - GET /now/table/{tableName}

Formato da URL

Parâmetros de solicitação compatíveis

Cabeçalhos

Códigos de status

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

Exemplo: Solicitação de cURL

Tabela - GET /now/table/{tableName}/{sys_id}

Formato da URL

Parâmetros de solicitação compatíveis

Cabeçalhos

Códigos de status

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

Exemplo: Solicitação de cURL

Tabela - PATCH /now/table/{tableName}/{sys_id}

Formato da URL

Parâmetros de solicitação compatíveis

Cabeçalhos

Códigos de status

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

Exemplo: Solicitação de cURL

Tabela - POST /now/table/{tableName}

Formato da URL

Parâmetros de solicitação compatíveis

Cabeçalhos

Códigos de status

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

Exemplo: Solicitação de cURL

Tabela - PUT /now/table/{tableName}/{sys_id}

Formato da URL

Parâmetros de solicitação compatíveis

Cabeçalhos

Códigos de status

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

Exemplo: Solicitação de cURL

Nesta página

Log in to get a better experience