API do consumidor
A API Consumer fornece endpoints para recuperar e atualizar Customer Service Management (CSM) registros de consumidor.
Além disso, você pode gerar novos registros de perfil de mídia social ao criar um consumidor.
A API do consumidor 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.
Consumidor - GET /now/consumer
Recupera um conjunto especificado de Customer Service Management (CSM) registros de consumidor.
Formato da URL
URL com controle de versão: /api/now/{api_version}/consumer
URL padrão: /api/now/consumer
Parâmetros de solicitação compatíveis
| 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 |
| 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 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:
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, 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 |
| 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.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| 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.
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 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)
O endpoint pode retornar os seguintes elementos JSON ou XML no corpo da resposta. Além da lista de elementos definida abaixo (que define os elementos em um sistema de base), o endpoint também retorna todos os campos personalizados adicionados à tabela Consumidor [csm_consumer]. Para obter informações adicionais sobre esses elementos, consulte a definição de tabela específica [].
| Elemento | Descrição |
|---|---|
| ativo | Sinalizador que indica se o consumidor está ativo. Valores possíveis:
Tipo de dados: booliano Padrão: verdadeiro |
| business_phone | Número de telefone comercial do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| cidade | Cidade em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| país | País em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| formato_data | Formato no qual as datas serão exibidas. Valores válidos:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de data do sistema) |
| Endereço de e-mail do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
|
| fax | Número de fax do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| first_name | Nome do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| gênero | Gênero do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| home_phone | Número de telefone residencial do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| residência | Sys_id do registro que descreve as características da residência. Tipo de dados: cadeia de caracteres Tabela: Residência [csm_household] |
| last_name | Sobrenome do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| middle_name | Nome do meio do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| mobile_phone | Número de telefone celular do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| nome | Nome completo do consumidor; first_name+middle_name+last_name. Tipo de dados: cadeia de caracteres Tamanho máximo: 152 |
| anotações | Anotações sobre o consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| notificação | Indica se o consumidor deve receber notificações. Valores válidos:
Tipo de dados: número (inteiro) Tamanho máximo: 40 Padrão: 2 |
| número | Número exclusivo associado ao consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| foto | Foto do consumidor. Tipo de dados: imagem |
| preferred_language | Idioma primário do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 3 |
| prefixo | Prefixo do nome do consumidor, como Dr., Sr., Sra. ou Srta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| primary | Sinalizador que indica se este é o consumidor primário. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| estado | Estado em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| rua | Endereço do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 |
| sufixo | Sufixo do nome do consumidor, como jr., sênior ou II. Tipo de dados: cadeia de caracteres |
| sys_created_by | Usuário que criou o registro do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_created_on | Data e hora em que o registro do consumidor foi criado originalmente. Tipo de dados: cadeia de caracteres |
| sys_domain | ServiceNow domínio no qual as informações do consumidor residem. Tipo de dados: cadeia de caracteres |
| sys_id | Identificador exclusivo do consumidor. Tipo de dados: cadeia de caracteres |
| sys_mod_count | Número de vezes em que as informações do consumidor associadas foram modificadas. Tipo de dados: número (inteiro) |
| sys_tags | Marcadores do sistema. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Usuário que atualizou as informações do consumidor pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_updated_on | Data e hora em que as informações do consumidor foram atualizadas pela última vez. Tipo de dados: cadeia de caracteres |
| formato_hora | Formato no qual a hora será exibida. Valores válidos:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de hora do sistema) |
| time_zone | Fuso horário do consumidor, como Canadá/Central ou EUA/Leste. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| título | Título comercial do consumidor, como Gerente, Desenvolvedor de software ou Prestador de serviços. Tipo de dados: cadeia de caracteres Tamanho máximo: 60 |
| usuário | Sys_id do usuário consumidor. Tipo de dados: cadeia de caracteres Tabela: usuário consumidor [csm_consumer_user] |
| zip | CEP do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
Solicitação de cURL
curl "https://instance.servicenow.com/api/now/consumer?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
"result": [
{
"country": "USA",
"notes": "",
"gender": "Male",
"city": "Plano",
"prefix": "",
"sys_updated_on": "2016-08-12 00:19:12",
"suffix": "",
"title": "",
"number": "CSMR0000004",
"notification": "2",
"sys_id": "01d8403fdb1b1200b6075200cf961941",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "6900 Dallas Pkwy",
"sys_created_on": "2016-06-16 19:20:13",
"sys_domain": "global",
"state": "TX",
"fax": "",
"first_name": "Harding",
"email": "harding.asher@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "75024",
"home_phone": "",
"time_format": "",
"sys_mod_count": "8",
"last_name": "Asher",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Harding Asher",
"household": "",
"date_format": "",
"user": "c3d35d82c37122005871d44d81d3ae91",
"primary": "false"
},
{
"country": "USA",
"notes": "",
"gender": "Male",
"city": "San Francisco",
"prefix": "",
"sys_updated_on": "2016-08-12 00:20:27",
"suffix": "",
"title": "",
"number": "CSMR0000002",
"notification": "2",
"sys_id": "a0488cfbdb1b1200b6075200cf9619db",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "144 2nd St",
"sys_created_on": "2016-06-16 19:17:44",
"sys_domain": "global",
"state": "CA",
"fax": "",
"first_name": "Sam",
"email": "sam.collins@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "94105",
"home_phone": "",
"time_format": "",
"sys_mod_count": "13",
"last_name": "Collins",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Sam Collins",
"household": "",
"date_format": "",
"user": "64488cfbdb1b1200b6075200cf9619db",
"primary": "false"
}
]
}
Consumidor - GET /now/consumer/{id}
Recupera o Customer Service Management (CSM) registro de consumidor especificado.
Formato da URL
URL com controle de versão: /api/now/{api_version}/consumer/{id}
URL padrão: /api/now/consumer/{id}
Parâmetros de solicitação compatíveis
| 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 |
| id | Sys_id do registro do consumidor a ser retornado. Tipo de dados: cadeia de caracteres Tabela: consumidor [csm_consumer] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| 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.
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Indica que a solicitação é inválida. Pode ser devido a um dos seguintes motivos:
|
| 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)
O endpoint pode retornar os seguintes elementos JSON ou XML no corpo da resposta. Além da lista de elementos definida abaixo (que define os elementos em um sistema de base), o endpoint também retorna todos os campos personalizados adicionados à tabela Consumidor [csm_consumer]. Para obter informações adicionais sobre esses elementos, consulte a definição de tabela específica [].
| Elemento | Descrição |
|---|---|
| ativo | Sinalizador que indica se o consumidor está ativo. Valores possíveis:
Tipo de dados: booliano Padrão: verdadeiro |
| business_phone | Número de telefone comercial do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| cidade | Cidade em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| país | País em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| formato_data | Formato no qual as datas serão exibidas. Valores válidos:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de data do sistema) |
| Endereço de e-mail do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
|
| fax | Número de fax do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| first_name | Nome do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| gênero | Gênero do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| home_phone | Número de telefone residencial do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| residência | Sys_id do registro que descreve as características da residência. Tipo de dados: cadeia de caracteres Tabela: Residência [csm_household] |
| last_name | Sobrenome do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| middle_name | Nome do meio do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| mobile_phone | Número de telefone celular do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| nome | Nome completo do consumidor; first_name+middle_name+last_name. Tipo de dados: cadeia de caracteres Tamanho máximo: 152 |
| anotações | Anotações sobre o consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| notificação | Indica se o consumidor deve receber notificações. Valores válidos:
Tipo de dados: número (inteiro) Tamanho máximo: 40 Padrão: 2 |
| número | Número exclusivo associado ao consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| foto | Foto do consumidor. Tipo de dados: imagem |
| preferred_language | Idioma primário do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 3 |
| prefixo | Prefixo do nome do consumidor, como Dr., Sr., Sra. ou Srta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| primary | Sinalizador que indica se este é o consumidor primário. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| estado | Estado em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| rua | Endereço do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 |
| sufixo | Sufixo do nome do consumidor, como jr., sênior ou II. Tipo de dados: cadeia de caracteres |
| sys_created_by | Usuário que criou o registro do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_created_on | Data e hora em que o registro do consumidor foi criado originalmente. Tipo de dados: cadeia de caracteres |
| sys_domain | ServiceNow domínio no qual as informações do consumidor residem. Tipo de dados: cadeia de caracteres |
| sys_id | Identificador exclusivo do consumidor. Tipo de dados: cadeia de caracteres |
| sys_mod_count | Número de vezes em que as informações do consumidor associadas foram modificadas. Tipo de dados: número (inteiro) |
| sys_updated_by | Usuário que atualizou as informações do consumidor pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_updated_on | Data e hora em que as informações do consumidor foram atualizadas pela última vez. Tipo de dados: cadeia de caracteres |
| formato_hora | Formato no qual a hora será exibida. Valores válidos:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de hora do sistema) |
| time_zone | Fuso horário do consumidor, como Canadá/Central ou EUA/Leste. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| título | Título comercial do consumidor, como Gerente, Desenvolvedor de software ou Prestador de serviços. Tipo de dados: cadeia de caracteres Tamanho máximo: 60 |
| usuário | Sys_id do usuário consumidor. Tipo de dados: cadeia de caracteres Tabela: usuário consumidor [csm_consumer_user] |
| zip | CEP do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
Solicitação de cURL
curl "https://instance.servicenow.com/api/now/consumer/01d8403fdb1b1200b6075200cf961941 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"country": "USA",
"notes": "",
"gender": "Male",
"city": "Plano",
"prefix": "",
"sys_updated_on": "2016-08-12 00:19:12",
"suffix": "",
"title": "",
"number": "CSMR0000004",
"notification": "2",
"sys_id": "01d8403fdb1b1200b6075200cf961941",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "6900 Dallas Pkwy",
"sys_created_on": "2016-06-16 19:20:13",
"sys_domain": "global",
"state": "TX",
"fax": "",
"first_name": "Harding",
"email": "harding.asher@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "75024",
"home_phone": "",
"time_format": "",
"sys_mod_count": "8",
"last_name": "Asher",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Harding Asher",
"household": "",
"date_format": "",
"user": "c3d35d82c37122005871d44d81d3ae91",
"primary": "false"
}
}
Consumidor - POST /now/consumer
Cria um novo consumidor Customer Service Management (CSM).
- social_channel
- social_handle
- social_handle_url
Formato da URL
URL com controle de versão: /api/now/{api_version}/consumer
URL padrão: /api/now/consumer
Parâmetros de solicitação compatíveis
| 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Elemento | Descrição |
|---|---|
| ativo | Sinalizador que indica se o consumidor está ativo. Valores possíveis:
Tipo de dados: booliano Padrão: verdadeiro |
| business_phone | Número de telefone comercial do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| cidade | Cidade em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| país | País em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| formato_data | Formato no qual as datas serão exibidas. Valores válidos:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de data do sistema) |
| Endereço de e-mail do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
|
| fax | Número de fax do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| first_name | Nome do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| gênero | Gênero do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| home_phone | Número de telefone residencial do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| residência | Sys_id do registro que descreve as características da residência. Tipo de dados: cadeia de caracteres Tabela: Residência [csm_household] |
| last_name | Sobrenome do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| middle_name | Nome do meio do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 50 |
| mobile_phone | Número de telefone celular do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| nome | Nome completo do consumidor; first_name+middle_name+last_name. Tipo de dados: cadeia de caracteres Tamanho máximo: 152 |
| anotações | Anotações sobre o consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| notificação | Indica se o consumidor deve receber notificações. Valores válidos:
Tipo de dados: número (inteiro) Tamanho máximo: 40 Padrão: 2 |
| foto | Foto do consumidor. Tipo de dados: imagem |
| preferred_language | Idioma primário do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 3 |
| prefixo | Prefixo do nome do consumidor, como Dr., Sr., Sra. ou Srta. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| primary | Sinalizador que indica se este é o consumidor primário. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| canal_social | Canal de mídia social ao qual o consumidor está associado, como Twitter, Facebook ou Instagram. Tipo de dados: cadeia de caracteres |
| social_handle | Identificador de usuário no canal de mídia social. Tipo de dados: cadeia de caracteres |
| social_handle_URL | URL para o identificador do canal social do consumidor. Tipo de dados: cadeia de caracteres |
| estado | Estado em que o consumidor reside. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| rua | Endereço do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 |
| sufixo | Sufixo do nome do consumidor, como jr., sênior ou II. Tipo de dados: cadeia de caracteres |
| formato_hora | Formato no qual a hora será exibida. Valores válidos:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: em branco (formato de hora do sistema) |
| time_zone | Fuso horário do consumidor, como Canadá/Central ou EUA/Leste. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| título | Título comercial do consumidor, como Gerente, Desenvolvedor de software ou Prestador de serviços. Tipo de dados: cadeia de caracteres Tamanho máximo: 60 |
| usuário | Sys_id do usuário consumidor. Tipo de dados: cadeia de caracteres Tabela: usuário consumidor [csm_consumer_user] |
| zip | CEP do consumidor. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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.
| Código do status | Descrição |
|---|---|
| 201 | O novo registro de consumidor foi criado com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 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 de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Elemento | Descrição |
|---|---|
| resultado | Sys_id do registro do consumidor recém-criado. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl -X POST "https://instance.servicenow.com/api/now/consumer" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d " { \
"country": "USA", \
"notes": "Never comes in before 10am", \
"gender": "Female", \
"city": "San Marcos", \
"prefix": "Ms", \
"title": "Director", \
"notification": "1", \
"business_phone": "(555)555-1234", \
"mobile_phone": "(555)555-1235", \
"street": "123 Sesame St", \
"state": "CA", \
"fax": "(555)555-1236", \
"first_name": "Jane", \
"zip": "92001", \
"home_phone": "(555)555-1234", \
"last_name": "Brown", \
"active": "true", \
"middle_name": "Dell", \
"time_zone": "PST", \
"name": "Jane Brown", \
"household": "4", \
"user": "c3d35d82c37122005871d44d81d3ae91", \
"primary": "false" \
}"
--user "username":"password"{
"result": "0f5c13addb93230057c3fd441d9619b8"
}