API aberta da Gestão de testes de serviços

Versão de lançamento: Xanadu

Atualizado 1 de ago. de 2024

98 min. de leitura

A API aberta da Gestão de testes de serviços fornece endpoints para criar e recuperar definições de teste de serviço e testes de serviço.

Use esta API para gerenciar informações de gestão de problemas de serviço entre sistemas externos e o Now Platform. A API aberta da Gestão de testes de serviços é uma ServiceNow implementação da especificação REST da API da Gestão de problemas do serviço de fóruns TM. Esta implementação é baseada em https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/.

Esta REST API foi projetada para gerenciar e executar testes de serviço em um ambiente de telecomunicações. Ele permite que os usuários definam, acionem e monitorem testes de serviço, garantindo que os serviços atendam aos padrões de qualidade e desempenho. A API fornece capacidades para gerenciamento de testes, incluindo a criação e atualização de definições de teste, execução de testes, recuperação de resultados de testes e gerenciamento de cronogramas de testes.

A API aberta da Gestão de testes de serviços requer o plug-in Customer Service Problem Management (com.sn_sprb_mgmt) e a função sn_sprb_mgmt.test_integrator. Esta API pertence ao namespace sn_sprb_mgmt. Para obter mais informações sobre a Gestão de problemas de serviço. Consulte Customer Service Problem Management para obter mais informações sobre esta aplicação.

A API aberta da Gestão de testes de serviços cria ou atualiza dados nas seguintes tabelas:

Simulação de execução [sn_st_mgmt_test]
Definição de teste de serviço [sn_st_mgmt_test_definition]
Característica de definição de teste [sn_st_mgmt_test_definition_characteristic]
Característica de teste [sn_st_mgmt_test_characteristic]
Especificação para relacionamento de definição de teste [sn_st_mgmt_test_definition_m2m]
Relacionamento de definição de teste [sn_st_mgmt_test_definition_rel]
Medida de teste [sn_st_mgmt_test_measure]
Consequência da medida [sn_st_mgmt_measure_consequence]
Definição de medida de teste [sn_st_mgmt_test_measure_definition]
Consequência aplicada [sn_st_mgmt_applied_consequence]
Regra de limite [sn_st_mgmt_threshold_rule]
Violação de regra de limite [sn_st_mgmt_threshold_rule_violation]

API aberta da Gestão de testes de serviços – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest

Recupera uma lista de todos os testes de serviço.

Formato da URL

URL padrão: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest

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. Se este parâmetro não for usado, todos os campos serão retornados. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Campos válidos: característica descrição endDateTime ID modo relacionadoServiço startDateTime estado testeMeasure especificação de teste validFor 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. Tipo de dados: número Valor máximo: 100 Padrão: 20
deslocamento	Índice inicial no qual os registros serão recuperados. Use este parâmetro para paginar resultados em blocos pequenos e gerenciáveis. O primeiro registro é indexado em 0. Tipo de dados: número Padrão: 0
state	Filtrar definições de teste pelo estado atual do teste. Somente definições de teste no estado especificado são retornadas na resposta. Valores válidos: acknowledged cancelada concluído falha inProgress pendente Rejeitadas Tipo de dados: cadeia de caracteres

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

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum(a)

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á os itens `3-5`.
Tipo de conteúdo	Formato de dados do corpo da resposta. Compatível somente com a aplicação/json.
Link	Contém os links a seguir para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Contagem	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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 6. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
206	Recurso parcial retornado em resposta (com paginação).
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
404	Não encontrado. O item solicitado não foi encontrado.

Tabela 7. Parâmetros do corpo da resposta (XML ou JSON)
Nome	Descrição
característica	Lista que descreve as características do teste de serviço associado. Para obter mais informações sobre as características de definição de teste, consulte Tipo de dados: matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	Sys_id ou external_id das características. Localizado na tabela Características [sn_prd_pm_characteristic]. Se external_id estiver presente para esse registro, a resposta retornará o external_id, caso contrário, retornará o sys_id. Tipo de dados: cadeia de caracteres
characteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
caracter.valor	Opções de característica associadas ao teste de serviço. As características variam de acordo com a instância do cliente. Tipo de dados: cadeia de caracteres
Característica.ValorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
descrição	Descrição do teste de serviço. Tipo de dados: cadeia de caracteres
endDateTime	Data e hora de término do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
href	Referência de hiperlink para o teste de serviço. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id da definição de teste de serviço. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres
modo	O modo em que o teste de serviço está sendo executado. Valores válidos: ONDEMAND - Aciona o teste de serviço manualmente. PROATIVO - aciona o teste de serviço automaticamente. Padrão: ONDEMAND
nome	Obrigatório. Nome do teste de serviço. Tipo de dados: cadeia de caracteres
relacionadoServiço	Obrigatório. A definição de teste associada ao teste de serviço. Tipo de dados: objeto `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relatedService.id	Sys_id ou external_id do inventário de produtos. Localizado no campo sys_id ou external_id da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
relacionadoServiço.nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
startDateTime	Data e hora de início do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
estado	Estado em que o teste de serviço está. Valores válidos: acknowledged cancelada concluído falha inProgress pendente Rejeitadas Tipo de dados: cadeia de caracteres
testeMeasure	Medida de um aspecto específico de um produto, serviço ou teste de recurso, como pacotes perdidos ou status de conectividade. Tipo de dados: matriz de objetos `"testMeasure": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array], "unitOfMeasure": "String", "value": {Object} } ]`
medidaDeTeste.precisão	Valor decimal flutuante que representa a precisão da medida de teste capturada para as métricas associadas. Tipo de dados: número Valor máximo: 40
testMeasure.captureDateTime	A data e a hora em que a métrica foi capturada. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasure.id	Sys_id ou external_id das medidas de teste. Localizado nos campos sys_id ou external_id da tabela Medidas de teste [sn_st_mgmt_test_measure]. Tipo de dados: cadeia de caracteres
medir.teste.Medição.MétodoDeCaptura	Método usado para capturar a métrica. Valores válidos: automático — Captura automaticamente a métrica. manual - Capture manualmente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testeMeasure.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasure.metricName	Nome da métrica de medida de teste. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation	Um objeto para definir uma regra na definição de regra de limite, junto com as consequências se a regra for violada. Tipo de dados: matriz de objetos `"ruleViolation"[ { appliedConsequence: [Array], conformanceTargetUpper: Number, conformanceComparatorUpper: "String", description: "String", id: "String", name: "String", numberOfAllowedCrossing: Number, thresholdRuleSeverity: "String", tolerancePeriod: "String" } ]`
testMeasure.ruleViolation.tolerancePeriod.amount	O número de períodos antes de aplicar a consequência. Tipo de dados: número
testMeasure.ruleViolation.appliedConsequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Tipo de dados: matriz de objetos `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	Ação a ser tomada quando uma regra de limite é violada. Por exemplo, enviar um aviso ou gerar um relatório. As ações aplicadas podem variar entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.description	Descrição da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.id	Sys_id ou external_id da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.name	Nome da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.repeatAction	Sinalizador que indica se a consequência deve ser repetida quando ocorre uma segunda violação. Valores válidos: verdadeiro: repita a ação. falso: Dorepita a ação. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComporatorExact	Sinalizador que indica se um valor é idêntico. Valores válidos: verdadeiro: o valor é idêntico. falso: o valor não é idêntico. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComporatorLower	Operador para verificar se um valor está abaixo do limite. Valores válidos: maior que maior que ou é Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComporatorUpper	Operador para verificar se um valor está acima do limite. Valores válidos: menor que menor que ou é Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testeMeasure.ruleViolation.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testMeasure.ruleViolation.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testeMeasure.ruleViolation.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.id	Sys_id ou external_id da violação da regra de limite. Localizado na tabela Violação de regra de limite [sn_st_mgmt_threshold_rule_violation]. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Valor máximo: 40
testMeasure.ruleViolation.thresholdRuleSeverity	Gravidade da regra de limite. Valores válidos: alto médio baixo Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.tolerancePeriod	Intervalo de tempo especificado durante o qual as ocorrências de cruzamento são habilitadas sem acionar nenhuma ação ou consequência imediata. Tipo de data: objeto `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasure.unitOfMeasure	Especifica a unidade de medida dos valores de meta de conformidade da medida de teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor	O valor da medida de teste. Tipo de dados: objeto `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String }`
testMeasure.value.id	O ID do valor da medida de teste. Tipo de dados: cadeia de caracteres
testMeasure.value.name	O nome do valor da medida de teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor.valor	O valor da medida de teste. Tipo de dados: cadeia de caracteres
testMeasure.value.valueType	O tipo de valor de medida de teste, como numérico, texto e assim por diante. Tipo de dados: cadeia de caracteres
especificação de teste	Obrigatório. A definição de teste associada a este teste. Tipo de dados: objeto `"testSpecification": { "id": "String", "href": "String" }`
testSpecification.href	Referência de hiperlink para a definição de teste de serviço. Tipo de dados: cadeia de caracteres
testSpecification.id	O sys_id ou external_id da definição de teste de serviço. Localizado no campo sys_id ou external_id da tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual o teste de serviço é válido. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	Data de término da validade do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data de início da validade do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir recupera informações sobre os dois testes de serviço na instância.

curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest” \
--user 'username’: ‘password'

Corpo da resposta.

[
  {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/09d1f42e3be28210d140068aa4e45ae2",
    "id": "09d1f42e3be28210d140068aa4e45ae2",
    "description": "Service test",
    "endDateTime": "2025-01-31 15:05:43",
    "mode": "proactive",
    "name": "Speed Test TR0001002",
    "startDateTime": "2024-06-05 09:07:10",
    "validFor": {
      "startDateTime": "",
      "endDateTime": ""
    },
    "relatedService": {
      "id": "fa6d13f45b5620102dff5e92dc81c77f",
      "name": "Internet_VPLS_PI0000011"
    },
    "testSpecification": {
      "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
      "id": "7d3854864316c6500e51203d5fb8f2d8"
    },
    "characteristic": [],
    "testMeasure": [
      {
        "id": "61d1382e3be28210d140068aa4e45a2e",
        "accuracy": "0.0001",
        "captureDateTime": "",
        "captureMethod": "automatic",
        "metricDescription": "",
        "metricName": "Flow speed",
        "unitOfMeasure": "A second",
        "value": "3000",
        "ruleViolation": [
          {
            "id": "61d1382e3be28210d140068aa4e45a2f",
            "description": "This speed is greater than the target",
            "name": "tooMuchTraffic",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "high",
            "tolerancePeriod": "",
            "conformanceTargetLower": "2500",
            "conformanceComparatorLower": "greater than",
            "appliedConsequence": [
              {
                "id": "65d1382e3be28210d140068aa4e45a31",
                "appliedAction": "sendWarning",
                "description": "send a warning to the system",
                "name": "sendWarning",
                "repeatAction": "0"
              }
            ]
          }
        ]
      }
    ]
  },
  {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/18682a2a3b2682107222bf9985e45a55",
    "id": "18682a2a3b2682107222bf9985e45a55",
    "description": "Service test",
    "endDateTime": "2025-01-31 15:05:43",
    "mode": "proactive",
    "name": "Speed Test TR0001012",
    "startDateTime": "2024-06-05 17:45:07",
    "validFor": {
      "startDateTime": "",
      "endDateTime": ""
    },
    "relatedService": {
      "id": "fa6d13f45b5620102dff5e92dc81c77f",
      "name": "Internet_VPLS_PI0000011"
    },
    "testSpecification": {
      "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
      "id": "7d3854864316c6500e51203d5fb8f2d8"
    },
    "characteristic": [
      {
        "id": "5c682a2a3b2682107222bf9985e45a5a",
        "name": "url",
        "valueType": "single_line_text",
        "value": "http://abc.com"
      }
    ],
    "testMeasure": [
      {
        "id": "7c686a2a3b2682107222bf9985e45a4d",
        "accuracy": "0.0001",
        "captureDateTime": "",
        "captureMethod": "automatic",
        "metricDescription": "",
        "metricName": "Flow speed",
        "unitOfMeasure": "A second",
        "value": "3000",
        "ruleViolation": [
          {
            "id": "38686a2a3b2682107222bf9985e45a4e",
            "description": "This speed is greater than the target",
            "name": "tooMuchTraffic",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "high",
            "tolerancePeriod": "",
            "conformanceTargetLower": "2500",
            "conformanceComparatorLower": "greater than",
            "appliedConsequence": [
              {
                "id": "34686a2a3b2682107222bf9985e45a50",
                "appliedAction": "sendWarning",
                "description": "send a warning to the system",
                "name": "sendWarning",
                "repeatAction": "0"
              }
            ]
          }
        ]
      }
    ]
  }
]

API aberta da Gestão de testes de serviços – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

Recupera uma entidade de teste de serviço com base no ID fornecido de um teste de serviço.

Formato da URL

URL padrão: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

Parâmetros de solicitação compatíveis

Tabela 8. Parâmetros de caminho
Nome	Descrição
id	Obrigatório. Sys_id ou external_id do teste de serviço a ser recuperado. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres

Tabela 9. Parâmetros de consulta
Nome	Descrição
Campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Campos válidos: característica descrição endDateTime ID modo relacionadoServiço startDateTime estado testeMeasure especificação de teste validFor Tipo de dados: cadeia de caracteres

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

Cabeçalhos

Tabela 11. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum(a)

Tabela 12. Cabeçalhos de resposta
Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Compatível somente com a aplicação/json.

Códigos de status

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

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

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


Nome	Descrição
característica	Lista que descreve as características do teste de serviço associado. Tipo de dados: matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
Característica.ID	Sys_id ou external_id das características. Localizado na tabela Características [sn_prd_pm_characteristic]. Se external_id estiver presente para esse registro, a resposta retornará o external_id, caso contrário, retornará o sys_id. Tipo de dados: cadeia de caracteres
característica.nome	Nome da característica. Tipo de dados: cadeia de caracteres
caracter.valor	Opções de característica associadas ao teste de serviço. As características variam de acordo com a instância do cliente. Tipo de dados: cadeia de caracteres
Característica.ValorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
descrição	Descrição do teste de serviço. Tipo de dados: cadeia de caracteres
endDateTime	Data e hora de término do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
href	Referência de hiperlink para o teste de serviço. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id da definição de teste de serviço. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres
modo	Modo em que o teste de serviço está sendo executado. Valores válidos: ONDEMAND - Aciona o teste de serviço manualmente. PROATIVO - aciona o teste de serviço automaticamente. Padrão: ONDEMAND
nome	Nome do teste de serviço. Tipo de dados: cadeia de caracteres
relacionadoServiço	Definição de teste associada a este teste. Tipo de dados: objeto `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relatedService.id	O sys_id ou external_id do inventário de produtos. Localizado no campo sys_id ou external_id da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
relacionadoServiço.nome	Nome do item de inventário do produto. Tipo de dados: cadeia de caracteres
startDateTime	Data e hora de início do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
estado	O estado do teste de serviço. Valores válidos: acknowledged cancelada concluído falha inProgress pendente Rejeitadas
testeMeasure	Medida de um aspecto específico de um produto, serviço ou teste de recurso, como pacotes perdidos ou status de conectividade. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array] "unitOfMeasure": "String", "value": {Object} } ]`
medidaDeTeste.precisão	Valor decimal flutuante que representa a precisão da medida de teste capturada para as métricas associadas. Tipo de dados: número Valor máximo: 40
testMeasure.captureDateTime	A data e a hora em que a métrica foi capturada. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasure.captureMethod	Método usado para capturar a métrica. Valores válidos: automático — Captura automaticamente a métrica. manual - Capture manualmente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testeMeasure.id	Sys_id ou external_id da medida de teste. Localizado na tabela Medidas de teste [sn_st_mgmt_test_measure]. Tipo de dados: cadeia de caracteres
testeMeasure.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasure.metricName	Nome de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation	Objeto para definir uma regra na definição de regra de limite, junto com as consequências se a regra for violada. Tipo de dados: matriz de objetos `"RuleViolation": [ { "appliedConsequence": [Array], "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": {Object} } ]`
testMeasure.ruleViolation.appliedConsequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é violada. Tipo de dados: matriz de objetos `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	Ação a ser tomada quando uma regra de limite é violada. Por exemplo, enviar um aviso ou gerar um relatório. As ações aplicadas podem variar entre as instâncias. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction	Sinalizador que indica se a ação aplicada deve ser repetida ou não. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.appliedConsequence.description	Descrição da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.id	Sys_id ou external_id da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.name	Nome da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor de conformanceTargetExact. Valores válidos: verdadeiro: o valor é idêntico. falso: o valor não é idêntico. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComparatorLower	Um operador que verifica se um valor está abaixo do limite. Valores válidos: maior que é Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComparatorUpper	Um operador que verifica se um valor excede o limite. Valores válidos: é menor que Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testeMeasure.ruleViolation.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testMeasure.ruleViolation.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testeMeasure.ruleViolation.description	Descrição da violação da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.id	Sys_id ou external_id da violação da regra de limite. Localizado na tabela Violação de regra de limite [sn_st_mgmt_threshold_rule_violation]. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.name	Nome da violação da regra de limite. Tipo de data: cadeia de caracteres
testMeasure.ruleViolation.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Máximo: 40
testMeasure.ruleViolation.thresholdRuleSeverity	Severidade da regra de limite. Valores válidos: alto baixo médio Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.tolerancePeriod	Duração ou intervalo de tempo em que os cruzamentos permitidos podem ocorrer antes que uma consequência seja iniciada. Tipo de data: objeto `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	Valor do período em número. Tipo de dados: número
testMeasure.ruleViolation.tolerancePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasure.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor	Valor da métrica no teste. Tipo de dados: objeto `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String" }`
testMeasure.value.id	ID do valor da métrica no teste. Tipo de dados: cadeia de caracteres
medida.teste.valor.nome	Nome do valor da métrica no teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor.valor	Valor da métrica no teste. Tipo de dados: cadeia de caracteres
testMeasure.value.valueType	O tipo de valor de medida de teste, como numérico, texto e assim por diante. Tipo de dados: cadeia de caracteres
especificação de teste	Definição de teste associada a este teste. Tipo de dados: objeto `"testSpecification": { "href": "String", "id": "String" }`
testSpecification.href	Referência de hiperlink para a definição de teste de serviço. Tipo de dados: cadeia de caracteres
testSpecification.id	Sys_id ou external_id da definição de teste de serviço. Localizado no campo sys_id ou external_id da tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual o teste de serviço é válido. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
validFor.endDateTime	Data de término e carimbo de data/hora do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data de início e carimbo de data/hora do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir recupera detalhes sobre a entidade de teste de serviço associada ao ID fornecido, 44b7a8ea3b6a42107222bf9985e45a45.

curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45 \
--user 'username’: ‘password'

Corpo da resposta.

{
  "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45",
  "id": "44b7a8ea3b6a42107222bf9985e45a45",
  "description": "Service test",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001001",
  "startDateTime": "2024-06-05 08:22:52",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
    "id": "7d3854864316c6500e51203d5fb8f2d8"
  },
  "characteristic": [
        { 
        "id": "5c682a2a3b2682107222bf9985e45a5a", 
        "name": "url", 
        "valueType": "single_line_text", 
        "value": "test" 
         }
],
  "testMeasure": [
    {
      "id": "62ade42a3ba28210d140068aa4e45a71",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Downstream Speed",
      "unitOfMeasure": "",
      "value": "16",
      "ruleViolation": [
        {
          "id": "b9bee4ae3ba28210d140068aa4e45a3a",
          "description": "This speed is less than the target upper",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "75",
          "conformanceComparatorUpper": "less than",
          "appliedConsequence": [
            {
              "id": "489074aa3be28210d140068aa4e45a42",
              "appliedAction": "generateReport",
              "description": "",
              "name": "generateReport",
              "repeatAction": "0"
            },
            {
              "id": "785f2ce23be28210d140068aa4e45a75",
              "appliedAction": "sendWarning",
              "description": "",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

API aberta da Gestão de testes de serviços - GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

Recupera uma lista de todas as definições de teste de serviço.

Formato da URL

URL padrão: GET /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

Parâmetros de solicitação compatíveis

Tabela 14. Parâmetros de caminho
Nome	Descrição
Nenhum(a)

Tabela 15. Parâmetros de consulta
Nome	Descrição
Campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Localizado na tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Valores válidos: descrição ID nome relatedServiceSpecification serviceTestSpecRelationship especificaçãoCaracterística definiçãoDeMedidaDeTeste validFor 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. Tipo de dados: número Valor máximo: 100 Padrão: 20
deslocamento	Índice inicial no qual os registros serão recuperados. Use este parâmetro para paginar resultados em blocos pequenos e gerenciáveis. O primeiro registro é indexado em 0. Tipo de dados: número Padrão: 0
state	Filtrar definições de teste pelo estado atual do teste. Somente definições de teste no estado especificado são retornadas na resposta. Valores válidos: arquivado rascunho publicado descontinuado Tipo de dados: cadeia de caracteres

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

Cabeçalhos

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

Tabela 18. 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á os itens `3-5`.
Tipo de conteúdo	Formato de dados do corpo da resposta. Compatível somente com a aplicação/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta: primeiro último avançar anterior
X-Total-Contagem	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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 19. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
206	Recurso parcial retornado em resposta (com paginação).
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
404	Não encontrado. O item solicitado não foi encontrado.

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


Nome	Descrição
descrição	Descrição da definição de teste de serviço. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id da definição de teste de serviço. Localizado na tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
nome	Obrigatório. Nome da definição de teste de serviço. Tipo de dados: cadeia de caracteres
relatedServiceSpecification	Obrigatório. Especificações de serviço da definição de teste. Tipo de dados: matriz de objetos `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	Sys_id ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação [sn_prd_pm_specification]. Tipo de dados: cadeia de caracteres
relatedServiceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship	Definição de teste de serviço relacionado. Tipo de dados: matriz de objetos `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	Sys_id ou external_id da definição de teste de serviço relacionado. Localizado no campo sys_id ou external_id da tabela Definição de teste [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.name	Nome da definição de teste relacionada. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.relationshipType	Tipo de relacionamento. Valores aceitos: substituição dependência exclusividade Tipo de dados: cadeia de caracteres
especificaçãoCaracterística	Características da definição de teste. Tipo de dados: matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
especificaçãoCaracterística.característicaEspecificaçãoValor	Matriz que contém os valores possíveis da característica. Tipo de dados: matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
especificaçãoCaracterística.característicaValorEspecificação.valor	Valor da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.descrição	Descrição da característica. Tipo de dados: cadeia de caracteres
specCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.válidoPara	Intervalo de datas para o qual a característica é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
especificaCaracterística.válidoPor.DataTérmino/Hora	Data de término da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.validFor.startDateTime	Data de início da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.valorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
definiçãoDeMedidaDeTeste	Definições de medida de teste para esta definição de teste de serviço. Para obter mais informações, consulte Define test measure definitions for a service test. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	A frequência na qual a métrica será capturada. Valores válidos: nenhum uma vez diariamente semanal mensal Tipo de dados: cadeia de caracteres
testMeasureDefinition.captureMethod	Método usado para capturar a métrica. Valores válidos: automático: capture a métrica automaticamente. manual: capture a métrica manualmente. nenhum: não captura a métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.capturePeriod	Período ou duração da captura de métrica. Tipo de dados: objeto `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	Número de períodos de captura. Tipo de dados: número
testMeasureDefinition.capturePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasureDefinition.id	Sys_id ou external_id das definições de medida de teste. Localizado na tabela de definição da Medida de Teste [sn_st_mgmt_test_measure_definition]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricName	Nome definido pelo usuário de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.name	Nome da definição da medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule	Regra que define condições a serem alcançadas antes de aplicar consequências quando um limite é ultrapassado (ou não ultrapassado) na definição da medida de teste. Para obter mais informações, consulte Define threshold rules for a test measure definition. Tipo de dados: matriz de objetos `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor definido para testMeasureDefinition.thresholdRule.conformanceTargetExact. Se definido como verdadeiro, testMeasureDefinition.thresholdRule.conformanceTargetExact é necessário. Valores válidos: verdadeiro: o valor é idêntico ao valor de conformanceTargetExact. falso: o valor não é idêntico conformanceTargetExact. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.conformanceComparatorLower	Operador que verifica se um valor está abaixo do limite. Valores válidos: maior que maior que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	Operador que verifica se um valor excede o limite. Valores válidos: menor que menor que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.consequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Para obter mais informações, consulte Define measure consequences for the threshold rules. Tipo de dados: matriz de objetos `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	Descrição da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.id	Sys_id ou external_id da consequência da medida. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.name	Nome da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.prescribeAction	Ação definida pelo usuário a ser tomada para violações de limite. As ações variam entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.repeatAction	Sinalizador que indica se a consequência aplicada deve ser repetida. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.consequence.validFor	Intervalo de datas para o qual a consequência é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	Data de término da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	Data de início da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.id	Sys_id ou external_id das regras de limite. Localizado no campo Localizado no sys_id ou external_id da tabela Regras de limite [sn_st_mgmt_threshold_rule]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Valor máximo: 40 Tipo de dados: número
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	Nível de gravidade da regra de limite. Valores válidos: alto médio baixo Tipo de dados: cadeia de caracteres
testMeasureDefinition.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor	Intervalo de datas para o qual a definição da medida de teste é válida. Tipo de dados: cadeia de caracteres `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	Data de término da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor.startDateTime	Data de início da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual a definição de teste é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Data e hora da definição de teste em que o estado dele é descontinuado. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data e hora da definição de teste em que o estado dele é publicado. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera detalhes sobre todas as definições de teste do serviço de teste na instância. Nesse caso, duas definições são retornadas.

curl --location --request GET 
“https://instance.servicenow.com//api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification” \
--user 'username’: ‘password'

Corpo da resposta.

[
  {
    "description": "Operation, Administration and Maintenance",
    "id": "76a3b160432a02104fefe4511fb8f2ad",
    "name": "OAM Test",
    "validFor": {
      "startDateTime": "",
      "endDateTime": ""
    },
    "testMeasureDefinition": [
      {
        "id": "77b9b964432a02104fefe4511fb8f26e",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the Rx signal level",
        "metricName": "Rx Optical Signal Level",
        "name": "Rx Optical Signal Level",
        "unitOfMeasure": "a minute",
        "valueType": "",
        "capturePeriod": "",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "thresholdRule": [
          {
            "id": "d3e97d64432a02104fefe4511fb8f281",
            "description": "",
            "name": "gponOntAniOpInfoRxOpticalSignalLevel",
            "numberOfAllowedCrossing": "",
            "thresholdRuleSeverity": "",
            "tolerancePeriod": "",
            "conformanceTargetUpper": "0",
            "conformanceComparatorUpper": "less than",
            "conformanceTargetLower": "-50",
            "conformanceComparatorLower": "greater than",
            "consequence": []
          }
        ]
      },
      {
        "id": "878afd64432a02104fefe4511fb8f28d",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the Tx signal level",
        "metricName": "TX Optical Signal Level",
        "name": "TX Optical Signal Level",
        "unitOfMeasure": "a minute",
        "valueType": "",
        "capturePeriod": "",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "thresholdRule": [
          {
            "id": "b3dab5a4432a02104fefe4511fb8f2d3",
            "description": "",
            "name": "gponOntAniOpInfoTxOpticalSignalLevel",
            "numberOfAllowedCrossing": "",
            "thresholdRuleSeverity": "",
            "tolerancePeriod": "",
            "conformanceTargetUpper": "65",
            "conformanceComparatorUpper": "less than",
            "conformanceTargetLower": "-65",
            "conformanceComparatorLower": "greater than",
            "consequence": []
          }
        ]
      }
    ],
    "specCharacteristic": [
      {
        "name": "AccessRequired",
        "description": "AccessRequired",
        "valueType": "yes_no",
        "validFor": {
          "startDatetime": "2024-05-30 09:09:57"
        },
        "characteristicValueSpecification": [
          {
            "value": "Yes",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          },
          {
            "value": "No",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          }
        ]
      }
    ],
    "serviceTestSpecRelationship": [],
    "relatedServiceSpecification": [
      {
        "id": "f559b564432a02104fefe4511fb8f2e0",
        "name": "OAM"
      }
    ]
  },
  {
    "description": "Upstream and Downstream speed ",
    "id": "89d2b920432a02104fefe4511fb8f22e",
    "name": "Speed Test",
    "validFor": {
      "startDateTime": "2024-05-31",
      "endDateTime": "2024-06-27"
    },
    "testMeasureDefinition": [
      {
        "id": "1a04f560432a02104fefe4511fb8f2ad",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the downstream speed in a service",
        "metricName": "Downstream Speed",
        "name": "Downstream Speed",
        "unitOfMeasure": "a second",
        "valueType": "",
        "capturePeriod": "30 Minutes",
        "validFor": {
          "startDateTime": "2024-05-30 08:49:26",
          "endDateTime": "2024-05-31 08:49:29"
        },
        "thresholdRule": [
          {
            "id": "a754f960432a02104fefe4511fb8f2d0",
            "description": "This speed is greater than the target upper",
            "name": "InternetSpeedValue",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "high",
            "tolerancePeriod": "15 Minutes",
            "conformanceTargetLower": "75",
            "conformanceComparatorLower": "greater than",
            "consequence": [
              {
                "id": "15a4bd60432a02104fefe4511fb8f2b8",
                "prescribeAction": "null",
                "description": "generate a waring report",
                "name": "degradedQualityOfService",
                "repeatAction": "0",
                "validFor": {
                  "startDateTime": "2024-05-30 08:51:29",
                  "endDateTime": "2024-08-06 08:51:31"
                }
              },
              {
                "id": "e6847d60432a02104fefe4511fb8f2c3",
                "prescribeAction": "null",
                "description": "send a warning to the system",
                "name": "packetdrop",
                "repeatAction": "0",
                "validFor": {
                  "startDateTime": "2024-05-30 08:50:53",
                  "endDateTime": "2024-08-06 08:50:55"
                }
              }
            ]
          },
          {
            "id": "cb55b5a0432a02104fefe4511fb8f201",
            "description": "",
            "name": "InternetSpeedValue",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "medium",
            "tolerancePeriod": "",
            "conformanceTargetUpper": "120",
            "conformanceComparatorUpper": "less than",
            "consequence": []
          }
        ]
      },
      {
        "id": "8f987524432a02104fefe4511fb8f2f0",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the upstream speed in the service",
        "metricName": "Upstream Speed",
        "name": "Upstream Speed",
        "unitOfMeasure": "a second",
        "valueType": "",
        "capturePeriod": "",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "thresholdRule": []
      }
    ],
    "specCharacteristic": [
      {
        "name": "restart",
        "description": "restart",
        "valueType": "yes_no",
        "validFor": {
          "startDatetime": "2024-05-30 08:45:49"
        },
        "characteristicValueSpecification": [
          {
            "value": "No",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          },
          {
            "value": "Yes",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          }
        ]
      }
    ],
    "serviceTestSpecRelationship": [
      {
        "id": "76a3b160432a02104fefe4511fb8f2ad",
        "name": "OAM Test",
        "relationshipType": ""
      }
    ],
    "relatedServiceSpecification": [
      {
        "id": "aeddcd1fb7d69910ff00f203ae11a990",
        "name": "Home Internet"
      }
    ]
  }
]

API aberta da Gestão de testes de serviços - GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

Recupera uma entidade de definição de teste de serviço.

Formato da URL

URL padrão: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

Parâmetros de solicitação compatíveis

Tabela 20. Parâmetros de caminho
Nome	Descrição
id	Obrigatório. Sys_id ou external_id da definição de teste de serviço a ser recuperada. Localizado na tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres

Tabela 21. Parâmetros de consulta
Nome	Descrição
Campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Localizado na tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Valores válidos: descrição ID nome relatedServiceSpecification serviceTestSpecRelationship especificaçãoCaracterística definiçãoDeMedidaDeTeste validFor Tipo de dados: cadeia de caracteres
state	Filtrar definições de teste pelo estado atual do teste. Somente definições de teste no estado especificado são retornadas na resposta. Valores válidos: arquivado rascunho publicado descontinuado Tipo de dados: cadeia de caracteres

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

Cabeçalhos

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

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

Códigos de status

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

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

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


Nome	Descrição
descrição	Descrição da definição de teste de serviço. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id da definição de teste de serviço. Localizado na tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
nome	Obrigatório. Nome da definição de teste de serviço. Tipo de dados: cadeia de caracteres
relatedServiceSpecification	Obrigatório. Especificações de serviço da definição de teste. Tipo de dados: matriz de objetos `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	Sys_id ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação [sn_prd_pm_specification]. Tipo de dados: cadeia de caracteres
relatedServiceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship	Definição de teste de serviço relacionado. Tipo de dados: matriz de objetos `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	Sys_id ou external_id da definição de teste de serviço relacionado. Localizado no campo sys_id ou external_id da tabela Definição de teste [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.name	Nome da definição de teste relacionada. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.relationshipType	Tipo de relacionamento. Valores aceitos: substituição dependência exclusividade Tipo de dados: cadeia de caracteres
especificaçãoCaracterística	Características da definição de teste. Tipo de dados: matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
especificaçãoCaracterística.característicaEspecificaçãoValor	Matriz que contém os valores possíveis da característica. Tipo de dados: matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
especificaçãoCaracterística.característicaValorEspecificação.valor	Valor da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.descrição	Descrição da característica. Tipo de dados: cadeia de caracteres
specCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.válidoPara	Intervalo de datas para o qual a característica é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
especificaCaracterística.válidoPor.DataTérmino/Hora	Data de término da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.validFor.startDateTime	Data de início da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.valorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
definiçãoDeMedidaDeTeste	Definições de medida de teste para esta definição de teste de serviço. Para obter mais informações, consulte Define test measure definitions for a service test. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	A frequência na qual a métrica será capturada. Valores válidos: nenhum uma vez diariamente semanal mensal Tipo de dados: cadeia de caracteres
testMeasureDefinition.captureMethod	Método usado para capturar a métrica. Valores válidos: automático: capture a métrica automaticamente. manual: capture a métrica manualmente. nenhum: não captura a métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.capturePeriod	Período ou duração da captura de métrica. Tipo de dados: objeto `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	Número de períodos de captura. Tipo de dados: número
testMeasureDefinition.capturePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasureDefinition.id	Sys_id ou external_id das definições de medida de teste. Localizado na tabela de definição da Medida de Teste [sn_st_mgmt_test_measure_definition]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricName	Nome definido pelo usuário de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.name	Nome da definição da medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule	Regra que define condições a serem alcançadas antes de aplicar consequências quando um limite é ultrapassado (ou não ultrapassado) na definição da medida de teste. Para obter mais informações, consulte Define threshold rules for a test measure definition. Tipo de dados: matriz de objetos `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor definido para testMeasureDefinition.thresholdRule.conformanceTargetExact. Se definido como verdadeiro, testMeasureDefinition.thresholdRule.conformanceTargetExact é necessário. Valores válidos: verdadeiro: o valor é idêntico ao valor de conformanceTargetExact. falso: o valor não é idêntico conformanceTargetExact. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.conformanceComparatorLower	Operador que verifica se um valor está abaixo do limite. Valores válidos: maior que maior que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	Operador que verifica se um valor excede o limite. Valores válidos: menor que menor que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.consequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Para obter mais informações, consulte Define measure consequences for the threshold rules. Tipo de dados: matriz de objetos `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	Descrição da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.id	Sys_id ou external_id da consequência da medida. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.name	Nome da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.prescribeAction	Ação definida pelo usuário a ser tomada para violações de limite. As ações variam entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.repeatAction	Sinalizador que indica se a consequência aplicada deve ser repetida. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.consequence.validFor	Intervalo de datas para o qual a consequência é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	Data de término da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	Data de início da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.id	Sys_id ou external_id das regras de limite. Localizado no campo Localizado no sys_id ou external_id da tabela Regras de limite [sn_st_mgmt_threshold_rule]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Valor máximo: 40 Tipo de dados: número
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	Nível de gravidade da regra de limite. Valores válidos: alto médio baixo Tipo de dados: cadeia de caracteres
testMeasureDefinition.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor	Intervalo de datas para o qual a definição da medida de teste é válida. Tipo de dados: cadeia de caracteres `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	Data de término da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor.startDateTime	Data de início da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual a definição de teste é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Data e hora da definição de teste em que o estado dele é descontinuado. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data e hora da definição de teste em que o estado dele é publicado. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera detalhes de uma definição de teste de serviço com um determinado ID.

curl --location --request GET "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e" \
--user 'username’: ‘password'

Corpo da resposta.

{
  "description": "Upstream and Downstream speed ",
  "id": "89d2b920432a02104fefe4511fb8f22e",
  "name": "Speed Test",
  "validFor": {
    "startDateTime": "2024-05-31",
    "endDateTime": "2024-06-27"
  },
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      },
      "characteristicValueSpecification": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        }
      ]
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

API aberta da Gestão de testes de serviços - PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

Atualiza uma entidade de teste de serviço.

Formato da URL

URL padrão: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

Parâmetros de solicitação compatíveis

Tabela 26. Parâmetros de caminho
Nome	Descrição
id	Obrigatório. Sys_id ou external_id do teste de serviço a ser recuperado. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres

Tabela 27. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 28. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
característica	Lista que descreve as características do teste de serviço associado. Para obter mais informações sobre as características de definição de teste, consulte Tipo de dados: matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	Sys_id ou external_id das características. Localizado na tabela Características [sn_prd_pm_characteristic]. Se external_id estiver presente para esse registro, a resposta retornará o external_id, caso contrário, retornará o sys_id. Tipo de dados: cadeia de caracteres
characteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
caracter.valor	Opções de característica associadas ao teste de serviço. As características variam de acordo com a instância do cliente. Tipo de dados: cadeia de caracteres
Característica.ValorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
descrição	Descrição do teste de serviço. Tipo de dados: cadeia de caracteres
endDateTime	Data e hora de término do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
modo	O modo em que o teste de serviço está sendo executado. Valores válidos: ONDEMAND - Aciona o teste de serviço manualmente. PROATIVO - aciona o teste de serviço automaticamente. Padrão: ONDEMAND
nome	Obrigatório. Nome do teste de serviço. Tipo de dados: cadeia de caracteres
relacionadoServiço	Obrigatório. A definição de teste associada ao teste de serviço. Tipo de dados: objeto `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relacionadoServiço.href	Referência de hiperlink para o serviço relacionado. Tipo de dados: cadeia de caracteres
relatedService.id	Sys_id ou external_id do inventário de produtos. Localizado no campo sys_id ou external_id da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
startDateTime	Data e hora de início do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
estado	Estado em que o teste de serviço está. Valores válidos: acknowledged cancelada concluído falha inProgress pendente Rejeitadas Tipo de dados: cadeia de caracteres
testeMeasure	Medida de um aspecto específico de um produto, serviço ou teste de recurso, como pacotes perdidos ou status de conectividade. Tipo de dados: matriz de objetos `"testMeasure": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array], "unitOfMeasure": "String", "value": {Object} } ]`
medidaDeTeste.precisão	Valor decimal flutuante que representa a precisão da medida de teste capturada para as métricas associadas. Tipo de dados: número Valor máximo: 40
testMeasure.captureDateTime	A data e a hora em que a métrica foi capturada. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasure.id	Sys_id ou external_id das medidas de teste. Localizado nos campos sys_id ou external_id da tabela Medidas de teste [sn_st_mgmt_test_measure]. Tipo de dados: cadeia de caracteres
medir.teste.Medição.MétodoDeCaptura	Método usado para capturar a métrica. Valores válidos: automático — Captura automaticamente a métrica. manual - Capture manualmente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testeMeasure.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasure.metricName	Nome da métrica de medida de teste. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation	Um objeto para definir uma regra na definição de regra de limite, junto com as consequências se a regra for violada. Tipo de dados: matriz de objetos `"ruleViolation"[ { appliedConsequence: [Array], conformanceTargetUpper: Number, conformanceComparatorUpper: "String", description: "String", id: "String", name: "String", numberOfAllowedCrossing: Number, thresholdRuleSeverity: "String", tolerancePeriod: "String" } ]`
testMeasure.ruleViolation.tolerancePeriod.amount	O número de períodos antes de aplicar a consequência. Tipo de dados: número
testMeasure.ruleViolation.appliedConsequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Tipo de dados: matriz de objetos `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	Ação a ser tomada quando uma regra de limite é violada. Por exemplo, enviar um aviso ou gerar um relatório. As ações aplicadas podem variar entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.description	Descrição da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.id	Sys_id ou external_id da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.name	Nome da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.repeatAction	Sinalizador que indica se a consequência deve ser repetida quando ocorre uma segunda violação. Valores válidos: verdadeiro: repita a ação. falso: Dorepita a ação. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComporatorExact	Sinalizador que indica se um valor é idêntico. Valores válidos: verdadeiro: o valor é idêntico. falso: o valor não é idêntico. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComporatorLower	Operador para verificar se um valor está abaixo do limite. Valores válidos: maior que maior que ou é Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComporatorUpper	Operador para verificar se um valor está acima do limite. Valores válidos: menor que menor que ou é Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testeMeasure.ruleViolation.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testMeasure.ruleViolation.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testeMeasure.ruleViolation.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.id	Sys_id ou external_id da violação da regra de limite. Localizado na tabela Violação de regra de limite [sn_st_mgmt_threshold_rule_violation]. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Valor máximo: 40
testMeasure.ruleViolation.thresholdRuleSeverity	Gravidade da regra de limite. Valores válidos: alto médio baixo Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.tolerancePeriod	Intervalo de tempo especificado durante o qual as ocorrências de cruzamento são habilitadas sem acionar nenhuma ação ou consequência imediata. Tipo de data: objeto `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasure.unitOfMeasure	Especifica a unidade de medida dos valores de meta de conformidade da medida de teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor	O valor da medida de teste. Tipo de dados: objeto `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String }`
testMeasure.value.id	O ID do valor da medida de teste. Tipo de dados: cadeia de caracteres
testMeasure.value.name	O nome do valor da medida de teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor.valor	O valor da medida de teste. Tipo de dados: cadeia de caracteres
testMeasure.value.valueType	O tipo de valor de medida de teste, como numérico, texto e assim por diante. Tipo de dados: cadeia de caracteres
especificação de teste	Obrigatório. A definição de teste associada a este teste. Tipo de dados: objeto `"testSpecification": { "id": "String", "href": "String" }`
testSpecification.href	Referência de hiperlink para a definição de teste de serviço. Tipo de dados: cadeia de caracteres
testSpecification.id	O sys_id ou external_id da definição de teste de serviço. Localizado no campo sys_id ou external_id da tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual o teste de serviço é válido. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	Data de término da validade do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data de início da validade do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

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

Códigos de status

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

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

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


Nome	Descrição
característica	Lista que descreve as características do teste de serviço associado. Tipo de dados: matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
Característica.ID	Sys_id ou external_id das características. Localizado na tabela Características [sn_prd_pm_characteristic]. Se external_id estiver presente para esse registro, a resposta retornará o external_id, caso contrário, retornará o sys_id. Tipo de dados: cadeia de caracteres
característica.nome	Nome da característica. Tipo de dados: cadeia de caracteres
caracter.valor	Opções de característica associadas ao teste de serviço. As características variam de acordo com a instância do cliente. Tipo de dados: cadeia de caracteres
Característica.ValorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
descrição	Descrição do teste de serviço. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id da definição de teste de serviço. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres
nome	Nome do teste de serviço. Tipo de dados: cadeia de caracteres
relacionadoServiço	Definição de teste associada a este teste. Tipo de dados: objeto `"relatedService": { "href": "string", "id": "String", "name": "String" }`
relatedService.id	Sys_id ou external_id do inventário de produtos. Localizado no campo sys_id ou external_id da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
relacionadoServiço.nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
testeMeasure	Medida de um aspecto específico de um produto, serviço ou teste de recurso, como pacotes perdidos ou status de conectividade. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array] "unitOfMeasure": "String", "value": {Object} } ]`
medidaDeTeste.precisão	Valor decimal flutuante que representa a precisão da medida de teste capturada para as métricas associadas. Tipo de dados: número Valor máximo: 40
testMeasure.captureDateTime	A data e a hora em que a métrica foi capturada. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasure.captureMethod	Método usado para capturar a métrica. Valores válidos: automático — Captura automaticamente a métrica. manual - Capture manualmente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testeMeasure.id	Sys_id ou external_id da medida de teste. Localizado na tabela Medidas de teste [sn_st_mgmt_test_measure]. Tipo de dados: cadeia de caracteres
testeMeasure.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasure.metricName	Nome de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation	Objeto para definir uma regra na definição de regra de limite, junto com as consequências se a regra for violada. Tipo de dados: matriz de objetos `"RuleViolation": [ { "appliedConsequence": [Array], "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": {Object} } ]`
testMeasure.ruleViolation.appliedConsequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é violada. Tipo de dados: matriz de objetos `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	Ação a ser tomada quando uma regra de limite é violada. Por exemplo, enviar um aviso ou gerar um relatório. As ações aplicadas podem variar entre as instâncias. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction	Sinalizador que indica se a ação aplicada deve ser repetida ou não. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.appliedConsequence.description	Descrição da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.id	Sys_id ou external_id da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.name	Nome da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor de conformanceTargetExact. Valores válidos: verdadeiro: o valor é idêntico. falso: o valor não é idêntico. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComparatorLower	Um operador que verifica se um valor está abaixo do limite. Valores válidos: maior que é Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComparatorUpper	Um operador que verifica se um valor excede o limite. Valores válidos: é menor que Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testeMeasure.ruleViolation.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testMeasure.ruleViolation.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testeMeasure.ruleViolation.description	Descrição da violação da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.id	Sys_id ou external_id da violação da regra de limite. Localizado na tabela Violação de regra de limite [sn_st_mgmt_threshold_rule_violation]. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Máximo: 40
testMeasure.ruleViolation.thresholdRuleSeverity	Severidade da regra de limite. Valores válidos: alto baixo médio Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.tolerancePeriod	Duração ou intervalo de tempo em que os cruzamentos permitidos podem ocorrer antes que uma consequência seja iniciada. Tipo de data: objeto `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	Valor do período em número. Tipo de dados: número
testMeasure.ruleViolation.tolerancePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasure.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor	Valor da métrica no teste. Tipo de dados: objeto `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String" }`
testMeasure.value.id	ID do valor da métrica no teste. Tipo de dados: cadeia de caracteres
medida.teste.valor.nome	Nome do valor da métrica no teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor.valor	Valor da métrica no teste. Tipo de dados: cadeia de caracteres
testMeasure.value.valueType	O tipo de valor de medida de teste, como numérico, texto e assim por diante. Tipo de dados: cadeia de caracteres
especificação de teste	Definição de teste associada a este teste. Tipo de dados: objeto `"testSpecification": { "href": "String", "id": "String" }`
testSpecification.href	Referência de hiperlink para a definição de teste de serviço. Tipo de dados: cadeia de caracteres
testSpecification.id	Sys_id ou external_id da definição de teste de serviço. Localizado no campo sys_id ou external_id da tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual o teste de serviço é válido. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
validFor.endDateTime	Data de término e carimbo de data/hora do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data de início e carimbo de data/hora do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir atualiza a entidade de teste de serviço fornecida de acordo com os detalhes fornecidos no corpo da solicitação.

curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/2b406ec043b202104fefe4511fb8f211" \ 
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'
--data {
  "description": "Service test description",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "No"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

A resposta mostra uma atualização bem-sucedida retornando as informações modificadas no serviço de teste fornecido.

{
  "description": "Service test description",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "yes"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

API aberta da Gestão de testes de serviços - PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

Permite atualizações parciais de uma entidade de definição de teste de serviço.

Formato da URL

URL padrão: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

Parâmetros de solicitação compatíveis

Tabela 32. Parâmetros de caminho
Nome	Descrição
id	Obrigatório. Sys_id ou external_id da definição de teste de serviço a ser recuperada. Localizado na tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres

Tabela 33. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 34. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
descrição	Descrição da definição de teste de serviço. Tipo de dados: cadeia de caracteres
nome	Obrigatório. Nome da definição de teste de serviço. Tipo de dados: cadeia de caracteres
relatedServiceSpecification	Obrigatório. Especificações de serviço da definição de teste. Tipo de dados: matriz de objetos `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	Sys_id ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação [sn_prd_pm_specification]. Tipo de dados: cadeia de caracteres
relatedServiceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship	Definição de teste de serviço relacionado. Tipo de dados: matriz de objetos `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	Sys_id ou external_id da definição de teste de serviço relacionado. Localizado no campo sys_id ou external_id da tabela Definição de teste [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.name	Nome da definição de teste relacionada. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.relationshipType	Tipo de relacionamento. Valores aceitos: substituição dependência exclusividade Tipo de dados: cadeia de caracteres
especificaçãoCaracterística	Características da definição de teste. Tipo de dados: matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
especificaçãoCaracterística.característicaEspecificaçãoValor	Matriz que contém os valores possíveis da característica. Tipo de dados: matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
especificaçãoCaracterística.característicaValorEspecificação.valor	Valor da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.descrição	Descrição da característica. Tipo de dados: cadeia de caracteres
specCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.válidoPara	Intervalo de datas para o qual a característica é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
especificaCaracterística.válidoPor.DataTérmino/Hora	Data de término da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.validFor.startDateTime	Data de início da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.valorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
definiçãoDeMedidaDeTeste	Definições de medida de teste para esta definição de teste de serviço. Para obter mais informações, consulte Define test measure definitions for a service test. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	A frequência na qual a métrica será capturada. Valores válidos: nenhum uma vez diariamente semanal mensal Tipo de dados: cadeia de caracteres
testMeasureDefinition.captureMethod	Método usado para capturar a métrica. Valores válidos: automático: capture a métrica automaticamente. manual: capture a métrica manualmente. nenhum: não captura a métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.capturePeriod	Período ou duração da captura de métrica. Tipo de dados: objeto `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	Número de períodos de captura. Tipo de dados: número
testMeasureDefinition.capturePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasureDefinition.id	Sys_id ou external_id das definições de medida de teste. Localizado na tabela de definição da Medida de Teste [sn_st_mgmt_test_measure_definition]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricName	Nome definido pelo usuário de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.name	Nome da definição da medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule	Regra que define condições a serem alcançadas antes de aplicar consequências quando um limite é ultrapassado (ou não ultrapassado) na definição da medida de teste. Para obter mais informações, consulte Define threshold rules for a test measure definition. Tipo de dados: matriz de objetos `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor definido para testMeasureDefinition.thresholdRule.conformanceTargetExact. Se definido como verdadeiro, testMeasureDefinition.thresholdRule.conformanceTargetExact é necessário. Valores válidos: verdadeiro: o valor é idêntico ao valor de conformanceTargetExact. falso: o valor não é idêntico conformanceTargetExact. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.conformanceComparatorLower	Operador que verifica se um valor está abaixo do limite. Valores válidos: maior que maior que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	Operador que verifica se um valor excede o limite. Valores válidos: menor que menor que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.consequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Para obter mais informações, consulte Define measure consequences for the threshold rules. Tipo de dados: matriz de objetos `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	Descrição da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.id	Sys_id ou external_id da consequência da medida. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.name	Nome da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.prescribeAction	Ação definida pelo usuário a ser tomada para violações de limite. As ações variam entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.repeatAction	Sinalizador que indica se a consequência aplicada deve ser repetida. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.consequence.validFor	Intervalo de datas para o qual a consequência é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	Data de término da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	Data de início da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.id	Sys_id ou external_id das regras de limite. Localizado no campo Localizado no sys_id ou external_id da tabela Regras de limite [sn_st_mgmt_threshold_rule]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Valor máximo: 40 Tipo de dados: número
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	Nível de gravidade da regra de limite. Valores válidos: alto médio baixo Tipo de dados: cadeia de caracteres
testMeasureDefinition.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor	Intervalo de datas para o qual a definição da medida de teste é válida. Tipo de dados: cadeia de caracteres `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	Data de término da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor.startDateTime	Data de início da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Cabeçalhos

Tabela 35. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 36. Cabeçalhos de resposta
Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Compatível somente com a aplicação/json.

Códigos de status

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

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

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


Nome	Descrição
descrição	Descrição da definição de teste de serviço. Tipo de dados: cadeia de caracteres
ID	O sys_id ou external_id da definição de teste de serviço. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres
nome	Nome da definição de teste de serviço. Tipo de dados: cadeia de caracteres
relatedServiceSpecification	Especificações de serviço para as definições de teste. Tipo de dados: matriz de objetos `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	O sys_id ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação [sn_prd_pm_specification]. Tipo de dados: cadeia de caracteres
relatedServiceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship	Definição de teste de serviço relacionado. Tipo de dados: matriz de objetos `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	Sys_id ou external_id da definição de teste de serviço relacionado. Localizado no campo sys_id ou external_id da tabela Definição de teste [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.name	Nome da definição de teste relacionada. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.relationshipType	Tipo de relacionamento. Valores aceitos: substituição dependência exclusividade Tipo de dados: cadeia de caracteres
especificaçãoCaracterística	Características da definição de teste. Tipo de dados: matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]`
especificaçãoCaracterística.característicaEspecificaçãoValor	Matriz que contém os valores possíveis da característica. Tipo de dados: matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
especificaçãoCaracterística.característicaValorEspecificação.valor	Valor da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.descrição	Descrição da característica. Tipo de dados: cadeia de caracteres
especCaracterística.nome	Nome da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.válidoPara	Intervalo de datas para o qual a característica é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
especificaCaracterística.válidoPor.DataTérmino/Hora	Data de término da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.validFor.startDateTime	Data de início da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.valorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
definiçãoDeMedidaDeTeste	Definições de medida de teste para esta definição de teste de serviço. Para obter mais informações, consulte Define test measure definitions for a service test. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	A frequência na qual a métrica será capturada. Valores válidos: diariamente mensal nenhum uma vez semanal Tipo de dados: cadeia de caracteres
testMeasureDefinition.captureMethod	Método usado para capturar a métrica. Valores válidos: manual - Capture manualmente a métrica. automático — Captura automaticamente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.capturePeriod	Uma duração ou período da captura. Tipo de dados: objeto `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	Número de períodos de captura. Tipo de dados: número
testMeasureDefinition.capturePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasureDefinition.id	Sys_id ou external_id das definições da Medida de Teste. Localizado na tabela de definição da Medida de Teste [sn_st_mgmt_test_measure_definition]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricName	Nome definido pelo usuário de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.name	Nome da definição da medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule	Regra que define a condição (criar ou limpar) a ser aplicada para aplicar consequências quando um limite é ultrapassado ou deixou de ser ultrapassado para uma definição de medida de teste específica. Tipo de dados: matriz de objetos `{ "thresholdRule": { "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor de conformanceTargetExact. Valores válidos: verdadeiro: o valor é idêntico ao valor de conformanceTargetExact. falso: o valor não é idêntico conformanceTargetExact. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.conformanceComparatorLower	Operador que verifica se um valor está abaixo do limite. Valores válidos: maior que é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	Operador que verifica se um valor excede o limite. Valores válidos: menor que é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.consequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Tipo de dados: matriz de objetos `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	Descrição da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.id	Sys_id ou external_id da consequência da medida. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.name	Nome da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.prescribeAction	Ação definida pelo usuário a ser tomada para violações de limite. As ações variam entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.repeatAction	Sinalizador que indica se a ação aplicada deve ser repetida ou não. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.consequence.validFor	Intervalo de datas para o qual a consequência é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	Data de término da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	Data de início da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.id	Sys_id ou external_id das regras de limite. Localizado na tabela Regras de limite [sn_st_mgmt_threshold_rule]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Valor máximo: 40
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	Gravidade da regra de limite. Valores válidos: alto baixo médio Tipo de dados: cadeia de caracteres
testMeasureDefinition.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor	Intervalo de datas para o qual a definição da medida de teste é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	Data de término da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor.startDateTime	Data de início da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir atualiza parcialmente o ID de definição de teste de serviço fornecido de acordo com as modificações fornecidas no corpo da solicitação.

curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e " 
--request PATCH
--header "Accept:application/json" 
--user 'username':'password'
--data {
  "description": "Upstream and Downstream speed ",
  "name": "This is my new Speed Test",
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      }
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

O corpo da resposta retorna a parte atualizada da especificação de teste de serviço:

{
  "description": "Upstream and Downstream speed ",
  "name": "This is my new Speed Test",
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      }
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

API aberta da Gestão de testes de serviços - POST /sn_sprb_mgmt/servicetestmanagement/serviceTest

Cria um teste de serviço.

Formato da URL

URL padrão: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest

Parâmetros de solicitação compatíveis

Tabela 38. Parâmetros de caminho
Nome	Descrição
Nenhum(a)

Tabela 39. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 40. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
característica	Lista que descreve as características do teste de serviço associado. Para obter mais informações sobre as características de definição de teste, consulte Tipo de dados: matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	Sys_id ou external_id das características. Localizado na tabela Características [sn_prd_pm_characteristic]. Se external_id estiver presente para esse registro, a resposta retornará o external_id, caso contrário, retornará o sys_id. Tipo de dados: cadeia de caracteres
characteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
caracter.valor	Opções de característica associadas ao teste de serviço. As características variam de acordo com a instância do cliente. Tipo de dados: cadeia de caracteres
Característica.ValorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
descrição	Descrição do teste de serviço. Tipo de dados: cadeia de caracteres
endDateTime	Data e hora de término do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id do teste de serviço. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Este ID cria um teste de serviço e é usado como external_id. Tipo de dados: cadeia de caracteres
modo	O modo em que o teste de serviço está sendo executado. Valores válidos: ONDEMAND - Aciona o teste de serviço manualmente. PROATIVO - aciona o teste de serviço automaticamente. Padrão: ONDEMAND
nome	Obrigatório. Nome do teste de serviço. Tipo de dados: cadeia de caracteres
relacionadoServiço	Obrigatório. A definição de teste associada ao teste de serviço. Tipo de dados: objeto `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relacionadoServiço.href	Referência de hiperlink para o serviço relacionado. Tipo de dados: cadeia de caracteres
relatedService.id	Sys_id ou external_id do inventário de produtos. Localizado no campo sys_id ou external_id da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
relatedService.name	Nome do item de inventário do produto. Tipo de dados: cadeia de caracteres
startDateTime	Data e hora de início do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
estado	Estado em que o teste de serviço está. Valores válidos: acknowledged cancelada concluído falha inProgress pendente Rejeitadas Tipo de dados: cadeia de caracteres
testeMeasure	Medida de um aspecto específico de um produto, serviço ou teste de recurso, como pacotes perdidos ou status de conectividade. Tipo de dados: matriz de objetos `"testMeasure": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array], "unitOfMeasure": "String", "value": {Object} } ]`
medidaDeTeste.precisão	Valor decimal flutuante que representa a precisão da medida de teste capturada para as métricas associadas. Tipo de dados: número Valor máximo: 40
testMeasure.captureDateTime	A data e a hora em que a métrica foi capturada. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasure.id	Sys_id ou external_id das medidas de teste. Localizado nos campos sys_id ou external_id da tabela Medidas de teste [sn_st_mgmt_test_measure]. Tipo de dados: cadeia de caracteres
medir.teste.Medição.MétodoDeCaptura	Método usado para capturar a métrica. Valores válidos: automático — Captura automaticamente a métrica. manual - Capture manualmente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testeMeasure.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasure.metricName	Nome da métrica de medida de teste. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation	Um objeto para definir uma regra na definição de regra de limite, junto com as consequências se a regra for violada. Tipo de dados: matriz de objetos `"ruleViolation"[ { appliedConsequence: [Array], conformanceTargetUpper: Number, conformanceComparatorUpper: "String", description: "String", id: "String", name: "String", numberOfAllowedCrossing: Number, thresholdRuleSeverity: "String", tolerancePeriod: "String" } ]`
testMeasure.ruleViolation.appliedConsequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Tipo de dados: matriz de objetos `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	Ação a ser tomada quando uma regra de limite é violada. Por exemplo, enviar um aviso ou gerar um relatório. As ações aplicadas podem variar entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.description	Descrição da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.id	Sys_id ou external_id da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.name	Nome da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.repeatAction	Sinalizador que indica se a consequência deve ser repetida quando ocorre uma segunda violação. Valores válidos: verdadeiro: repita a ação. falso: Dorepita a ação. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComporatorExact	Sinalizador que indica se um valor é idêntico. Valores válidos: verdadeiro: o valor é idêntico. falso: o valor não é idêntico. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComporatorLower	Operador para verificar se um valor está abaixo do limite. Valores válidos: maior que maior que ou é Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComporatorUpper	Operador para verificar se um valor está acima do limite. Valores válidos: menor que menor que ou é Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testeMeasure.ruleViolation.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testMeasure.ruleViolation.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testeMeasure.ruleViolation.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.id	Sys_id ou external_id da violação da regra de limite. Localizado na tabela Violação de regra de limite [sn_st_mgmt_threshold_rule_violation]. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Valor máximo: 40
testMeasure.ruleViolation.thresholdRuleSeverity	Gravidade da regra de limite. Valores válidos: alto médio baixo Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.tolerancePeriod	Intervalo de tempo especificado durante o qual as ocorrências de cruzamento são habilitadas sem acionar nenhuma ação ou consequência imediata. Tipo de data: objeto `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	O número de períodos antes de aplicar a consequência. Tipo de dados: número
testMeasure.ruleViolation.tolerancePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasure.unitOfMeasure	Especifica a unidade de medida dos valores de meta de conformidade da medida de teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor	O valor da medida de teste. Tipo de dados: objeto `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String }`
testMeasure.value.id	O ID do valor da medida de teste. Tipo de dados: cadeia de caracteres
testMeasure.value.name	O nome do valor da medida de teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor.valor	O valor da medida de teste. Tipo de dados: cadeia de caracteres
testMeasure.value.valueType	O tipo de valor de medida de teste, como numérico, texto e assim por diante. Tipo de dados: cadeia de caracteres
especificação de teste	Obrigatório. A definição de teste associada a este teste. Tipo de dados: objeto `"testSpecification": { "id": "String", "href": "String" }`
testSpecification.href	Referência de hiperlink para a definição de teste de serviço. Tipo de dados: cadeia de caracteres
testSpecification.id	O sys_id ou external_id da definição de teste de serviço. Localizado no campo sys_id ou external_id da tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual o teste de serviço é válido. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	Data de término da validade do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data de início da validade do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

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

Códigos de status

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

Tabela 43. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.

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


Nome	Descrição
característica	Lista que descreve as características do teste de serviço associado. Tipo de dados: matriz de objetos `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
Característica.ID	Sys_id ou external_id das características. Localizado na tabela Características [sn_prd_pm_characteristic]. Se external_id estiver presente para esse registro, a resposta retornará o external_id, caso contrário, retornará o sys_id. Tipo de dados: cadeia de caracteres
característica.nome	Nome da característica. Tipo de dados: cadeia de caracteres
caracter.valor	Opções de característica associadas ao teste de serviço. As características variam de acordo com a instância do cliente. Tipo de dados: cadeia de caracteres
Característica.ValorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
descrição	Descrição do teste de serviço. Tipo de dados: cadeia de caracteres
endDateTime	Data e hora de término do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id da definição de teste de serviço. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres
modo	Modo em que o teste de serviço está sendo executado. Valores válidos: ONDEMAND - Aciona o teste de serviço manualmente. PROATIVO - aciona o teste de serviço automaticamente. Padrão: ONDEMAND
nome	Nome do teste de serviço. Tipo de dados: cadeia de caracteres
relacionadoServiço	Definição de teste associada a este teste. Tipo de dados: objeto `"relatedService": { "href": "string", "id": "String", "name": "String" }`
relatedService.id	Sys_id ou external_id do inventário de produtos. Localizado no campo sys_id ou external_id da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
relacionadoServiço.nome	Nome do inventário do produto. Tipo de dados: cadeia de caracteres
startDateTime	Data e hora de início do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
estado	O estado do teste de serviço. Valores válidos: acknowledged cancelada concluído falha inProgress pendente Rejeitadas
testeMeasure	Medida de um aspecto específico de um produto, serviço ou teste de recurso, como pacotes perdidos ou status de conectividade. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array] "unitOfMeasure": "String", "value": {Object} } ]`
medidaDeTeste.precisão	Valor decimal flutuante que representa a precisão da medida de teste capturada para as métricas associadas. Tipo de dados: número Valor máximo: 40
testMeasure.captureDateTime	A data e a hora em que a métrica foi capturada. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasure.captureMethod	Método usado para capturar a métrica. Valores válidos: automático — Captura automaticamente a métrica. manual - Capture manualmente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testeMeasure.id	Sys_id ou external_id da medida de teste. Localizado na tabela Medidas de teste [sn_st_mgmt_test_measure]. Tipo de dados: cadeia de caracteres
testeMeasure.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasure.metricName	Nome de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation	Objeto para definir uma regra na definição de regra de limite, junto com as consequências se a regra for violada. Tipo de dados: matriz de objetos `"RuleViolation": [ { "appliedConsequence": [Array], "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": {Object} } ]`
testMeasure.ruleViolation.appliedConsequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é violada. Tipo de dados: matriz de objetos `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	Ação a ser tomada quando uma regra de limite é violada. Por exemplo, enviar um aviso ou gerar um relatório. As ações aplicadas podem variar entre as instâncias. Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction	Sinalizador que indica se a ação aplicada deve ser repetida ou não. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.appliedConsequence.description	Descrição da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.id	Sys_id ou external_id da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.appliedConsequence.name	Nome da consequência aplicada. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor de conformanceTargetExact. Valores válidos: verdadeiro: o valor é idêntico. falso: o valor não é idêntico. Tipo de dados: booliano Padrão: falso
testMeasure.ruleViolation.conformanceComparatorLower	Um operador que verifica se um valor está abaixo do limite. Valores válidos: maior que é Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.conformanceComparatorUpper	Um operador que verifica se um valor excede o limite. Valores válidos: é menor que Tipo de dados: cadeia de caracteres
testeMeasure.ruleViolation.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testeMeasure.ruleViolation.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testMeasure.ruleViolation.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Determina se o limite foi ultrapassado ou não. Tipo de dados: número
testeMeasure.ruleViolation.description	Descrição da violação da regra de limite. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.id	Sys_id ou external_id da violação da regra de limite. Localizado na tabela Violação de regra de limite [sn_st_mgmt_threshold_rule_violation]. Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.name	Nome da violação da regra de limite. Tipo de data: cadeia de caracteres
testMeasure.ruleViolation.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Máximo: 40
testMeasure.ruleViolation.thresholdRuleSeverity	Severidade da regra de limite. Valores válidos: alto baixo médio Tipo de dados: cadeia de caracteres
testMeasure.ruleViolation.tolerancePeriod	Duração ou intervalo de tempo em que os cruzamentos permitidos podem ocorrer antes que uma consequência seja iniciada. Tipo de data: objeto `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	Valor do período em número. Tipo de dados: número
testMeasure.ruleViolation.tolerancePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasure.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor	Valor da métrica no teste. Tipo de dados: objeto `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String" }`
testMeasure.value.id	ID do valor da métrica no teste. Tipo de dados: cadeia de caracteres
medida.teste.valor.nome	Nome do valor da métrica no teste. Tipo de dados: cadeia de caracteres
medida.teste.valor.nome	Nome do valor da métrica no teste. Tipo de dados: cadeia de caracteres
medidaDeTeste.valor.valor	Valor da métrica no teste. Tipo de dados: cadeia de caracteres
testMeasure.value.valueType	O tipo de valor de medida de teste, como numérico, texto e assim por diante. Tipo de dados: cadeia de caracteres
especificação de teste	Definição de teste associada a este teste. Tipo de dados: objeto `"testSpecification": { "href": "String", "id": "String" }`
testSpecification.href	Referência de hiperlink para a definição de teste de serviço. Tipo de dados: cadeia de caracteres
testSpecification.id	Sys_id ou external_id da definição de teste de serviço. Localizado no campo sys_id ou external_id da tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual o teste de serviço é válido. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
validFor.endDateTime	Data de término e carimbo de data/hora do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data de início e carimbo de data/hora do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir cria um novo teste de serviço de acordo com os detalhes específicos fornecidos no corpo da solicitação.

curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data {
  "description": "Service test",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "Yes"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

A resposta retorna detalhes de confirmação sobre o novo serviço de teste e atribui a ele um ID exclusivo, 2b406ec043b202104fefe4511fb8f211:

{
  "description": "Service test",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "Yes"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ],
  "id": "2b406ec043b202104fefe4511fb8f211"
}

API aberta da Gestão de testes de serviços - POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

Cria uma nova definição de teste de serviço.

Formato da URL

URL padrão: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

Parâmetros de solicitação compatíveis

Tabela 44. Parâmetros de caminho
Nome	Descrição
Nenhum(a)

Tabela 45. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 46. Parâmetros do corpo da solicitação (XML ou JSON)
Nome	Descrição
descrição	Descrição da definição de teste de serviço. Tipo de dados: cadeia de caracteres
ID	Sys_id ou external_id da definição de teste de serviço. Localizado na tabela Definição de teste de serviço [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
nome	Obrigatório. Nome da definição de teste de serviço. Tipo de dados: cadeia de caracteres
relatedServiceSpecification	Obrigatório. Especificações de serviço da definição de teste. Tipo de dados: matriz de objetos `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	Sys_id ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação [sn_prd_pm_specification]. Tipo de dados: cadeia de caracteres
relatedServiceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship	A definição de teste de serviço relacionado. Tipo de dados: matriz de objetos `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	Sys_id ou external_id da definição de teste de serviço relacionado. Localizado no campo sys_id ou external_id da tabela Definição de teste [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.name	Nome da definição de teste relacionada. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.relationshipType	Tipo de relacionamento. Valores aceitos: substituição dependência exclusividade Tipo de dados: cadeia de caracteres
especificaçãoCaracterística	Características da definição de teste. Tipo de dados: matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
especificaçãoCaracterística.característicaEspecificaçãoValor	Matriz que contém os valores possíveis da característica. Tipo de dados: matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
especificaçãoCaracterística.característicaValorEspecificação.valor	Valor da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.descrição	Descrição da característica. Tipo de dados: cadeia de caracteres
specCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.válidoPara	Intervalo de datas para o qual a característica é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
especificaCaracterística.válidoPor.DataTérmino/Hora	Data de término da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.validFor.startDateTime	Data de início da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.valorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
definiçãoDeMedidaDeTeste	Definições de medida de teste para esta definição de teste de serviço. Para obter mais informações, consulte Define test measure definitions for a service test. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	A frequência na qual a métrica será capturada. Valores válidos: nenhum uma vez diariamente semanal mensal Tipo de dados: cadeia de caracteres
testMeasureDefinition.captureMethod	Método usado para capturar a métrica. Valores válidos: automático: capture a métrica automaticamente. manual: capture a métrica manualmente. nenhum: não captura a métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.capturePeriod	Período ou duração da captura de métrica. Tipo de dados: objeto `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	Número de períodos de captura. Tipo de dados: número
testMeasureDefinition.capturePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasureDefinition.id	Sys_id ou external_id das definições de medida de teste. Localizado na tabela de definição da Medida de Teste [sn_st_mgmt_test_measure_definition]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricName	Nome definido pelo usuário de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.name	Nome da definição da medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule	Regra que define condições a serem alcançadas antes de aplicar consequências quando um limite é ultrapassado (ou não ultrapassado) na definição da medida de teste. Para obter mais informações, consulte Define threshold rules for a test measure definition. Tipo de dados: matriz de objetos `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor definido para testMeasureDefinition.thresholdRule.conformanceTargetExact. Se definido como verdadeiro, testMeasureDefinition.thresholdRule.conformanceTargetExact é necessário. Valores válidos: verdadeiro: o valor é idêntico ao valor de conformanceTargetExact. falso: o valor não é idêntico conformanceTargetExact. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.conformanceComparatorLower	Operador que verifica se um valor está abaixo do limite. Valores válidos: maior que maior que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	Operador que verifica se um valor excede o limite. Valores válidos: menor que menor que ou é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.consequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Para obter mais informações, consulte Define measure consequences for the threshold rules. Tipo de dados: matriz de objetos `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	Descrição da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.id	Sys_id ou external_id da consequência da medida. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.name	Nome da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.prescribeAction	Ação definida pelo usuário a ser tomada para violações de limite. As ações variam entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.repeatAction	Sinalizador que indica se a consequência aplicada deve ser repetida. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.consequence.validFor	Intervalo de datas para o qual a consequência é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	Data de término da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	Data de início da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.id	Sys_id ou external_id das regras de limite. Localizado no campo Localizado no sys_id ou external_id da tabela Regras de limite [sn_st_mgmt_threshold_rule]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Valor máximo: 40 Tipo de dados: número
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	Nível de gravidade da regra de limite. Valores válidos: alto médio baixo Tipo de dados: cadeia de caracteres
testMeasureDefinition.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor	Intervalo de datas para o qual a definição da medida de teste é válida. Tipo de dados: cadeia de caracteres `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	Data de término da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor.startDateTime	Data de início da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual a definição de teste é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Data e hora da definição de teste em que o estado dele é descontinuado. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data e hora da definição de teste em que o estado dele é publicado. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Cabeçalhos

Tabela 47. 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 48. Cabeçalhos de resposta
Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Compatível somente com a aplicação/json.

Códigos de status

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

Tabela 49. Códigos de status
Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.

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


Nome	Descrição
descrição	Descrição da definição de teste de serviço. Tipo de dados: cadeia de caracteres
ID	O sys_id ou external_id da definição de teste de serviço. Localizado na tabela Teste de serviço [sn_st_mgmt_test]. Tipo de dados: cadeia de caracteres
nome	Nome da definição de teste de serviço. Tipo de dados: cadeia de caracteres
relatedServiceSpecification	Especificações de serviço para as definições de teste. Tipo de dados: matriz de objetos `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	O sys_id ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação [sn_prd_pm_specification]. Tipo de dados: cadeia de caracteres
relatedServiceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship	Definição de teste de serviço relacionado. Tipo de dados: matriz de objetos `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	Sys_id ou external_id da definição de teste de serviço relacionado. Localizado no campo sys_id ou external_id da tabela Definição de teste [sn_st_mgmt_test_definition]. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.name	Nome da definição de teste relacionada. Tipo de dados: cadeia de caracteres
serviceTestSpecRelationship.relationshipType	Tipo de relacionamento. Valores aceitos: substituição dependência exclusividade Tipo de dados: cadeia de caracteres
especificaçãoCaracterística	Características da definição de teste. Tipo de dados: matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]`
especificaçãoCaracterística.característicaEspecificaçãoValor	Matriz que contém os valores possíveis da característica. Tipo de dados: matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
especificaçãoCaracterística.característicaValorEspecificação.valor	Valor da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.descrição	Descrição da característica. Tipo de dados: cadeia de caracteres
especCaracterística.nome	Nome da característica. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.válidoPara	Intervalo de datas para o qual a característica é válida. Tipo de dados: objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
especificaCaracterística.válidoPor.DataTérmino/Hora	Data de término da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.validFor.startDateTime	Data de início da característica. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
especificaçãoCaracterística.valorTipo	Tipo de valor de característica. sim/não escolha data data/hora duração e-mail rótulo teste de linha única Tipo de dados: cadeia de caracteres
definiçãoDeMedidaDeTeste	Definições de medida de teste para esta definição de teste de serviço. Para obter mais informações, consulte Define test measure definitions for a service test. Tipo de dados: matriz de objetos `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	A frequência na qual a métrica será capturada. Valores válidos: diariamente mensal nenhum uma vez semanal Tipo de dados: cadeia de caracteres
testMeasureDefinition.captureMethod	Método usado para capturar a métrica. Valores válidos: manual - Capture manualmente a métrica. automático — Captura automaticamente a métrica. nenhum - Não captura a métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.capturePeriod	Uma duração ou período da captura. Tipo de dados: objeto `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	Número de períodos de captura. Tipo de dados: número
testMeasureDefinition.capturePeriod.units	Unidades do período. Valores aceitos: segundos minutos dias horas Tipo de dados: cadeia de caracteres
testMeasureDefinition.id	Sys_id ou external_id das definições da Medida de Teste. Localizado na tabela de definição da Medida de Teste [sn_st_mgmt_test_measure_definition]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricDescription	Breve descrição da métrica. Tipo de dados: cadeia de caracteres
testMeasureDefinition.metricName	Nome definido pelo usuário de uma métrica na medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.name	Nome da definição da medida de teste. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule	Regra que define a condição (criar ou limpar) a ser aplicada para aplicar consequências quando um limite é ultrapassado ou deixou de ser ultrapassado para uma definição de medida de teste específica. Tipo de dados: matriz de objetos `{ "thresholdRule": { "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	Sinalizador que indica se um valor é idêntico ao valor de conformanceTargetExact. Valores válidos: verdadeiro: o valor é idêntico ao valor de conformanceTargetExact. falso: o valor não é idêntico conformanceTargetExact. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.conformanceComparatorLower	Operador que verifica se um valor está abaixo do limite. Valores válidos: maior que é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	Operador que verifica se um valor excede o limite. Valores válidos: menor que é Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.conformanceTargetExact	Obrigatório se conformanceComparatorExact estiver definido como verdadeiro. Se o valor conformanceComparatorExact estiver definido como verdadeiro, seu valor corresponderá ao valor definido em conformanceTargetExact. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetLower	Valor de limite inferior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.conformanceTargetUpper	Valor de limite superior para comparar os resultados da medida de teste. Tipo de dados: número
testMeasureDefinition.thresholdRule.consequence	Ação (ação prescrita ou notificação) a ser tomada quando uma regra de limite é ultrapassada. Tipo de dados: matriz de objetos `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	Descrição da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.id	Sys_id ou external_id da consequência da medida. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.name	Nome da consequência. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.prescribeAction	Ação definida pelo usuário a ser tomada para violações de limite. As ações variam entre as instâncias. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.repeatAction	Sinalizador que indica se a ação aplicada deve ser repetida ou não. Valores válidos: verdadeiro: repete a ação. falso: não repete a ação. Tipo de dados: booliano Padrão: falso
testMeasureDefinition.thresholdRule.consequence.validFor	Intervalo de datas para o qual a consequência é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	Data de término da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	Data de início da validade da consequência. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.description	Descrição da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.id	Sys_id ou external_id das regras de limite. Localizado na tabela Regras de limite [sn_st_mgmt_threshold_rule]. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.name	Nome da regra de limite. Tipo de dados: cadeia de caracteres
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	Máximo de cruzamentos permitidos dentro do período de tolerância antes que as consequências sejam aplicadas. Tipo de dados: número Valor máximo: 40
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	Gravidade da regra de limite. Valores válidos: alto baixo médio Tipo de dados: cadeia de caracteres
testMeasureDefinition.unitOfMeasure	Valor mensurável de tempo usado para calcular o desempenho de um serviço em dias, minutos e segundos. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor	Intervalo de datas para o qual a definição da medida de teste é válida. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	Data de término da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
testMeasureDefinition.validFor.startDateTime	Data de início da validade da definição da medida de teste. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor	Intervalo de datas para o qual o teste de serviço é válido. Tipo de dados: objeto `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	Data e hora de término do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres
validFor.startDateTime	Data e hora de início do teste de serviço. Formato: AAAA-MM-DD 00:00:00. Por exemplo, `2025-01-31 09:35:43`. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir cria uma nova definição de teste de serviço.

curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
-- data {
  "description": "Upstream and Downstream speed ",
  "name": "Speed Test",
  "validFor": {
    "startDateTime": "2024-05-31",
    "endDateTime": "2024-06-27"
  },
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      },
      "characteristicValueSpecification": [
        {
          "value": "No",
        },
        {
          "value": "Yes",
        }
      ]
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

Corpo da resposta.

{
  "description": "Upstream and Downstream speed ",  
  "name": "Speed Test",
  "validFor": {
    "startDateTime": "2024-05-31",
    "endDateTime": "2024-06-27"
  },
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      },
      "characteristicValueSpecification": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        }
      ]
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
  "id": "89d2b920432a02104fefe4511fb8f22e"
}