API de abertura de tíquete de problema

A API de abertura de tíquete de problema fornece endpoints para criar, atualizar e recuperar dados das tabelas Caso [sn_customerservice_case] e Incidente [incidente].

Use esta API para gerenciar informações de tíquete entre sistemas de registro de tíquete externo e o Now Platform.

Esta API está incluída na aplicação Telecommunications Assurance Workflows, que está disponível na ServiceNow Store. As aplicações 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 Caso [sn_customerservice_case].

Esta API é fornecida no namespace sn_ind_tsm_sdwan.

O usuário que faz a chamada deve ter a função de ingresso_integrador.

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

A API de abertura de tíquete de problema é uma implementação ServiceNow® da especificação REST da API de gerenciamento de tíquete de problema do TM Fórum. Esta implementação é baseada na Especificação REST da API da Gestão de tíquete de problemas TMF621 Versão 19, junho de 2019. A API de abertura de tíquete de problema tem conformidade certificada pelo Fórum TM.

Tíquete de problema - GET /sn_ind_tsm_sdwan/ticket/roubleTicket

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

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
Nenhum

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 description href id últimaAtualização nome anotação relatedEntity relatedParty severidade status ticketType @tipo Padrão: retorna todos os campos. Tipo de dados: cadeia de caracteres
id	Filtrar tíquetes de problema 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 o parâmetro offset para paginar a recuperação do registro. Padrão: 25 Máximo: 100 Você pode alterar os valores padrão e máximo atualizando as propriedades do sistema sn_ind_tsm_sdwan.pagination.set_limit e sn_ind_tsm_sdwan.pagination.max_limit. Tipo de dados: número
deslocamento	Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número
severidade	Filtrar tíquetes de problema 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 problema 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. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum

Tabela 5. Cabeçalhos de resposta

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

Códigos de status

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

Tabela 6. Códigos de status

Código de status	Descrição
200	Solicitação processada com êxito. 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	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O 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	A data em que o caso ou registro de incidente foi criado. Mapeia para o campo Criado. Tipo de dados: cadeia de caracteres
description	A descrição do problema do tíquete. Mapeia para o campo Descrição. Tipo de dados: cadeia de caracteres
href	Link relativo para o caso ou registro de incidente. Tipo de dados: cadeia de caracteres
id	O sys_id do caso ou registro de incidente. Tipo de dados: cadeia de caracteres
últimaAtualização	A data em que o registro foi atualizado pela última vez. Mapeia para o campo Atualizado. Tipo de dados: cadeia de caracteres
nome	O 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
anotação	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" } ]
nota.@tipo	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
nota.autor	O nome do usuário de integração ServiceNow que fez a solicitação POST ou PATCH que criou o comentário. Tipo de dados: cadeia de caracteres
nota.data	A data em que o comentário foi criado na instância ServiceNow. Tipo de dados: cadeia de caracteres
nota.texto	O texto do comentário. Tipo de dados: cadeia de caracteres
relatedEntity	Lista de ativos afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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
relatedEntity.@referredType	O 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.@type	Este valor é sempre relatedEntity. Tipo de dados: cadeia de caracteres
relatedParty	Detalhes sobre os contatos do tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das tabelas a seguir, 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 é assign_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.@referredType	O tipo de parte relacionada. Valores possíveis: assigned_to: o usuário atribuído para trabalhar no tíquete. assign_group: o grupo atribuído para trabalhar no tíquete. cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do tíquete. Tipo de dados: cadeia de caracteres
severidade	A gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Tipo de dados: cadeia de caracteres
status	O status atual do tíquete de problema. Mapas para o campo Estado. Tipo de dados: cadeia de caracteres
ticketType	O tipo de tíquete. Valores possíveis: Caso Incidente Tipo de dados: cadeia de caracteres
@tipo	Este valor é sempre TroubleTicket. 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 problema.

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 - GET /sn_ind_tsm_sdwan/ticket/roubleTicket/{id}

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

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/ticket/roubleTicket/{id}

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
id	Sys_id do caso ou registro de incidente a ser recuperado. Localizado na tabela Caso [sn_customerservice_case] ou Incidente [incidente]. Tipo de dados: cadeia de caracteres

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 description href id últimaAtualização nome anotação relatedEntity relatedParty severidade status ticketType @tipo Padrão: retorna todos os campos. Tipo de dados: cadeia de caracteres

Tabela 9. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

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

Tabela 10. Cabeçalhos da solicitação

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

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

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

Tabela 12. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
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 [incidente].

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O 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	A data em que o caso ou registro de incidente foi criado. Mapeia para o campo Criado. Tipo de dados: cadeia de caracteres
description	A descrição do problema do tíquete. Mapeia para o campo Descrição. Tipo de dados: cadeia de caracteres
href	Link relativo para o caso ou registro de incidente. Tipo de dados: cadeia de caracteres
id	O sys_id do caso ou registro de incidente. Tipo de dados: cadeia de caracteres
últimaAtualização	A data em que o registro foi atualizado pela última vez. Mapeia para o campo Atualizado. Tipo de dados: cadeia de caracteres
nome	O 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
anotação	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" } ]
nota.@tipo	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
nota.autor	O nome do usuário que fez o comentário. Tipo de dados: cadeia de caracteres
nota.data	A data em que o comentário foi criado na instância ServiceNow. Tipo de dados: cadeia de caracteres
nota.texto	O texto do comentário. Tipo de dados: cadeia de caracteres
relatedEntity	Lista de ativos afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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
relatedEntity.@referredType	O 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.@type	Este valor é sempre relatedEntity. Tipo de dados: cadeia de caracteres
relatedParty	Detalhes sobre os contatos do tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das tabelas a seguir, 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 é assign_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.@referredType	O tipo de parte relacionada. Valores possíveis: assigned_to: o usuário atribuído para trabalhar no tíquete. assign_group: o grupo atribuído para trabalhar no tíquete. cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do tíquete. Tipo de dados: cadeia de caracteres
severidade	A gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Tipo de dados: cadeia de caracteres
status	O status atual do tíquete de problema. Mapas para o campo Estado. Tipo de dados: cadeia de caracteres
ticketType	O tipo de tíquete. Valores possíveis: Caso Incidente Tipo de dados: cadeia de caracteres
@tipo	Este valor é sempre TroubleTicket. 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 - GET /sn_ind_tsm_sdwan/roubleticket/{ticketType}/{id}

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

Importante:

Começando com a versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é Tíquete de problema - GET /sn_ind_tsm_sdwan/ticket/roubleTicket/{id}.

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/roubleticket/{ticketType}/{id}

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
ticketType	O tipo de tíquete. Este valor determina se um registro é recuperado da tabela Caso [sn_customerservice_case] ou Incidente [incidente]. Valores válidos: caso incidente Tipo de dados: cadeia de caracteres
id	Sys_id do caso ou registro de 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 description id últimaAtualização nome anotação relatedEntity relatedParty severidade status ticketType @tipo Tipo de dados: cadeia de caracteres

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

Nome	Descrição
Nenhum

Cabeçalhos

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

Tabela 16. Cabeçalhos da solicitação

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

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

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

Tabela 18. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. 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 [incidente].

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

Nome	Descrição
@tipo	Este valor é sempre TroubleTicket. Tipo de dados: cadeia de caracteres
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O 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	A data em que o caso ou registro de incidente foi criado. Mapeia para o campo Criado. Tipo de dados: cadeia de caracteres
description	A descrição do problema do tíquete. Mapeia para o campo Descrição. Tipo de dados: cadeia de caracteres
id	O sys_id do caso ou registro de incidente. Tipo de dados: cadeia de caracteres
últimaAtualização	A data em que o registro foi atualizado pela última vez. Mapeia para o campo Atualizado. Tipo de dados: cadeia de caracteres
nome	O 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
anotação	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" } ]
nota.@tipo	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
nota.autor	O nome do usuário de integração da ServiceNow que fez a solicitação POST ou PATCH que criou o comentário. Tipo de dados: cadeia de caracteres
nota.data	A data em que o comentário foi criado na instância da ServiceNow. Tipo de dados: cadeia de caracteres
nota.texto	O texto do comentário. Tipo de dados: cadeia de caracteres
relatedEntity	Lista de ativos afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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
relatedEntity.@referredType	O 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.@type	Este valor é sempre relatedEntity. Tipo de dados: cadeia de caracteres
relatedParty	Detalhes sobre as empresas e os contatos associados ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.@referredType	O tipo de parte relacionada. Valores válidos: cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do tíquete. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. 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]. Se você fornecer um contato ou usuário (solicitante), a conta ou a empresa dele será preenchida automaticamente no tíquete. Tipo de dados: cadeia de caracteres
relatedParty.name	O 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	A gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Tipo de dados: cadeia de caracteres
status	O status atual do tíquete de problema. Mapas para o campo Estado. 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 obtém o nome, a descrição, a severidade 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/ticket/roubleTicket/{id}

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

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/ticket/roubleTicket/{id}

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
id	Sys_id do caso ou registro de incidente a ser atualizado. Localizado na tabela Caso [sn_customerservice_case] ou Incidente [incidente]. Tipo de dados: cadeia de caracteres

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 21. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O 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 do 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
description	Uma descrição do problema. Mapeia para o campo Descrição. Tipo de dados: cadeia de caracteres
nome	O 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
anotação	Uma lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: matriz "note":[ { "text": "String", "@type": "String" } ]
nota.@tipo	O 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: work_notes comentários Tipo de dados: cadeia de caracteres
nota.texto	O 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 afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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.@referredType	O 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 os 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 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. 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]. Se você fornecer um contato ou usuário (solicitante), a conta ou a empresa dele será preenchida automaticamente no tíquete. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	O tipo de parte relacionada. Valores válidos: cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do tíquete. Tipo de dados: cadeia de caracteres
severidade	A gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Valores válidos: 1: Crítico. 2: alto. 3: moderado. 4: Baixo. 5: Planejamento. Somente incidente. Os valores válidos são as opções do 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	O status atual do tíquete de problema. Mapas para o campo Estado. Valores válidos são as opções para o 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 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

Códigos de status

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

Tabela 24. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. 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 [incidente].

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	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
description	A descrição do problema do tíquete. Tipo de dados: cadeia de caracteres
href	Link relativo para o caso ou registro de incidente. Tipo de dados: cadeia de caracteres
id	O sys_id do caso ou registro de incidente. Tipo de dados: cadeia de caracteres
últimaAtualização	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
anotação	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" } ]
nota.@tipo	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
nota.autor	O nome do usuário que fez o comentário. Tipo de dados: cadeia de caracteres
nota.data	A data em que o comentário foi criado na instância ServiceNow. Tipo de dados: cadeia de caracteres
nota.texto	O texto do comentário. Tipo de dados: cadeia de caracteres
relatedEntity	Lista de ativos afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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
relatedEntity.@referredType	O 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.@type	Este valor é sempre relatedEntity. Tipo de dados: cadeia de caracteres
relatedParty	Detalhes sobre os contatos do tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das tabelas a seguir, 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 é assign_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.@referredType	O tipo de parte relacionada. Valores possíveis: assigned_to: o usuário atribuído para trabalhar no tíquete. assign_group: o grupo atribuído para trabalhar no tíquete. cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do 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 problema. Tipo de dados: cadeia de caracteres
ticketType	O tipo de tíquete. Valores possíveis: Caso Incidente Tipo de dados: cadeia de caracteres
@tipo	Este valor é sempre TroubleTicket. 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/roubleticket/{ticketType}/{id}

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

Importante:

Começando com a versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é Tíquete de problema - PATCH /sn_ind_tsm_sdwan/ticket/roubleTicket/{id}.

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/roubleticket/{ticketType}/{id}

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

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

Tabela 26. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O 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 do 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
description	Uma descrição do problema. Mapeia para o campo Descrição. Tipo de dados: cadeia de caracteres
nome	O 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
anotação	Uma lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: matriz "note":[ { "text": "String", "@type": "String" } ]
nota.@tipo	O 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: work_notes comentários Tipo de dados: cadeia de caracteres
nota.texto	O 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 afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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.@referredType	O 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 os 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 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.@referredType	O tipo de parte relacionada. Valores válidos: cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do tíquete. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. 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]. Se você fornecer um contato ou usuário (solicitante), a conta ou a empresa dele será preenchida automaticamente no tíquete. Tipo de dados: cadeia de caracteres
severidade	A gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Valores válidos: 1: Crítico. 2: alto. 3: moderado. 4: Baixo. 5: Planejamento. Somente incidente. Os valores válidos são as opções do 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	O status atual do tíquete de problema. Mapas para o campo Estado. Valores válidos são as opções para o 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

Códigos de status

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

Tabela 30. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. 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 [incidente].

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

Nome	Descrição
@tipo	Este valor é sempre TroubleTicket. Tipo de dados: cadeia de caracteres
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	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
description	A descrição do problema do tíquete. Tipo de dados: cadeia de caracteres
id	O sys_id do caso ou registro de incidente. Tipo de dados: cadeia de caracteres
últimaAtualização	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
anotação	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" } ]
nota.@tipo	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
nota.autor	O nome do usuário de integração da ServiceNow que fez a solicitação POST ou PATCH que criou o comentário. Tipo de dados: cadeia de caracteres
nota.data	A data em que o comentário foi criado na instância da ServiceNow. Tipo de dados: cadeia de caracteres
nota.texto	O texto do comentário. Tipo de dados: cadeia de caracteres
relatedEntity	Lista de ativos afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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
relatedEntity.@referredType	O 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.@type	Este valor é sempre relatedEntity. Tipo de dados: cadeia de caracteres
relatedParty	Detalhes sobre as empresas e os contatos associados ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.@referredType	O tipo de parte relacionada. Valores válidos: cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do tíquete. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. 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]. Se você fornecer um contato ou usuário (solicitante), a conta ou a empresa dele será preenchida automaticamente no tíquete. Tipo de dados: cadeia de caracteres
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 problema. 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/ticket/roubleTicket

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

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
Nenhum

Tabela 32. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 33. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O 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 do 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
description	Obrigatório. Uma descrição do problema. Mapeia para o campo Descrição. Tipo de dados: cadeia de caracteres
nome	O 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
anotação	Uma lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: matriz "note":[ { "text": "String", "@type": "String" } ]
nota.@tipo	O 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: work_notes comentários Tipo de dados: cadeia de caracteres
nota.texto	O 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 afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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.@referredType	O 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 os 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 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. 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]. Se você fornecer um contato ou usuário (solicitante), a conta ou a empresa dele será preenchida automaticamente no tíquete. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	O tipo de parte relacionada. Valores válidos: cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante 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 o campo Prioridade. Valores válidos: 1: Crítico. 2: alto. 3: moderado. 4: Baixo. 5: Planejamento. Somente incidente. Os valores válidos são as opções do 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 problema. Mapas para o campo Estado. Valores válidos são as opções para o campo Estado. 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 será 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 [incidente]. 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

Códigos de status

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

Tabela 36. Códigos de status

Código de 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. Tipo de tíquete inválido.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
@tipo	Este valor é sempre TroubleTicket. Tipo de dados: cadeia de caracteres
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O nome do método de contato. Tipo de dados: cadeia de caracteres
creationDate	A data em que o caso ou registro de incidente foi criado. Tipo de dados: cadeia de caracteres
description	A descrição do problema do tíquete. Tipo de dados: cadeia de caracteres
href	Link relativo para o caso ou registro de incidente. Tipo de dados: cadeia de caracteres
id	O sys_id do caso ou registro de incidente que foi criado. Tipo de dados: cadeia de caracteres
últimaAtualização	A data em que o registro de 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
anotação	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" } ]
nota.@tipo	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
nota.autor	O nome do usuário que fez o comentário. Tipo de dados: cadeia de caracteres
nota.data	A data em que o comentário foi criado na instância ServiceNow. Tipo de dados: cadeia de caracteres
nota.texto	O texto do comentário. Tipo de dados: cadeia de caracteres
relatedEntity	Lista de ativos afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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
relatedEntity.@referredType	O 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.@type	Este valor é sempre relatedEntity. Tipo de dados: cadeia de caracteres
relatedParty	Detalhes sobre os contatos do tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. O sys_id pode ser das tabelas a seguir, 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 é assign_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.@referredType	O tipo de parte relacionada. Valores possíveis: assigned_to: o usuário atribuído para trabalhar no tíquete. assign_group: o grupo atribuído para trabalhar no tíquete. cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do 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 problema. 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 problema.

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/roubleticket/{ticketType}

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

Importante:

Começando com a versão Tokyo, este endpoint está obsoleto. A nova versão deste endpoint é Tíquete de problema - POST /sn_ind_tsm_sdwan/ticket/roubleTicket.

Formato de URL

URL padrão: /api/sn_ind_tsm_sdwan/roubleticket/{ticketType}

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 [incidente]. Valores válidos: caso incidente Tipo de dados: cadeia de caracteres

Tabela 38. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 39. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O 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 do 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
description	Obrigatório. Uma descrição do problema. Mapeia para o campo Descrição. Tipo de dados: cadeia de caracteres
nome	O 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
anotação	Uma lista de anotações de trabalho e comentários a serem adicionados ao tíquete. Tipo de dados: matriz "note":[ { "text": "String", "@type": "String" } ]
nota.@tipo	O 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: work_notes comentários Tipo de dados: cadeia de caracteres
nota.texto	O 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 afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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.@referredType	O 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 os 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 "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.@referredType	O tipo de parte relacionada. Valores válidos: cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do tíquete. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id da parte relacionada. 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]. Se você fornecer um contato ou usuário (solicitante), a conta ou a empresa dele será preenchida automaticamente no tíquete. Tipo de dados: cadeia de caracteres
severidade	Obrigatório. A gravidade do problema descrito pelo tíquete de problema. Mapeia para o campo Prioridade. Valores válidos: 1: Crítico. 2: alto. 3: moderado. 4: Baixo. 5: Planejamento. Somente incidente. Os valores válidos são as opções do 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	O status atual do tíquete de problema. Mapas para o campo Estado. Valores válidos são as opções para o 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 Padrão: Novo
ticketType	Obrigatório. O tipo de tíquete. Este valor determina se o registro é criado na tabela Caso [sn_customerservice_case] ou Incidente [incidente]. 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

Códigos de status

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

Tabela 42. Códigos de status

Código de 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. O tipo de ingresso inválido ou o tipo de ingresso não corresponde ao parâmetro de caminho do tipo de ingresso. Por exemplo, o tipo de ingresso é maiúsculas e minúsculas, mas o parâmetro de caminho é incidente.

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

Nome	Descrição
@tipo	Este valor é sempre TroubleTicket. Tipo de dados: cadeia de caracteres
canal	O método de contato pelo qual o tíquete foi criado. Tipo de dados: objeto "channel":{ "name": "String" }
canal.nome	O nome do método de contato. Tipo de dados: cadeia de caracteres
creationDate	A data em que o caso ou registro de incidente foi criado. Tipo de dados: cadeia de caracteres
description	A descrição do problema do tíquete. Tipo de dados: cadeia de caracteres
id	O sys_id do caso ou registro de incidente que foi criado. Tipo de dados: cadeia de caracteres
últimaAtualização	A data em que o registro de 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
anotação	Uma lista dos comentários e anotações de trabalho que foram adicionados ao tíquete pela solicitação POST. Tipo de dados: matriz "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
nota.@tipo	O tipo de anotação. Valores válidos: work_notes comentários Tipo de dados: cadeia de caracteres
nota.autor	O nome do usuário de integração da ServiceNow que fez a solicitação POST que criou a anotação. Tipo de dados: cadeia de caracteres
nota.data	A data em que a anotação foi criada na instância da ServiceNow. Tipo de dados: cadeia de caracteres
nota.texto	O texto da anotação. Tipo de dados: cadeia de caracteres
relatedEntity	Lista de ativos afetados, produtos, produtos vendidos (inventário de produtos), itens de configuração ou serviços. Tipo de dados: matriz "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] Modelo do produto [cmdb_model] Produto vendido [sn_install_base_sold_product] Product Inventory [sn_prd_invt_product_inventory], que estende a tabela Sold Product [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
relatedEntity.@referredType	O 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.@type	Este valor é sempre relatedEntity. Tipo de dados: cadeia de caracteres
relatedParty	Detalhes sobre as empresas e os contatos associados ao tíquete. Tipo de dados: matriz "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	Sys_id da parte relacionada. 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]. Se você fornecer um contato ou usuário (solicitante), a conta ou a empresa dele será preenchida automaticamente no tíquete. Tipo de dados: cadeia de caracteres
relatedParty.referredType	O tipo de parte relacionada. Valores válidos: cliente: a empresa ou a conta do tíquete. customer_contact: o solicitante ou contato do 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 problema. 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 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"
}