Abrir API de tíquete de problemas

. Tíquete de problemas aberto A API fornece endpoints para criar, atualizar e recuperar dados das tabelas Caso [sn_customerservice_case] e Incidente [incident].

Use esta API para gerenciar informações de tíquete entre sistemas de tíquete externos e o. ServiceNow AI Platform.

Esta API está incluída no Fluxos de trabalho de garantia de telecomunicações , que está disponível no ServiceNow Store. . Atendimento ao cliente(com.sn_customerservice) e Customer Service Install Base Management (com.snc.install_base) são necessárias para usar esta API com a tabela case [sn_customerservice_case].

Esta API é fornecida no sn_ind_tsm_sdwan namespace.

O usuário chamador deve ter a função ticket_integrator.

Esta API pode ser estendida para fazer personalizações em relação aos parâmetros necessários, solicitar validação de corpo, operações REST adicionais e mapeamentos de campo. Para obter mais informações, consulte. Guia do desenvolvedor de API de abertura de tíquete de problemas .

. Tíquete de problemas aberto A API é um ServiceNow® Implementação da especificação REST da API Gestão de tíquetes de problemas do Fórum TM. Esta implementação é baseada no TMF621 Trouble tíquete Management API REST Specification versão 19 Junho de 2019. . Tíquete de problemas aberto A API tem certificação de conformidade pelo TM Forum.

Tíquete de problema - OBTENHA /sn_ind_tsm_sdwan/tíquete/troubleTíquete  

Recupera uma lista de todos os registros de tíquete de problema das tabelas Caso [sn_customerservice_case] e Incidente [incident].

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/tíquete/troubletíquete

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 2. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: canal creationDate descrição href id LastUpdate nome nota RelatedEntity RelatedParty severidade status ticketType . Padrão: Retorna todos os campos. Tipo de dados: Cadeia de caracteres
id	Filtrar tíquetes de problemas por sys_id. Somente tíquetes com o sys_id especificado são retornados na resposta. Tipo de dados: Cadeia de caracteres
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Padrão: 25 Máximo: 100 Você pode mudar os valores padrão e máximo atualizando o. sn_ind_tsm_sdwan.pagination.set_limite. sn_ind_tsm_sdwan.pagination.max_limitpropriedades do sistema. Tipo de dados: Número
deslocamento	Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0
severidade	Filtrar tíquetes de problemas por severidade. Somente tíquetes com a severidade especificada são retornados na resposta. Tipo de dados: Cadeia de caracteres
status	Filtrar tíquetes de problemas por status. Somente tíquetes com o status especificado são retornados na resposta. Tipo de dados: Cadeia de caracteres
ticketType	Filtrar tíquetes de problema por tipo de tíquete. Somente tíquetes do tipo especificado são retornados na resposta. Valores válidos: Caso incidente Tipo de dados: Cadeia de caracteres

Tabela 3. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se deslocamento: 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Count	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

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

Tabela 6. Códigos de status

Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na resposta (com paginação).
400	Solicitação incorreta. Possíveis motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	O nome do método de contato. Mapeia para Canal campo [contact_type] para casos e Tipo de contato campo [contact_type] para incidentes. Tipo de dados: Cadeia de caracteres
creationDate	A data em que o registro do caso ou incidente foi criado. Mapeia para Criado campo. Tipo de dados: Cadeia de caracteres
descrição	A descrição do problema do tíquete. Mapeia para Descrição campo. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
id	O sys_id do registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
LastUpdate	A data em que o registro foi atualizado pela última vez. Mapeia para Atualizado campo. Tipo de dados: Cadeia de caracteres
nome	O nome do tíquete de problema, normalmente uma descrição resumida do problema. Mapeia para Descrição resumida campo. Tipo de dados: Cadeia de caracteres
nota	Uma lista de todos os comentários no tíquete. Esta lista não inclui anotações de trabalho. Tipo de dados: Matriz "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
tipo. em	O tipo de anotação. Somente comentários são retornados (não anotações de trabalho), portanto, este valor é sempre comentários . Tipo de dados: Cadeia de caracteres
note.author	O nome do ServiceNow Usuário de integração que fez a solicitação POST ou PATCH que criou o comentário. Tipo de dados: Cadeia de caracteres
note.date	A data em que o comentário foi criado em ServiceNow instância. Tipo de dados: Cadeia de caracteres
note.text	O texto do comentário. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
RelatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
RelatedEntity.href	Retorna uma cadeia de caracteres vazia. Tipo de dados: Cadeia de caracteres
relatedEntity.name	Nome do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
RelatedEntity.role	Descrição do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedEntity. Em tipo	Este valor é sempre RelatedEntity . Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
IdentidadeRelatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das seguintes tabelas, dependendo do tipo de tíquete e do tipo de parte relacionada. Caso: Conta [customer_account]; o tipo de parte relacionada é cliente Contato [customer_contact]; o tipo de parte relacionada é customer_contact Incidente: Empresa [core_company]; o tipo de parte relacionada é cliente Usuário [sys_user]; o tipo de parte relacionada é customer_contact Caso ou incidente: Grupo [sys_user_group]; o tipo de parte relacionada é assignment_group Usuário [sys_user]; o tipo de parte relacionada é assigned_to Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: assigned_to Usuário atribuído para trabalhar no tíquete. assignment_group Grupo atribuído para trabalhar no tíquete. cliente : Empresa ou conta do tíquete. customer_contact Solicitante ou contato para o tíquete. Tipo de dados: Cadeia de caracteres
severidade	A gravidade do problema descrito pelo tíquete de problema. Mapeia para Prioridade campo. Tipo de dados: Cadeia de caracteres
status	O status atual do tíquete de problemas. Mapeia para Estado campo. Tipo de dados: Cadeia de caracteres
ticketType	O tipo de tíquete. Valores possíveis: Caso incidente Tipo de dados: Cadeia de caracteres
.	Este valor é sempre Tíquete de problemas . Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo retorna campos especificados para os primeiros cinco registros de caso de tíquete de problemas.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket?limit=5&fields=id%2Cname%2Cdescription%2Cstatus%2Cseverity%2CticketType&ticketType=case" \
--request GET \
--user 'username':'password'

Corpo da resposta.

[
   {
      "id": "0004609eb9830110f877b3758cd21d37",
      "name": "Compliant Over 2796",
      "description": "checkNo2796",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "000560d2b9c30110f877b3758cd21d36",
      "name": "Compliant Over 4696",
      "description": "checkNo4696",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d34",
      "name": "Compliant Over 8817",
      "description": "checkNo8817",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d39",
      "name": "Compliant Over 8819",
      "description": "checkNo8819",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d3e",
      "name": "Compliant Over 8821",
      "description": "checkNo8821",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   }
]

Tíquete de problema - OBTER /sn_ind_tsm_sdwan/tíquete/troubleTíquete/

Recupera um registro especificado da tabela Caso [sn_customerservice_case] ou Incidente [incident].

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
id	Sys_id do registro de caso ou incidente a ser recuperado. Tipo de dados: Cadeia de caracteres Tabela: Caso [sn_customerservice_case] ou Incidente [incident]

Tabela 8. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Valores válidos: canal creationDate descrição href id LastUpdate nome nota RelatedEntity RelatedParty severidade status ticketType . Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos.

Tabela 9. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 10. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 12. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir. Parâmetro de caminho inválido. URI inválido.
404	Registro não encontrado. Um registro associado ao ID não foi encontrado na tabela Caso [sn_customerservice_case] ou Incidente [incident].

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Mapeia para o campo Canal [contact_type] para casos e o campo Tipo de contato [contact_type] para incidentes. Tipo de dados: Cadeia de caracteres
creationDate	Data em que o registro de caso ou incidente foi criado. Mapeia para o campo criado. Tipo de dados: Cadeia de caracteres
descrição	Descrição do problema do tíquete. Mapeia para o campo Descrição. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
LastUpdate	Data em que o registro foi atualizado pela última vez. Mapeia para o campo Atualizado. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Mapeia para o campo Descrição resumida. Tipo de dados: Cadeia de caracteres
nota	Lista de todos os comentários no tíquete. Esta lista não inclui anotações de trabalho. Tipo de dados: Matriz de objetos "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Somente comentários são retornados (não anotações de trabalho), portanto, este valor é sempre comentários . Tipo de dados: Cadeia de caracteres
note.author	Nome do usuário que escreveu o comentário. Tipo de dados: Cadeia de caracteres
note.date	Data em que o comentário foi criado em ServiceNow instância. Tipo de dados: Cadeia de caracteres
note.text	Texto do comentário. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
RelatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
RelatedEntity.href	Retorna uma cadeia de caracteres vazia. Tipo de dados: Cadeia de caracteres
relatedEntity.name	Nome do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
RelatedEntity.role	Descrição do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedEntity. Em tipo	Este valor é sempre RelatedEntity . Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
IdentidadeRelatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das seguintes tabelas, dependendo do tipo de tíquete e do tipo de parte relacionada. Caso: Conta [customer_account]; o tipo de parte relacionada é cliente Contato [customer_contact]; o tipo de parte relacionada é customer_contact Incidente: Empresa [core_company]; o tipo de parte relacionada é cliente Usuário [sys_user]; o tipo de parte relacionada é customer_contact Caso ou incidente: Grupo [sys_user_group]; o tipo de parte relacionada é assignment_group Usuário [sys_user]; o tipo de parte relacionada é assigned_to Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: assigned_to Usuário atribuído para trabalhar no tíquete. assignment_group Grupo atribuído para trabalhar no tíquete. cliente : Empresa ou conta do tíquete. customer_contact Solicitante ou contato para o tíquete. Tipo de dados: Cadeia de caracteres
severidade	Gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Tipo de dados: Cadeia de caracteres
status	Status atual do tíquete de problemas. Mapeia para o campo Estado. Tipo de dados: Cadeia de caracteres
ticketType	Tipo de tíquete. Valores possíveis: Caso incidente Tipo de dados: Cadeia de caracteres
.	Este valor é sempre Tíquete de problemas . Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera um registro de tíquete de problema da tabela Caso [sn_customerservice_case].

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corpo da resposta.

{
    "id": "370415f03c20e910f8772f1bc332b31b",
    "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
    "creationDate": "2023-01-19 22:39:28",
    "lastUpdate": "2023-01-19 22:41:39",
    "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
    "severity": "2 - High",
    "ticketType": "Case",
    "name": "My router is not working properly",
    "status": "Open",
    "channel": {
        "name": "e_bonding"
    },
    "relatedParty": [
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@referredType": "customer"
        },
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@referredType": "customer_contact"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assignment_group"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assigned_to"
        }
    ],
    "relatedEntity": [
        {
            "id": "b7fa12c7532520103b6bddeeff7b123b",
            "href": "",
            "name": "Deduplication and Compression PRD00001965",
            "role": "This is the product associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product"
        },
        {
            "id": "71e73d87c3e23010ff00ed23a140dde8",
            "href": "",
            "name": "",
            "role": "This is the asset associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "asset"
        },
        {
            "id": "a1913c3577b301108e191e599a5a99e8",
            "href": "",
            "name": "Deduplication and Compression PI0000037",
            "role": "This is the product inventory associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product_inventory"
        }
    ],
    "note": [
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:41:39",
            "author": "System Administrator",
            "@type": "comments"
        },
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:39:28",
            "author": "System Administrator",
            "@type": "comments"
        }
    ],
    "@type": "TroubleTicket"
}

Tíquete de problema - OBTER /sn_ind_tsm_sdwan/troubletíquete/

Recupera um registro especificado da tabela Caso [sn_customerservice_case] ou Incidente [incident].

Importante:

Começando com Tokyo este endpoint foi descontinuado. A nova versão deste endpoint é Tíquete de problema - OBTER /sn_ind_tsm_sdwan/tíquete/troubleTíquete/.

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/troubletíquete/

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
ticketType	Tipo de tíquete. Este valor determina se um registro é recuperado da tabela Caso [sn_customerservice_case] ou Incidente [incident]. Valores válidos: caso incidente Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de caso ou incidente a ser recuperado. Tipo de dados: Cadeia de caracteres

Tabela 14. Parâmetros de consulta

Nome	Descrição
campos	Lista separada por vírgulas de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este valor não for passado, todos os campos serão retornados. Campos válidos: canal creationDate descrição id LastUpdate nome nota RelatedEntity RelatedParty severidade status ticketType . Tipo de dados: Cadeia de caracteres

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir. Parâmetro de caminho inválido. URI inválido.
404	Registro não encontrado. Um registro associado ao ID não foi encontrado na tabela Caso [sn_customerservice_case] ou Incidente [incident].

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

Nome	Descrição
.	Este valor é sempre Tíquete de problemas . Tipo de dados: Cadeia de caracteres
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Mapeia para o campo Canal [contact_type] para casos e o campo Tipo de contato [contact_type] para incidentes. Tipo de dados: Cadeia de caracteres
creationDate	Data em que o registro de caso ou incidente foi criado. Mapeia para o campo criado. Tipo de dados: Cadeia de caracteres
descrição	Descrição do problema do tíquete. Mapeia para o campo Descrição. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
LastUpdate	Data em que o registro foi atualizado pela última vez. Mapeia para o campo Atualizado. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Mapeia para o campo Descrição resumida. Tipo de dados: Cadeia de caracteres
nota	Lista de todos os comentários no tíquete. Esta lista não inclui anotações de trabalho. Tipo de dados: Matriz de objetos "note": [ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Somente comentários são retornados (não anotações de trabalho), portanto, este valor é sempre comentários . Tipo de dados: Cadeia de caracteres
note.author	Nome do ServiceNow Usuário de integração que fez a solicitação POST ou PATCH que criou o comentário. Tipo de dados: Cadeia de caracteres
note.date	Data em que o comentário foi criado em ServiceNow instância. Tipo de dados: Cadeia de caracteres
note.text	Texto do comentário. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
RelatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
RelatedEntity.href	Retorna uma cadeia de caracteres vazia. Tipo de dados: Cadeia de caracteres
relatedEntity.name	Nome do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
RelatedEntity.role	Descrição do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedEntity. Em tipo	Este valor é sempre RelatedEntity . Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre as empresas e contatos associados ao tíquete. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
RelatedParty. Em referredType	Tipo de parte relacionada. Valores válidos: Cliente: Empresa ou conta do tíquete. Customer_contact: Chamador ou contato do tíquete. Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Se você fornecer um contato ou um usuário (chamador), a conta ou empresa dele será preenchida automaticamente no tíquete. Tipo de dados: Cadeia de caracteres Tabela: Para casos, o sys_id é das tabelas Contato [customer_contact] ou Conta [customer_account]. Para incidentes, o sys_id é das tabelas Usuário [sys_user] ou Empresa [core_company].
relatedParty.name	Nome da parte relacionada. Para casos, mapeia para o campo Contato ou Conta. Para incidentes, mapeia para o campo Solicitante ou Empresa. Tipo de dados: Cadeia de caracteres
severidade	Gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Tipo de dados: Cadeia de caracteres
status	Status atual do tíquete de problemas. Mapeia para o campo. Tipo de dados: Cadeia de caracteres
ticketType	Tipo de tíquete (caso ou incidente). Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo obtém o nome, a descrição, a gravidade e o status de um caso.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/a78e2c8cdb68b41015364c9b0b96193e?fields=name%2Cdescription%2Cseverity%2Cstatus" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corpo da resposta.

{
  "name": "Short description of issue",
  "description": "Example description of an issue",
  "severity": "2 - High",
  "status": "Open"
}

Tíquete de problema - PATCH /sn_ind_tsm_sdwan/tíquete/troubletíquete/

Atualiza um registro especificado na tabela Caso [sn_customerservice_case] ou Incidente [incident].

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
id	Sys_id do registro de caso ou incidente a ser atualizado. Tipo de dados: Cadeia de caracteres Tabela: Caso [sn_customerservice_case] ou Incidente [incident]

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 21. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Mapeia para o campo Canal [contact_type] para casos e o campo Tipo de contato [contact_type] para incidentes. Os valores válidos são as opções para o campo contact_type. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Virtual Agent ou virtual_agent . Tipo de dados: Cadeia de caracteres
descrição	Descrição do problema. Mapeia para Descrição campo. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Mapeia para o campo Descrição resumida. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: Matriz de objetos "note":[ { "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Este valor determina se a anotação é registrada no campo Anotações de trabalho ou Comentários adicionais. Valores válidos: comentários work_notes Tipo de dados: Cadeia de caracteres
note.text	Texto da anotação. Mapeia para o campo Anotações de trabalho ou Comentários adicionais. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Para casos, este parâmetro preenche o campo Contato ou Conta. Para incidentes, este parâmetro preenche o campo Solicitante ou Empresa. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. Se você fornecer um contato ou um usuário (chamador), a conta ou empresa dele será preenchida automaticamente no tíquete. Tipo de dados: Cadeia de caracteres Tabela: Para casos, o sys_id é das tabelas Contato [customer_contact] ou Conta [customer_account]. Para incidentes, o sys_id é das tabelas Usuário [sys_user] ou Empresa [core_company].
RelatedParty. Em referredType	Tipo de parte relacionada. Valores válidos: Cliente: Empresa ou conta do tíquete. Customer_contact: Chamador ou contato do tíquete. Tipo de dados: Cadeia de caracteres
severidade	Gravidade do problema descrito pelo tíquete de problema. Mapeia para Prioridade campo. Valores válidos: 1: Crítico 2: Alto 3: Moderado 4: Baixo 5: Planejamento. Incidente somente. Os valores válidos são as opções para o campo Prioridade. Você deve fornecer somente o valor de opção. Por exemplo, 1 . Se um valor inválido for fornecido, a Severidade será definida como Baixa. Tipo de dados: Cadeia de caracteres
status	Status atual do tíquete de problemas. Mapeia para Estado campo. Os valores válidos são as opções para Estado campo. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Novo ou 1 . Tipo de dados: Cadeia de caracteres

Cabeçalhos

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

Tabela 22. Cabeçalhos da solicitação

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.

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 24. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir. Parâmetro de caminho inválido. URI inválido.
404	Registro não encontrado. Um registro associado ao ID não foi encontrado na tabela Caso [sn_customerservice_case] ou Incidente [incident].

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Tipo de dados: Cadeia de caracteres
creationDate	Data em que o registro foi criado. Tipo de dados: Cadeia de caracteres
descrição	Descrição do problema do tíquete. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
LastUpdate	Data em que o registro foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Tipo de dados: Cadeia de caracteres
nota	Lista de todos os comentários no tíquete. Esta lista não inclui anotações de trabalho. Tipo de dados: Matriz de objetos "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Somente comentários são retornados (não anotações de trabalho), portanto, este valor é sempre comentários . Tipo de dados: Cadeia de caracteres
note.author	Nome do usuário que escreveu o comentário. Tipo de dados: Cadeia de caracteres
note.date	Data em que o comentário foi criado em ServiceNow instância. Tipo de dados: Cadeia de caracteres
note.text	Texto do comentário. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
RelatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
RelatedEntity.href	Retorna uma cadeia de caracteres vazia. Tipo de dados: Cadeia de caracteres
relatedEntity.name	Nome do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
RelatedEntity.role	Descrição do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedEntity. Em tipo	Este valor é sempre RelatedEntity . Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
IdentidadeRelatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das seguintes tabelas, dependendo do tipo de tíquete e do tipo de parte relacionada. Caso: Conta [customer_account]; o tipo de parte relacionada é cliente Contato [customer_contact]; o tipo de parte relacionada é customer_contact Incidente: Empresa [core_company]; o tipo de parte relacionada é cliente Usuário [sys_user]; o tipo de parte relacionada é customer_contact Caso ou incidente: Grupo [sys_user_group]; o tipo de parte relacionada é assignment_group Usuário [sys_user]; o tipo de parte relacionada é assigned_to Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: assigned_to Usuário atribuído para trabalhar no tíquete. assignment_group Grupo atribuído para trabalhar no tíquete. cliente : Empresa ou conta do tíquete. customer_contact Solicitante ou contato para o tíquete. Tipo de dados: Cadeia de caracteres
severidade	Gravidade do problema descrito pelo tíquete de problema. Tipo de dados: Cadeia de caracteres
status	Status atual do tíquete de problemas. Tipo de dados: Cadeia de caracteres
ticketType	Tipo de tíquete. Valores possíveis: Caso incidente Tipo de dados: Cadeia de caracteres
.	Este valor é sempre Tíquete de problemas . Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo atualiza um registro de caso.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   description: "Updated description",
   "note": [
      {
         "text": "Adding another comment",
         "@type": "comments"
      }
   ]
}" \
--user 'username':'password'

Corpo da resposta.

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:48:42",
   "description": "Updated description",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Adding another comment",
         "date": "2022-05-16 16:48:42",
         "author": "admin",
         "@type": "comments"
      },
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}

Tíquete de problema - PATCH /sn_ind_tsm_sdwan/troubletíquete/

Atualiza um registro na tabela Caso [sn_customerservice_case] ou Incidente [incident].

Importante:

Começando com Tokyo este endpoint foi descontinuado. A nova versão deste endpoint é Tíquete de problema - PATCH /sn_ind_tsm_sdwan/tíquete/troubletíquete/.

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/troubletíquete/

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
ticketType	Tipo de tíquete. Este valor determina se um registro é atualizado na tabela Caso [sn_customerservice_case] ou Incidente [incident]. Valores válidos: caso incidente Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de caso ou incidente a ser atualizado. Tipo de dados: Cadeia de caracteres

Tabela 26. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Mapeia para o campo Canal [contact_type] para casos e o campo Tipo de contato [contact_type] para incidentes. Os valores válidos são as opções para o campo contact_type. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Virtual Agent ou virtual_agent . Tipo de dados: Cadeia de caracteres
descrição	Descrição do problema. Mapeia para Descrição campo. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Mapeia para o campo Descrição resumida. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: Matriz de objetos "note":[ { "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Este valor determina se a anotação é registrada no campo Anotações de trabalho ou Comentários adicionais. Valores válidos: comentários work_notes Tipo de dados: Cadeia de caracteres
note.text	Texto da anotação. Mapeia para o campo Anotações de trabalho ou Comentários adicionais. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Para casos, este parâmetro preenche o campo Contato ou Conta. Para incidentes, este parâmetro preenche o campo Solicitante ou Empresa. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "@referredType": "String" } ]
RelatedParty. Em referredType	Tipo de parte relacionada. Valores válidos: Cliente: Empresa ou conta do tíquete. Customer_contact: Chamador ou contato do tíquete. Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Se você fornecer um contato ou um usuário (chamador), a conta ou empresa dele será preenchida automaticamente no tíquete. Tipo de dados: Cadeia de caracteres Tabela: Para casos, o sys_id é das tabelas Contato [customer_contact] ou Conta [customer_account]. Para incidentes, o sys_id é das tabelas Usuário [sys_user] ou Empresa [core_company].
severidade	Gravidade do problema descrito pelo tíquete de problema. Mapeia para Prioridade campo. Valores válidos: 1: Crítico 2: Alto 3: Moderado 4: Baixo 5: Planejamento. Incidente somente. Os valores válidos são as opções para o campo Prioridade. Você deve fornecer somente o valor de opção. Por exemplo, 1 . Se um valor inválido for fornecido, a Severidade será definida como Baixa. Tipo de dados: Cadeia de caracteres
status	Status atual do tíquete de problemas. Mapeia para o campo Estado. Os valores válidos são as opções do campo Estado. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Novo ou 1 . Tipo de dados: Cadeia de caracteres

Cabeçalhos

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

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 30. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir. Parâmetro de caminho inválido. URI inválido.
404	Registro não encontrado. Um registro associado ao ID não foi encontrado na tabela Caso [sn_customerservice_case] ou Incidente [incident].

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

Nome	Descrição
.	Este valor é sempre Tíquete de problemas . Tipo de dados: Cadeia de caracteres
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	O nome do método de contato. Tipo de dados: Cadeia de caracteres
creationDate	A data em que o registro foi criado. Tipo de dados: Cadeia de caracteres
descrição	A descrição do problema do tíquete. Tipo de dados: Cadeia de caracteres
id	O sys_id do registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
LastUpdate	A data em que o registro foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
nome	O nome do tíquete de problema, normalmente uma descrição resumida do problema. Tipo de dados: Cadeia de caracteres
nota	Uma lista de todos os comentários no tíquete. Esta lista não inclui anotações de trabalho. Tipo de dados: Matriz "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
tipo. em	O tipo de anotação. Somente comentários são retornados (não anotações de trabalho), portanto, este valor é sempre comentários . Tipo de dados: Cadeia de caracteres
note.author	O nome do usuário de integração da ServiceNow que fez a solicitação POST ou DE PATCH que criou o comentário. Tipo de dados: Cadeia de caracteres
note.date	A data em que o comentário foi criado na instância da ServiceNow. Tipo de dados: Cadeia de caracteres
note.text	O texto do comentário. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
RelatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
RelatedEntity.href	Retorna uma cadeia de caracteres vazia. Tipo de dados: Cadeia de caracteres
relatedEntity.name	Nome do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
RelatedEntity.role	Descrição do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedEntity. Em tipo	Este valor é sempre RelatedEntity . Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre as empresas e contatos associados ao tíquete. Tipo de dados: Matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
RelatedParty. Em referredType	Tipo de parte relacionada. Valores válidos: Cliente: Empresa ou conta do tíquete. Customer_contact: Chamador ou contato do tíquete. Tipo de dados: Cadeia de caracteres
IdentidadeRelatedParty.id	Sys_id da parte relacionada. Se você fornecer um contato ou um usuário (chamador), a conta ou empresa dele será preenchida automaticamente no tíquete. Tipo de dados: Cadeia de caracteres Tabela: Para casos, o sys_id é das tabelas Contato [customer_contact] ou Conta [customer_account]. Para incidentes, o sys_id é das tabelas Usuário [sys_user] ou Empresa [core_company].
relatedParty.name	O nome da parte relacionada. Tipo de dados: Cadeia de caracteres
severidade	A gravidade do problema descrito pelo tíquete de problema. Tipo de dados: Cadeia de caracteres
status	O status atual do tíquete de problemas. Tipo de dados: Cadeia de caracteres
ticketType	O tipo de tíquete (caso ou incidente). Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo atualiza um registro de caso.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/370415f03c20e910f8772f1bc332b31b" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--user 'username':'password'

Corpo da resposta.

{
  "id": "370415f03c20e910f8772f1bc332b31b",
  "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
  "creationDate": "2023-01-19 22:39:28",
  "lastUpdate": "2023-01-19 22:41:39",
  "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
  "severity": "2 - High",
  "ticketType": "Case",
  "name": "My router is not working properly",
  "status": "Open",
  "channel": {
    "name": "e_bonding"
  },
  "relatedParty": [
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@referredType": "customer"
    },
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@referredType": "customer_contact"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assignment_group"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assigned_to"
    }
  ],
  "relatedEntity": [
    {
      "id": "b7fa12c7532520103b6bddeeff7b123b",
      "href": "",
      "name": "Deduplication and Compression PRD00001965",
      "role": "This is the product associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product"
    },
    {
      "id": "71e73d87c3e23010ff00ed23a140dde8",
      "href": "",
      "name": "",
      "role": "This is the asset associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "asset"
    },
    {
      "id": "a1913c3577b301108e191e599a5a99e8",
      "href": "",
      "name": "Deduplication and Compression PI0000037",
      "role": "This is the product inventory associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product_inventory"
    }
  ],
  "note": [
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 14:41:39",
      "author": "System Administrator",
      "@type": "comments"
    },
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 14:39:28",
      "author": "System Administrator",
      "@type": "comments"
    }
  ],
  "@type": "TroubleTicket"
}

Tíquete de problema - POST /sn_ind_tsm_sdwan/tíquete/troubleTíquete  

Cria um registro na tabela Caso [sn_customerservice_case] ou Incidente [incident].

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/tíquete/troubletíquete

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 32. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 33. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Mapeia para o campo Canal [contact_type] para casos e o campo Tipo de contato [contact_type] para incidentes. Os valores válidos são as opções para o campo contact_type. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Virtual Agent ou virtual_agent . Tipo de dados: Cadeia de caracteres
descrição	Obrigatório. Uma descrição do problema. Mapeia para Descrição campo. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Mapeia para o campo Descrição resumida. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: Matriz de objetos "note":[ { "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Este valor determina se a anotação é registrada no campo Anotações de trabalho ou Comentários adicionais. Valores válidos: comentários work_notes Tipo de dados: Cadeia de caracteres
note.text	Texto da anotação. Mapeia para o campo Anotações de trabalho ou Comentários adicionais. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Para casos, este parâmetro preenche o campo Contato ou Conta. Para incidentes, este parâmetro preenche o campo Solicitante ou Empresa. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. Se você fornecer um contato ou um usuário (chamador), a conta ou empresa dele será preenchida automaticamente no tíquete. Tipo de dados: Cadeia de caracteres Tabela: Para casos, o sys_id é das tabelas Contato [customer_contact] ou Conta [customer_account]. Para incidentes, o sys_id é das tabelas Usuário [sys_user] ou Empresa [core_company].
RelatedParty. Em referredType	Tipo de parte relacionada. Valores válidos: Cliente: Empresa ou conta do tíquete. Customer_contact: Chamador ou contato do tíquete. Tipo de dados: Cadeia de caracteres
severidade	Obrigatório. A gravidade do problema descrito pelo tíquete de problema. Mapeia para Prioridade campo. Valores válidos: 1: Crítico 2: Alto 3: Moderado 4: Baixo 5: Planejamento. Incidente somente. Os valores válidos são as opções para o campo Prioridade. Você deve fornecer somente o valor de opção. Por exemplo, 1 . Se um valor inválido for fornecido, a Severidade será definida como Baixa. Tipo de dados: Cadeia de caracteres
status	Obrigatório. O status atual do tíquete de problemas. Mapeia para Estado campo. Os valores válidos são as opções para Estado campo. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Novo ou 1 . Se você fornecer um valor inválido , O status é definido como Novo. Tipo de dados: Cadeia de caracteres
ticketType	O tipo de tíquete. Este valor determina se o registro é criado na tabela Caso [sn_customerservice_case] ou Incidente [incident]. Valores válidos: Caso incidente Tipo de dados: Cadeia de caracteres Padrão: Incidente

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

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.

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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 36. Códigos de status

Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir. Carga vazia. Carga inválida. Campo obrigatório ausente. TicketType inválido.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
.	Este valor é sempre Tíquete de problemas . Tipo de dados: Cadeia de caracteres
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	O nome do método de contato. Tipo de dados: Cadeia de caracteres
creationDate	A data em que o registro do caso ou incidente foi criado. Tipo de dados: Cadeia de caracteres
descrição	A descrição do problema do tíquete. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de caso ou incidente. Tipo de dados: Cadeia de caracteres
id	O sys_id do registro de caso ou incidente que foi criado. Tipo de dados: Cadeia de caracteres
LastUpdate	A data em que o registro do caso ou incidente foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
nome	O nome do tíquete de problema, normalmente uma descrição resumida do problema. Tipo de dados: Cadeia de caracteres
nota	Uma lista de todos os comentários no tíquete. Esta lista não inclui anotações de trabalho. Tipo de dados: Matriz "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
tipo. em	O tipo de anotação. Somente comentários são retornados (não anotações de trabalho), portanto, este valor é sempre comentários . Tipo de dados: Cadeia de caracteres
note.author	O nome do usuário que escreveu o comentário. Tipo de dados: Cadeia de caracteres
note.date	A data em que o comentário foi criado em ServiceNow instância. Tipo de dados: Cadeia de caracteres
note.text	O texto do comentário. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
RelatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
RelatedEntity.href	Retorna uma cadeia de caracteres vazia. Tipo de dados: Cadeia de caracteres
relatedEntity.name	Nome do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
RelatedEntity.role	Descrição do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedEntity. Em tipo	Este valor é sempre RelatedEntity . Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
IdentidadeRelatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das seguintes tabelas, dependendo do tipo de tíquete e do tipo de parte relacionada. Caso: Conta [customer_account]; o tipo de parte relacionada é cliente Contato [customer_contact]; o tipo de parte relacionada é customer_contact Incidente: Empresa [core_company]; o tipo de parte relacionada é cliente Usuário [sys_user]; o tipo de parte relacionada é customer_contact Caso ou incidente: Grupo [sys_user_group]; o tipo de parte relacionada é assignment_group Usuário [sys_user]; o tipo de parte relacionada é assigned_to Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da parte relacionada. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: assigned_to Usuário atribuído para trabalhar no tíquete. assignment_group Grupo atribuído para trabalhar no tíquete. cliente : Empresa ou conta do tíquete. customer_contact Solicitante ou contato para o tíquete. Tipo de dados: Cadeia de caracteres
severidade	A gravidade do problema descrito pelo tíquete de problema. Tipo de dados: Cadeia de caracteres
status	O status atual do tíquete de problemas. Tipo de dados: Cadeia de caracteres
ticketType	O tipo de tíquete. Valores possíveis: Caso incidente Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo cria um registro de caso de tíquete de problemas.

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "name": "Laptop problem",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2",
   "status": "New",
   "ticketType": "Case",
   "channel": {
      "name": "Web"
   },
   "note": [
      {
         "text": "Work note about this case",
         "@type": "work_notes"
      },
      {
         "text": "Comment about this case",
         "@type": "comments"
      }
   ],
   "relatedEntity": [
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "@referredType": "asset"
      }
   ],
   "relatedParty": [
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "@referredType": "customer_contact"
      }
   ]
}" \
--user 'username':'password'

Corpo da resposta.

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:38:55",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}

Tíquete de problema - POST /sn_ind_tsm_sdwan/troubletíquete/

Cria um registro na tabela Caso [sn_customerservice_case] ou Incidente [incident].

Importante:

Começando com Tokyo este endpoint foi descontinuado. A nova versão deste endpoint é Tíquete de problema - POST /sn_ind_tsm_sdwan/tíquete/troubleTíquete  .

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/troubletíquete/

Parâmetros de solicitação compatíveis

Tabela 37. Parâmetros de caminho

Nome	Descrição
ticketType	O tipo de tíquete. Este valor determina se o registro é criado na tabela Caso [sn_customerservice_case] ou Incidente [incident]. Valores válidos: caso incidente Tipo de dados: Cadeia de caracteres

Tabela 38. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Mapeia para o campo Canal [contact_type] para casos e o campo Tipo de contato [contact_type] para incidentes. Os valores válidos são as opções para o campo contact_type. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Virtual Agent ou virtual_agent . Tipo de dados: Cadeia de caracteres
descrição	Obrigatório. Uma descrição do problema. Mapeia para Descrição campo. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Mapeia para o campo Descrição resumida. Tipo de dados: Cadeia de caracteres
nota	Lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: Matriz de objetos "note":[ { "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Este valor determina se a anotação é registrada no campo Anotações de trabalho ou Comentários adicionais. Valores válidos: comentários work_notes Tipo de dados: Cadeia de caracteres
note.text	Texto da anotação. Mapeia para o campo Anotações de trabalho ou Comentários adicionais. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "@referredType": "String" } ]
relatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre contatos do tíquete. Para casos, este parâmetro preenche o campo Contato ou Conta. Para incidentes, este parâmetro preenche o campo Solicitante ou Empresa. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "@referredType": "String" } ]
RelatedParty. Em referredType	Tipo de parte relacionada. Valores válidos: Cliente: Empresa ou conta do tíquete. Customer_contact: Chamador ou contato do tíquete. Tipo de dados: Cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. Se você fornecer um contato ou um usuário (chamador), a conta ou empresa dele será preenchida automaticamente no tíquete. Tipo de dados: Cadeia de caracteres Tabela: Para casos, o sys_id é das tabelas Contato [customer_contact] ou Conta [customer_account]. Para incidentes, o sys_id é das tabelas Usuário [sys_user] ou Empresa [core_company].
severidade	Obrigatório. Gravidade do problema descrito pelo tíquete de problema. Mapeia para Prioridade campo. Valores válidos: 1: Crítico 2: Alto 3: Moderado 4: Baixo 5: Planejamento. Incidente somente. Os valores válidos são as opções para o campo Prioridade. Você deve fornecer somente o valor de opção. Por exemplo, 1 . Se um valor inválido for fornecido, a Severidade será definida como Baixa. Tipo de dados: Cadeia de caracteres
status	Status atual do tíquete de problemas. Mapeia para Estado campo. Os valores válidos são as opções para Estado campo. Você pode fornecer o rótulo ou o valor de opção. Por exemplo, Novo ou 1 . Tipo de dados: Cadeia de caracteres Padrão: Novo
ticketType	Obrigatório. Tipo de tíquete. Este valor determina se o registro é criado na tabela Caso [sn_customerservice_case] ou Incidente [incident]. Valores válidos: caso incidente Tipo de dados: Cadeia de caracteres

Cabeçalhos

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

Tabela 40. Cabeçalhos da solicitação

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.

Tabela 41. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 42. Códigos de status

Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir. Carga vazia. Carga inválida. Campo obrigatório ausente. TicketType inválido ou ticketType não corresponde ao parâmetro de caminho ticketType. Por exemplo, ticketType é caso mas o parâmetro de caminho é incidente .

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

Nome	Descrição
.	Este valor é sempre Tíquete de problemas . Tipo de dados: Cadeia de caracteres
canal	Método de contato por meio do qual o tíquete foi criado. Tipo de dados: Objeto "channel":{ "name": "String" }
channel.name	Nome do método de contato. Tipo de dados: Cadeia de caracteres
creationDate	Data em que o registro de caso ou incidente foi criado. Tipo de dados: Cadeia de caracteres
descrição	Descrição do problema do tíquete. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de caso ou incidente criado. Tipo de dados: Cadeia de caracteres
LastUpdate	Data em que o registro do caso ou incidente foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres
nome	Nome do tíquete de problema, normalmente uma descrição resumida do problema. Tipo de dados: Cadeia de caracteres
nota	Lista de comentários e anotações de trabalho que foram adicionados ao tíquete pela solicitação POST. Tipo de dados: Matriz de objetos "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
tipo. em	Tipo de anotação. Valores válidos: comentários work_notes Tipo de dados: Cadeia de caracteres
note.author	Nome do ServiceNow Usuário de integração que fez a solicitação POST que criou a anotação. Tipo de dados: Cadeia de caracteres
note.date	Data em que a anotação foi criada em ServiceNow instância. Tipo de dados: Cadeia de caracteres
note.text	Texto da anotação. Tipo de dados: Cadeia de caracteres
RelatedEntity	Lista de ativos, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços afetados. Tipo de dados: Matriz de objetos "relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]
RelatedEntity.id	Sys_id do item ou serviço afetado. Para casos, este valor é de uma das seguintes tabelas: Ativo [alm_asset] Inventário de produto [sn_prd_invt_product_inventory], que estende a tabela Produto vendido [sn_install_base_sold_product] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Para incidentes, este valor é de uma das seguintes tabelas: Item de configuração [cmdb_ci] Serviço [cmdb_ci_service] Tipo de dados: Cadeia de caracteres
RelatedEntity.href	Retorna uma cadeia de caracteres vazia. Tipo de dados: Cadeia de caracteres
relatedEntity.name	Nome do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
RelatedEntity.role	Descrição do item ou serviço afetado. Tipo de dados: Cadeia de caracteres
ReferredEntity. Em referredType	Tipo de item ou serviço. Valores válidos para tíquetes de caso: ativo Produto product_inventory Valores válidos para tíquetes de incidente: cmdb_ci cmdb_ci_service Tipo de dados: Cadeia de caracteres
RelatedEntity. Em tipo	Este valor é sempre RelatedEntity . Tipo de dados: Cadeia de caracteres
RelatedParty	Detalhes sobre as empresas e contatos associados ao tíquete. Tipo de dados: Matriz de objetos "relatedParty": [ { "id": "String", "@referredType": "String" } ]
IdentidadeRelatedParty.id	Sys_id da parte relacionada. Se você fornecer um contato ou um usuário (chamador), a conta ou empresa dele será preenchida automaticamente no tíquete. Tipo de dados: Cadeia de caracteres Tabela: Para casos, o sys_id é das tabelas Contato [customer_contact] ou Conta [customer_account]. Para incidentes, o sys_id é das tabelas Usuário [sys_user] ou Empresa [core_company].
RelatedParty.referredType	Tipo de parte relacionada. Valores válidos: Cliente: Empresa ou conta do tíquete. Customer_contact: Chamador ou contato do tíquete. Tipo de dados: Cadeia de caracteres
severidade	Gravidade do problema descrito pelo tíquete de problema. Tipo de dados: Cadeia de caracteres
status	Status atual do tíquete de problemas. Tipo de dados: Cadeia de caracteres
ticketType	Tipo de tíquete (caso ou incidente). Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo cria um caso com alta prioridade e estado em aberto.

ccurl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"description\":\"Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--user 'username':'password'

Corpo da resposta.

{
  "id": "5bbb5cbc3c2ca910f8772f1bc332b34d",
  "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/5bbb5cbc3c2ca910f8772f1bc332b34d",
  "creationDate": "2023-01-19 18:33:24",
  "lastUpdate": "2023-01-19 18:33:24",
  "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
  "severity": "2 - High",
  "ticketType": "Case",
  "name": "My router is not working properly",
  "status": "Open",
  "channel": {
    "name": "e_bonding"
  },
  "relatedParty": [
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@referredType": "customer"
    },
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@referredType": "customer_contact"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assignment_group"
    },
    {
      "id": "",
      "name": "",
      "@referredType": "assigned_to"
    }
  ],
  "relatedEntity": [
    {
      "id": "b7fa12c7532520103b6bddeeff7b123b",
      "href": "",
      "name": "Deduplication and Compression PRD00001965",
      "role": "This is the product associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product"
    },
    {
      "id": "71e73d87c3e23010ff00ed23a140dde8",
      "href": "",
      "name": "",
      "role": "This is the asset associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "asset"
    },
    {
      "id": "a1913c3577b301108e191e599a5a99e8",
      "href": "",
      "name": "Deduplication and Compression PI0000037",
      "role": "This is the product inventory associated with the case.",
      "@type": "relatedEntity",
      "@referredType": "product_inventory"
    }
  ],
  "note": [
    {
      "text": "This is a testing comment<script>gs.info('Hello World')</script>",
      "date": "2023-01-19 10:33:24",
      "author": "System Administrator",
      "@type": "comments"
    }
  ],
  "@type": "TroubleTicket"
}