API de conta

Referência de API do Yokohama

Release

yokohama

ft:locale

pt-BR

ft:publication_title

Referência de API do Yokohama

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API de conta

Versão de lançamento: Yokohama

Atualizado 30 de jan. de 2025

14 min. de leitura

A API de conta fornece endpoints para recuperar Customer Service Management (CSM) registros de conta.

Esta API requer o plug-in Atendimento ao cliente (com.sn_customerservice) e é fornecida no namespace now.

Os usuários precisam da função csm_ws_integration para acesso total à API.

Conta - GET /now/account

Recupera um conjunto especificado de Customer Service Management (CSM) contas.

Formato da URL

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

URL padrão: /api/now/account

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

Tabela 2. 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. Na resposta, o parâmetro booliano hasMore é retornado. Indica se há mais registros a serem retornados que atendam aos critérios de filtro. Tipo de dados: número Padrão: 10
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. Por exemplo: `sysparm_query=caller_id=javascript:gs.getUserID()^active=true` A consulta codificada oferece suporte à ordem por. Para classificar respostas com base em determinados campos, use as cláusulas ORDERBY e ORDERBYDESC em sysparm_query. Por exemplo, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` filtra todos os registros ativos e ordena os resultados em ordem crescente por número primeiro 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

Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
Elemento	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
200	Bem-sucedido. A solicitação foi processada com sucesso.
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)


Parâmetro	Descrição
account_code	Combinação exclusiva de valores que uma aplicação usa para identificar previsões orçamentárias e planos orçamentários. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
account_parent	Sys_id da conta primária desta conta. Localizado na tabela Conta [customer_account]. Tipo de dados: cadeia de caracteres
account_path	Caminho das contas primárias para as secundárias na hierarquia de contas. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
escalação_ativa	Sys_id da escalação ativa associada à conta. Tipo de dados: cadeia de caracteres Tabela: escalação [sn_customerservice_escalation]
apple_icon	Ícone para marcadores de página inicial do iPhone. Tipo de dados: imagem
banner_image	Imagem da faixa que aparece no portal do cliente. Tipo de dados: imagem
banner_image_light	Imagem de faixa pequena. Tipo de dados: imagem
banner_text	Texto da faixa que aparece no portal do cliente. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000
cidade	Cidade na qual reside a empresa associada a esta conta. Tipo de dados: cadeia de caracteres Tamanho máximo: 50
contato	Sys_id de um registro de contato associado a esta conta. Tipo de dados: cadeia de caracteres Tabela: usuário [sys_user]
país	País em que reside a empresa associada a esta conta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: EUA
cliente	Sinalizador que indica se a conta é uma conta de cliente, em vez de uma conta de parceiro. Valores possíveis: verdadeiro: conta do cliente falso: conta do parceiro Tipo de dados: booliano Padrão: falso
desconto	Desconto concedido à conta em compras. Tipo de dados: número Tamanho máximo: 15
fax_telefone	Número de fax primário da empresa associada a esta conta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
fiscal_year	Ano fiscal da empresa associada à conta. Tipo de dados: cadeia de caracteres
erro_lat_longo	Diferença na localização real em comparação com as informações de latitude e longitude. Tipo de dados: cadeia de caracteres Tamanho máximo: 1.000
latitude	Latitude da empresa associada a esta conta. Tipo de dados: número (número de ponto flutuante) Tamanho máximo: 40
longitude	Longitude da empresa associada a esta conta. Tipo de dados: número (número de ponto flutuante) Tamanho máximo: 40
manufacturer	Sinalizador que indica se a empresa associada a esta conta produz mercadorias. Valores possíveis: verdadeiro: bens de fabricação falso: não produz mercadorias Tipo de dados: booliano Padrão: falso
valor_de_mercado	Valor de mercado das ações negociadas publicamente da empresa associada. Tipo de dados: número (moeda) Tamanho máximo: 20
nome	Nome da empresa associada a esta conta. Tipo de dados: cadeia de caracteres Tamanho máximo: 80
anotações	Informações adicionais sobre a empresa. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000
núm_funcionários	Número de pessoas empregadas pela empresa. Tipo de dados: número (inteiro) Tamanho máximo: 40
número	Número que identifica esta conta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
primário	Sys_id da conta primária desta conta. Tipo de dados: cadeia de caracteres Tabela: Empresa [core_company]
parceiro	Sinalizador que indica se a conta é de parceiro ou de cliente. Valores possíveis: verdadeiro: conta do parceiro falso: conta do cliente Tipo de dados: booliano Padrão: falso
telefone	Número de telefone primário da empresa. Tipo de dados: cadeia de caracteres
primary	Sinalizador que indica se esta é uma conta primária. Valores possíveis: verdadeiro: conta primária falso: conta secundária Tipo de dados: booliano Padrão: falso
primário_contato	Sys_id do contato primário da conta. Tipo de dados: cadeia de caracteres Tabela: Contato [customer_contact]
lucros	Informações de lucro inseridas para esta conta. Tipo de dados: número (moeda) Tamanho máximo: 40
Public_traded	Sinalizador que indica se a empresa associada a esta conta é negociada publicamente na bolsa de valores. Valores possíveis: verdadeiro: negociado publicamente falso: empresa privada Tipo de dados: booliano
classificação_nível	Tipo de conta. Valores possíveis: lista de bloqueios outro estratégico tático valorizado Tipo de dados: cadeia de caracteres Tamanho máximo: 40
registro_código	Código exclusivo que os clientes usam ao solicitar um login no portal do cliente. Este código fornece um método para validar o cliente na empresa antes de conceder acesso. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
receita_por_ano	Receita produzida pela empresa associada a esta conta. Tipo de dados: número (moeda) Tamanho máximo: 20
estado	Estado em que a empresa reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
preço_estoque	Preço da ação da empresa. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
símbolo_estoque	Símbolo de ações da empresa. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
rua	Endereço da empresa. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
sys_class_name	Tabela que contém o registro de conta associado. Tipo de dados: cadeia de caracteres
sys_created_by	Usuário que criou originalmente a conta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
sys_created_on	Data e hora em que a conta foi criada originalmente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro da conta. Tipo de dados: cadeia de caracteres
sys_mod_count	Número de vezes que as informações da conta foram atualizadas. Tipo de dados: número (inteiro)
sys_updated_by	Usuário que modificou pela última vez as informações da conta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
sys_updated_on	Data e hora em que as informações da conta foram atualizadas pela última vez. Tipo de dados: cadeia de caracteres
tema	Sys_id do tema do portal do cliente usado por esta conta. Tipo de dados: cadeia de caracteres Tabela: tema [sys_ui_theme]
fornecedor	Sinalizador que indica se a empresa associada a esta conta é um fornecedor. Valores possíveis: verdadeiro: fornecedor falso: não é um fornecedor Tipo de dados: booliano Padrão: falso
vendor_manager	Lista de sys_ids dos gerentes de fornecedor da conta. Tipo de dados: cadeia de caracteres Tabela: usuário [sys_user]
vendor_type	Lista de sys_ids do tipo de fornecedor, como aplicações, hardware, serviços ou software. Tipo de dados: cadeia de caracteres Tabela: tipo de fornecedor [vendor_type]
site	URL do site da empresa. Tipo de dados: cadeia de caracteres Tamanho máximo: 1.024
zip	CEP da empresa. Tipo de dados: cadeia de caracteres Tamanho máximo: 40

Solicitação de cURL

curl "https://instance.servicenow.com/api/now/account?sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
"result": [
  {
   "banner_image_light": "",
   "country": "USA",
   "parent": "",
   "notes": "",
   "stock_symbol": "",
   "discount": "",
   "active_escalation": "",
   "sys_updated_on": "2019-01-03 19:37:55",
   "apple_icon": "",
   "number": "ACCT0000003",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:25:17",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "BR1 3QR",
    "profits": "0",
    "phone": "+44 20 8466 9992",
    "fax_phone": "",
    "name": "Boxeo EMEA",
    "banner_text": "",
    "account_code": "~~~~3",
    "primary": "false",
    "city": "Bromley",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "3eedd08413651200042ab3173244b088",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "18 London Rd",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-EMEA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~3",
    "primary_contact": "ff66c1254fb81200025ba3618110c76e",
    "customer": "true"
  },
  {
    "banner_image_light": "",
    "country": "USA",
    "parent": "",
    "notes": "",
    "stock_symbol": "",
    "discount": "",
    "active_escalation": "",
    "sys_updated_on": "2019-01-03 19:38:04",
    "apple_icon": "",
    "number": "ACCT0000004",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:19:24",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "V5L 2G4",
    "profits": "0",
    "phone": "+1 604-255-9797",
    "fax_phone": "",
    "name": "Boxeo Canada",
    "banner_text": "",
    "account_code": "~~~~4",
    "primary": "false",
    "city": "Vancouver",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "609cd80413651200042ab3173244b03e",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "1362 Venables St,, BC V5L 2G4, Canada",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-CANADA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~4",
    "primary_contact": "c07424a54f781200025ba3618110c746",
    "customer": "true"
  }
 ]
}

Conta - GET /now/account/{id}

Recupera a conta Customer Service Management (CSM) especificada.