Qualificação de serviço técnico em aberto API

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

53 min. de leitura

. Qualificação de serviço técnico em aberto A API fornece endpoints para verificar a disponibilidade de recursos e serviços antes de enviar pedidos para execução.

Esta API é um ServiceNow Implementação da especificação REST da API de qualificação de serviço TMF645. Para obter mais informações sobre solicitações de qualificação de serviço, consulte Service qualification requests.

. Qualificação de serviço técnico em aberto A API é fornecida no sn_ord_qual_mgmt namespace e requer os seguintes plug-ins:

Gestão de catálogo de produtos Core [com.sn_prd_pm]
Catálogo de produtos avançado [com.sn_prd_pm_adv]
Gestão de qualificação de pedido [com.sn_ord_qual_mgmt]
Gestão de pedidos para telecomunicações, mídia e tecnologia [com.sn_tmt_core]
Telecom Core [com.sn_tmt_core]

A função sn_ind_tmt_orn.order_integrator é necessária para usar esta API.

API aberta de Qualificação de serviço técnico - OBTER sn_ord_qual_mgmt/qualification/checkServiceQualification/id)

Recupera uma solicitação de qualificação técnica associada a um determinado ID de pedido do cliente.

Este endpoint recupera informações do pedido das seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]

Formato de URL

URL padrão: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
id	Sys_id da ordem do cliente de qualificação a ser recuperada. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]

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

Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

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

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

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

Códigos de status

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

Tabela 6. Códigos de status

200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
404	Não encontrado. O item solicitado não foi encontrado.

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


Nome	Descrição
id	Sys_id da ordem do cliente de qualificação. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
href	Link relativo para o registro do pedido de qualificação. Tipo de dados: Cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida no campo short_description da ordem de venda. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
externalId	ID externo da ordem de venda. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Ordem do cliente [sn_ind_tmt_orn_order].
QualificationResult	Status de qualificação do campo de resultado da ordem de venda. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de venda no campo de status da ordem de venda. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
VerificarServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
EfectiQualitionDate	Data de qualificação efetiva obtida do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistente no campo expected_end_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
RelatedParty	Lista de contatos da solicitação de qualificação. Cada contato é um objeto na matriz. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Tipo de dados: Cadeia de caracteres Tabela: Tabela Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer]
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para o contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
ServiceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre local, informações de serviço e características de serviço. Armazenado como itens de linha do pedido para a ordem do cliente. Tipo de dados: Matriz de objetos `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualificationItem.id	ID do item de qualificação. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
ServiceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "Resultado" do item de linha da ordem do cliente. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.Quantidade	Quantidade do item de qualificação derivado do campo "Quantidade" do item de linha do pedido do cliente. Tipo de dados: Número Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem. No tipo	Padrão de API aberta do TMF. Anotação para o item de qualificação. Este valor é sempre ServiceQualificationItem . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service	Informações de serviço que incluem detalhes sobre local (local), especificações de serviço e características de serviço. Tipo de dados: Objeto `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Op. Da TMF Padrão de API en. Anotação para o serviço. Este valor é sempre `Serviço` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place	Informações de local para o item de qualificação de serviço. Tipo de dados: Matriz de objetos Nota: Esta matriz pode conter apenas um local. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id do local. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
serviceQualificationItem.service.place.name	Nome do local. Não verificado em relação a uma entrada na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place.@type	Padrão de API aberta do TMF. Anotação para serviço. Este valor é sempre `GeographicSite` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification	Detalhes da especificação do serviço para o item de qualificação. Tipo de dados: Matriz de objetos `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	ID externo ou versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação do serviço. Tipo de dados: Número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Padrão de API aberta do TMF. Anotação para Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic	Lista de características de serviço. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Tipo de valor da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.value	Valor da característica. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal	Proposta de serviço alternativo para a ordem de qualificação. Tipo de dados: Cadeia de caracteres Armazenado em: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.id	Sys_id do registro de proposta alternativa. Tipo de dados: Cadeia de caracteres Tabela: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alterneServiceProposal.alterneServiceAvailabilityDate	O valor do campo available_date da entrada de proposta alternativa na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alterneServiceProposal.alterneService	Informações de serviço representadas pela proposta alternativa. Tipo de dados: Objeto
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	A especificação de serviço da proposta alternativa persistia na especificação. Tipo de dados: Objeto Tabela: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	ID externo ou versão inicial da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Nome da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Versão externa da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação de serviço alternativo. Tipo de dados: Número
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Versão inicial da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type	Padrão de API aberta do TMF. Anotação para Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic	Lista de características de serviço para a proposta de serviço alternativo. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Tipo de valor da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Nome da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Valor da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityMoason	Lista de motivos de indisponibilidade de qualificação do serviço para explicar por que o serviço não está disponível. Tipo de dados: Matriz Armazenado em: O campo inavailability_reason da tabela Ordem de domínio [sn_ind_tmt_orn_domain_order].
ServiceQualificationItem.eligibilityInavailabilityMoason.code	Código do motivo de indisponibilidade da qualificação do serviço. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityReason.label	Rótulo do motivo de indisponibilidade da qualificação do serviço. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

O exemplo a seguir recupera uma ordem de qualificação específica inteira associada a um determinado sys_id de uma ordem de cliente de qualificação.

curl -location --request GET "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/4b5aa0a538b31110f877c8d44c4b8947" \ 
--user "username":"password"

Resposta:

[
  {
    "id": "001b359545371150f877e0588eca21ca",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/001b359545371150f877e0588eca21ca",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": "Sally Thomas",
        "@type": "RelatedParty",
        "@referredType": "CustomerContact"
      },
      {
        "id": "ffc68911c35420105252716b7d40dd55",
        "name": "Funco Intl",
        "@type": "RelatedParty",
        "@referredType": "Customer"
      },
      {
        "id": "59f16de1c3b67110ff00ed23a140dd9e",
        "name": "Funco External",
        "@type": "RelatedParty",
        "@referredType": "Consumer"
      }
    ],
    "serviceSpecification": {
      "id": "91478553b7969910ff00f203ae11a97d",
      "name": "Broadband Service",
      "version": "",
      "internalVersion": "1",
      "internalId": "91478553b7969910ff00f203ae11a97d",
      "@type": "ServiceSpecification"
    },
    "place": {
      "id": "5671dd2ec3a53010188473ce3640dd81",
      "name": "3000 Main Street, Santa Clara, CA",
      "@referredType": "GeographicSite"
    },
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
  },
  {
    "id": "0236b75145fb1150f877e0588eca2145",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0236b75145fb1150f877e0588eca2145",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-15T08:57:50.000Z",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": "Sally Thomas",
        "@type": "RelatedParty",
        "@referredType": "CustomerContact"
      },
      {
        "id": "ffc68911c35420105252716b7d40dd55",
        "name": "Funco Intl",
        "@type": "RelatedParty",
        "@referredType": "Customer"
      },
      {
        "id": "59f16de1c3b67110ff00ed23a140dd9e",
        "name": "Funco External",
        "@type": "RelatedParty",
        "@referredType": "Consumer"
      }
    ],
    "serviceQualificationItem": [
      {
        "id": "110",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Fiber Speed",
              "valueType": "choice",
              "value": "1Gbps"
            }
          ],
          "serviceSpecification": {
            "id": "4d2b5799457b1150f877e0588eca2116",
            "name": "CFS3",
            "version": "",
            "internalVersion": "1",
            "internalId": "4d2b5799457b1150f877e0588eca2116",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "130",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Wireless Speed",
              "valueType": "choice",
              "value": "100 Mbps"
            }
          ],
          "serviceSpecification": {
            "id": "28733d1d45f31150f877e0588eca2163",
            "name": "CFS2",
            "version": "",
            "internalVersion": "1",
            "internalId": "28733d1d45f31150f877e0588eca2163",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "100",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Speed",
              "valueType": "choice",
              "value": ""
            }
          ],
          "serviceSpecification": {
            "id": "b3933d9d45f31150f877e0588eca21fc",
            "name": "Access Service",
            "version": "",
            "internalVersion": "1",
            "internalId": "b3933d9d45f31150f877e0588eca21fc",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "120",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "DSL Speed",
              "valueType": "choice",
              "value": "500 Mbps"
            }
          ],
          "serviceSpecification": {
            "id": "1d43f91d45f31150f877e0588eca21cd",
            "name": "CFS1",
            "version": "",
            "internalVersion": "1",
            "internalId": "1d43f91d45f31150f877e0588eca21cd",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      }
    ],
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
  }
]

API aberta de qualificação de serviço técnico - OBTER sn_ord_qual_mgmt/qualification/checkServiceQualification

Recupera uma lista de todas as solicitações de qualificação técnica.

Este endpoint recupera informações do pedido das seguintes tabelas:

Pedido do cliente [sn_ind_tmt_orn_order]
Item de linha do pedido [sn_ind_tmt_orn_order_line_item]

Este endpoint retorna 20 registros por padrão, mas pode retornar no máximo 100 registros. Use filtros de consulta para restringir os resultados de acordo com status, nome(s) de campo(s), descrição e resultado de qualificação.

Formato de URL

URL padrão: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

Parâmetros de solicitação compatíveis

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

Tabela 8. Consulta Parâmetros
Parâmetro	Descrição
descrição	Filtra os pedidos de qualificação pelo campo "short_description" da ordem do cliente. Apenas pedidos com uma descrição resumida correspondente o valor deste parâmetro é retornado na resposta. Tipo de dados: Cadeia de caracteres
campos	Lista de nomes de campos a serem retornados em resposta e. Campos inválidos são ignorados. Se este parâmetro não for fornecido na solicitação, todos os campos serão retornados. Tipo de dados: Cadeia de caracteres, separados por vírgulas
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use parâmetro de deslocamento paginar recuperação de registro. Padrão: 20 Máximo: 100 Tipo de dados: Número
QualificationResult	Filtra ordens de qualificação por resultado. Somente pedidos com um resultado correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres
estado	Filtra ordens de qualificação por estado. Somente pedidos com um estado correspondente ao valor deste os parâmetros são retornados na resposta. Tipo de dados: Cadeia de caracteres

Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

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

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

Códigos de status

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

Tabela 12. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na resposta (com paginação).
400	Solicitação incorreta. Possíveis motivos: Parâmetro de caminho inválido URI inválido
404	Nenhum registro encontrado para os critérios de filtro.

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


Nome	Descrição
id	Sys_id da ordem do cliente de qualificação. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
href	Link relativo para o registro do pedido de qualificação. Tipo de dados: Cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida no campo short_description da ordem de venda. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
externalId	ID externo da ordem de venda. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Ordem do cliente [sn_ind_tmt_orn_order].
QualificationResult	Status de qualificação do campo de resultado da ordem de venda. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de venda no campo de status da ordem de venda. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
VerificarServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
EfectiQualitionDate	Data de qualificação efetiva obtida do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistente no campo expected_end_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
RelatedParty	Lista de contatos da solicitação de qualificação. Cada contato é um objeto na matriz. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Tipo de dados: Cadeia de caracteres Tabela: Tabela Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer]
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para o contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
ServiceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre local, informações de serviço e características de serviço. Armazenado como itens de linha do pedido para a ordem do cliente. Tipo de dados: Matriz de objetos `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualificationItem.id	ID do item de qualificação. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
ServiceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "Resultado" do item de linha da ordem do cliente. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.Quantidade	Quantidade do item de qualificação derivado do campo "Quantidade" do item de linha do pedido do cliente. Tipo de dados: Número Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem. No tipo	Padrão de API aberta do TMF. Anotação para o item de qualificação. Este valor é sempre ServiceQualificationItem . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service	Informações de serviço que incluem detalhes sobre local (local), especificações de serviço e características de serviço. Tipo de dados: Objeto `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Op. Da TMF Padrão de API en. Anotação para o serviço. Este valor é sempre `Serviço` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place	Informações de local para o item de qualificação de serviço. Tipo de dados: Matriz de objetos Nota: Esta matriz pode conter apenas um local. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id do local. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
serviceQualificationItem.service.place.name	Nome do local. Não verificado em relação a uma entrada na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place.@type	Padrão de API aberta do TMF. Anotação para serviço. Este valor é sempre `GeographicSite` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification	Detalhes da especificação do serviço para o item de qualificação. Tipo de dados: Matriz de objetos `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	ID externo ou versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação do serviço. Tipo de dados: Número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Padrão de API aberta do TMF. Anotação para Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic	Lista de características de serviço. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Tipo de valor da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.value	Valor da característica. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal	Proposta de serviço alternativo para a ordem de qualificação. Tipo de dados: Cadeia de caracteres Armazenado em: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.id	Sys_id do registro de proposta alternativa. Tipo de dados: Cadeia de caracteres Tabela: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alterneServiceProposal.alterneServiceAvailabilityDate	O valor do campo available_date da entrada de proposta alternativa na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alterneServiceProposal.alterneService	Informações de serviço representadas pela proposta alternativa. Tipo de dados: Objeto
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	A especificação de serviço da proposta alternativa persistia na especificação. Tipo de dados: Objeto Tabela: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	ID externo ou versão inicial da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Nome da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Versão externa da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação de serviço alternativo. Tipo de dados: Número
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Versão inicial da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type	Padrão de API aberta do TMF. Anotação para Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic	Lista de características de serviço para a proposta de serviço alternativo. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Tipo de valor da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Nome da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Valor da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityMoason	Lista de motivos de indisponibilidade de qualificação do serviço para explicar por que o serviço não está disponível. Tipo de dados: Matriz Armazenado em: O campo inavailability_reason da tabela Ordem de domínio [sn_ind_tmt_orn_domain_order].
ServiceQualificationItem.eligibilityInavailabilityMoason.code	Código do motivo de indisponibilidade da qualificação do serviço. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityReason.label	Rótulo do motivo de indisponibilidade da qualificação do serviço. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

A chamada GET a seguir recupera todos os pedidos de qualificação de uma instância.

curl -location --request GET "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification" \ 
--user "username":"password"

Resposta:

[{
        "id": "001b359545371150f877e0588eca21ca",
        "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/001b359545371150f877e0588eca21ca",
        "description": "check service qualification illustration",
        "externalId": "CSQ1",
        "qualificationResult": "none",
        "state": "new",
        "@type": "CheckServiceQualification",
        "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
        "relatedParty": [{
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            },
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            },
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
        ],
        "serviceSpecification": {
            "id": "91478553b7969910ff00f203ae11a97d",
            "name": "Broadband Service",
            "version": "",
            "internalVersion": "1",
            "internalId": "91478553b7969910ff00f203ae11a97d",
            "@type": "ServiceSpecification"
        },
        "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
        }
    }
}],
"expectedQualificationDate": "2022-10-11T15:20:39.000Z"
}, {
    "id": "0236b75145fb1150f877e0588eca2145",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0236b75145fb1150f877e0588eca2145",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-15T08:57:50.000Z",
    "relatedParty": [{
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        }
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
    ],
    "serviceQualificationItem": [{
            "id": "110",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Fiber Speed",
                    "valueType": "choice",
                    "value": "1Gbps"
                }],
                "serviceSpecification": {
                    "id": "4d2b5799457b1150f877e0588eca2116",
                    "name": "CFS3",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "4d2b5799457b1150f877e0588eca2116",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "130",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Wireless Speed",
                    "valueType": "choice",
                    "value": "100 Mbps"
                }],
                "serviceSpecification": {
                    "id": "28733d1d45f31150f877e0588eca2163",
                    "name": "CFS2",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "28733d1d45f31150f877e0588eca2163",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Speed",
                    "valueType": "choice",
                    "value": ""
                }],
                "serviceSpecification": {
                    "id": "b3933d9d45f31150f877e0588eca21fc",
                    "name": "Access Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "b3933d9d45f31150f877e0588eca21fc",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "120",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "DSL Speed",
                    "valueType": "choice",
                    "value": "500 Mbps"
                }],
                "serviceSpecification": {
                    "id": "1d43f91d45f31150f877e0588eca21cd",
                    "name": "CFS1",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "1d43f91d45f31150f877e0588eca21cd",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
}
]

API aberta de qualificação de serviço técnico - POST sn_ord_qual_mgmt/qualification/checkServiceQualification

Cria uma entidade de solicitação de qualificação de serviço técnico que contém uma lista de itens de qualificação.

A solicitação de qualificação de serviço persiste como um pedido do cliente com o tipo de execução Qualificar. Cada item de qualificação persiste como um pedido de linha do cliente na tabela pedido [sn_ind_tmt_ORM_order_line_item].

Usando este endpoint

Você pode usar este método de API para três casos de uso específicos:

Solicitação para qualificar um serviço em um endereço especificado.
Solicitação para qualificar um novo serviço no mesmo local de um serviço de acesso existente e ativo.
Solicitação para fazer upgrade ou downgrade de um serviço existente.

Cada caso de uso requer a mesma estrutura de solicitação, mas usa parâmetros de solicitação diferentes. Detalhes sobre cada caso de uso e parâmetros aceitos são fornecidos:

Para qualificar um serviço em um endereço especificado, use placematriz ( serviceQualificationItem.service.place)fornecer um local específico e a especificação do serviço. Opcionalmente, você pode definir características de serviço adicionais em sua solicitação.
Para qualificar um novo serviço no mesmo local de um serviço existente e ativo, use referenceServiceInventoryObjeto (serviceQualificationItem.service.referenceServiceInventory) em vez de placematriz. Este objeto permite criar uma solicitação e definir especificações de serviço sem precisar fornecer detalhes do local. Opcionalmente, você pode definir características de serviço adicionais em sua solicitação.
Para fazer upgrade ou downgrade de um serviço existente, use serviceInventoryObjeto (serviceQualificationItem.service.ServiceInventory) em vez de placematriz ou referenceServiceInventoryobjeto. Neste caso de uso, as informações de local e os detalhes de especificação são obtidos de um serviço existente. Em sua solicitação, defina todas as características de serviço que você deseja mudar.
Por exemplo, digamos que você deseja verificar se pode fazer upgrade da velocidade de download de um serviço ativo existente de 100 Mb/s para 600 MB/s. Nesse caso, você pode usar serviceInventoryParâmetro para definir a solicitação alterando a característica "Velocidade" de "Baixa" para "Alta". A API obtém as características restantes do serviço existente.

Para entender como formar sua solicitação de API de acordo com seu caso de uso específico, consulte as chamadas de exemplo fornecidas em Exemplo desta página.

Formato de URL

URL padrão: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

Parâmetros de solicitação compatíveis

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

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

Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
Parâmetro	Descrição
.	Opcional. Padrão de API aberta do TMF. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
VerificarServiceQualificationDate	Opcional. A data e a hora em que a solicitação de qualificação foi criada. Localizado no campo order_date da tabela Ordem do cliente [sn_ind_tmt_orn_order]. Se não for especificado, order_date será definido como a data e hora atuais. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ
descrição	Opcional. A descrição da solicitação de qualificação. Localizado no campo "short_description" da tabela Ordem do cliente [sn_ind_tmt_ORM_order]. Tipo de dados: Cadeia de caracteres Tamanho máximo de caracteres: 100
EfectiQualitionDate	Opcional. A data em que a qualificação entra em vigor. Persistente no campo "actual_end_date" da ordem do cliente da tabela Ordem do cliente [sn_ind_tmt_orn_order]. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ
ExpectedQualificationDate	Opcional. A data de qualificação esperada. Persistente no campo expected_end_date' da ordem do cliente. Localizado na tabela Ordem do cliente [sn_ind_tmt_orn_order]. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ
externalId	Opcional. ID externo atribuído da ordem do cliente. Persistente no campo external_id da ordem do cliente da tabela Ordem do cliente [sn_ind_tmt_ORM_order]. Tipo de dados: Cadeia de caracteres
RelatedParty	Lista de contatos da solicitação de qualificação. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contém informações da conta do cliente, do contato do cliente ou da conta do consumidor. Tipo de dados: Matriz de objetos `"relatedParty": [ { "@referredType": "String", "@type": "String", "id": "String", "name": "String" } ]`
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: cliente cliente Contato do cliente Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Opcional. Padrão de API aberta do TMF. Anotação para o contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
relatedParty.id	O sys_id ou external_id, se aplicável, da parte relacionada. Localizado na tabela Conta [customer_account], na tabela Contato [customer_contact] ou na tabela Consumidor [csm_consumer]. Tipo de dados: Cadeia de caracteres
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem	Lista de itens de qualificação de serviço com local, informações de serviço e características. Armazenado como itens de linha do pedido para a ordem do cliente. Deve incluir pelo menos um item de qualificação de serviço na lista. Tipo de dados: Matriz de objetos `"serviceQualificationItem": [{ "@type": "String", "id": "String", "qualificationResult": "String", "quantity": "Number", "service": {Object}, "state": "String" ]`
ServiceQualificationItem. No tipo	Opcional. Padrão de API aberta do TMF. Anotação para item de qualificação. Este valor é sempre `ServiceQualificationItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.qualificationItemRelationship	Opcional. Lista de relacionamentos com outros itens de qualificação de serviço na mesma solicitação. Essas informações ajudam a criar itens de linha de pedido com um item de linha de pedido primário. Tipo de dados: Matriz de objetos `"qualificationItemRelationship": [ { "id": "String" "relationshipType": "String" } ]`
serviceQualificationItem.qualificationItemRelationship.id	Obrigatório. O ID do item de qualificação de destino no relacionamento. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.qualificationItemRelationship.RelationshipType	Obrigatório. O tipo de relacionamento de item de linha. Valores válidos: HasChild: Indica o item secundário. HasParent: Indica o item primário. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.Quantidade	Opcional. Quantidade do item de qualificação. Persistente no campo "Quantidade" do item de linha do pedido do cliente. Tipo de dados: Número Se não especificado, padrão: 1
serviceQualificationItem.service	Obrigatório. Informações de serviço que podem incluir variáveis como local, especificação de serviço e características de serviço. Tipo de dados: Objeto `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Opcional. Padrão de API aberta do TMF. Anotação para informações de serviço para item de qualificação. Este valor é sempre `Serviço` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place	Opcional. As informações de local solicitadas para o item de qualificação de serviço. Localizado na tabela Local [cmn_location]. Nota: Embora a matriz seja compatível, ela deve conter apenas um local. Tipo de dados: Matriz de objetos `"place": [ { "@type": "String" "id": "String", "name": "String" } ]`
serviceQualificationItem.service.place.@type	Opcional. Padrão de API aberta do TMF. Anotação para serviço. Este valor é sempre `GeographicSite` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place.id	Obrigatório. Sys_id de um local na tabela Local [cmn_location]. Este ID de local deve ser uma entrada válida na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place.name	Opcional. Nome do local. Este valor não é verificado em relação às entradas na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.referenceServiceInventory	Obrigatório. Entidade de inventário de serviço válida que se refere a um serviço ativo para o local necessário. As informações de local do pedido de qualificação são obtidas no local deste inventário de serviço. Importante: Use referenceServiceInventoryObjeto para qualificar um novo serviço no mesmo local de um serviço de acesso existente e ativo. Para fazer isso, você também deve omitir placematriz e. serviceInventoryObjeto da sua solicitação, caso contrário, a API retornará um erro. Tipo de dados: Objeto `"referenceServiceInventory": { "id": "String" }`
serviceQualificationItem.service.referenceServiceInventory.id	Necessário se estiver usando serviceQualificationItem.service.referenceServiceInventoryna solicitação. O sys_id de uma entidade de inventário de serviço válida que se refere a um serviço ativo para o local necessário. Essas informações são mencionadas somente nas anotações de trabalho do pedido. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic	Opcional. Matriz de características de serviço. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String", } ]`
serviceQualificationItem.service.serviceCharacteristic.name	Obrigatório. Nome da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.value	Opcional. Valor da característica. Padrão de API aberta do TMF. Anotação para item de qualificação. Este valor é sempre `ServiceQualificationItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.valueType	Opcional. Tipo de valor da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceInventory	Opcional. Entidade de inventário de serviço válida que se refere a um serviço ativo que precisa de upgrade ou downgrade. Importante: Use serviceInventoryobjeto para upgrades ou downgrades de serviço. Para fazer isso, você deve omitir o local arraye. referenceServiceInventoryObjeto da sua solicitação, caso contrário, a API retornará um erro. Tipo de dados: Objeto `"serviceInventory": { "id": "String" }`
serviceQualificationItem.service.serviceSpecification	Obrigatório. Especificação de serviço para o item de qualificação. Armazenado no campo service_specification do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item]. As especificações de serviço para um item de qualificação não podem ser voltadas para os recursos. Tipo de dados: Objeto `"serviceSpecification": { “@type”: ”String”, "id": "String", "name": "String" }`
serviceQualificationItem.service.serviceSpecification.@type	Opcional. Padrão de API aberta do TMF. Anotação para a especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.id	Obrigatório. ID externo ou versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Opcional. Versão interna da especificação do serviço. Tipo de dados: Número
serviceQualificationItem.service.serviceSpecification.name	Obrigatório. Nome da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Opcional. Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres

Cabeçalhos

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

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

Códigos de status

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

Tabela 18. Códigos de status
Código do status	Descrição
201	Solicitação processada com sucesso. Nota: Se houver algum problema com as características ou as informações da opção de características, o endpoint armazenará os seguintes comentários nos campos de anotações de trabalho do registro de item de linha de pedido do cliente associado, semelhante aos pedidos de entrega existentes
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: Carga vazia. Carga inválida: Campo obrigatório ausente: <field name> Carga inválida: Corpo da solicitação ausente - A carga não foi passada no corpo da solicitação. Carga inválida: RelatedParty está ausente. Carga inválida: ServiceQualificationItem está ausente. Carga inválida: O ID ServiceQualificationItem está ausente. Carga inválida: O serviço ServiceQualificationItem está ausente. Carga inválida: As informações de local estão ausentes. Forneça local, serviçoInventory ou referênciServiceInventory. Carga inválida: As informações de especificação estão ausentes, forneça serviceSpecification ou serviceInventory. Carga inválida: A especificação de serviço não existe. Carga inválida: A conta do cliente não existe. Carga inválida: O consumidor não existe.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

Tabela 19. Elementos retornados no corpo da resposta
Elemento	Descrição
id	Sys_id da ordem do cliente de qualificação. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
href	Link relativo para o registro do pedido de qualificação. Tipo de dados: Cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida no campo short_description da ordem de venda. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
externalId	ID externo da ordem de venda. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Ordem do cliente [sn_ind_tmt_orn_order].
QualificationResult	Status de qualificação do campo de resultado da ordem de venda. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de venda no campo de status da ordem de venda. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
VerificarServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
EfectiQualitionDate	Data de qualificação efetiva obtida do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistente no campo expected_end_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
RelatedParty	Lista de contatos da solicitação de qualificação. Cada contato é um objeto na matriz. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Tipo de dados: Cadeia de caracteres Tabela: Tabela Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer]
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para o contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
ServiceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre local, informações de serviço e características de serviço. Armazenado como itens de linha do pedido para a ordem do cliente. Tipo de dados: Matriz de objetos `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualificationItem.id	ID do item de qualificação. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
ServiceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "Resultado" do item de linha da ordem do cliente. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.Quantidade	Quantidade do item de qualificação derivado do campo "Quantidade" do item de linha do pedido do cliente. Tipo de dados: Número Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem. No tipo	Padrão de API aberta do TMF. Anotação para o item de qualificação. Este valor é sempre ServiceQualificationItem . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service	Informações de serviço que incluem detalhes sobre local (local), especificações de serviço e características de serviço. Tipo de dados: Objeto `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Op. Da TMF Padrão de API en. Anotação para o serviço. Este valor é sempre `Serviço` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place	Informações de local para o item de qualificação de serviço. Tipo de dados: Matriz de objetos Nota: Esta matriz pode conter apenas um local. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id do local. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
serviceQualificationItem.service.place.name	Nome do local. Não verificado em relação a uma entrada na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place.@type	Padrão de API aberta do TMF. Anotação para serviço. Este valor é sempre `GeographicSite` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification	Detalhes da especificação do serviço para o item de qualificação. Tipo de dados: Matriz de objetos `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	ID externo ou versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação do serviço. Tipo de dados: Número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Padrão de API aberta do TMF. Anotação para Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic	Lista de características de serviço. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Tipo de valor da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.value	Valor da característica. Tipo de dados: Cadeia de caracteres

Caso de uso 1

O exemplo a seguir mostra uma solicitação simples que contém um único item de qualificação.

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@type": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "@type": "ServiceSpecification"
        }
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

Resposta:

{
  "id": "0b45c47938bf1110f877c8d44c4b895d",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0b45c47938bf1110f877c8d44c4b895d",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "none",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "91478553b7969910ff00f203ae11a97d",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

Caso de uso 2

O exemplo a seguir demonstra como solicitar uma qualificação de serviço simples usando um ID para obter o local do cliente com um serviço existente.

Nota:

Inventário de serviço de referência com ID é um inventário de produto com local igual a 20220 Bow Willow, Houston, TX

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "referenceServiceInventory": {
          "id": "f1b2d99e777301108e191e599a5a99d2"
        },
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "@type": "ServiceSpecification"
        }
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

Resposta, em que placepreenchido de referenceServiceInventoryna solicitação.

{
    "id": "1683497138b35110f877c8d44c4b890a",
   "href":"/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/1683497138b35110f877c8d44c4b890a",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "serviceQualificationItem": [
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [
                    {
                        "name": "Speed",
                        "valueType": "choice",
                        "value": "High"
                    }
                ],
                "serviceSpecification": {
                    "id": "91478553b7969910ff00f203ae11a97d",
                    "name": "Broadband Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "91478553b7969910ff00f203ae11a97d",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "25aba4010a0a0bb3008f329002f12211",
                    "name": "20220 Bow Willow, Houston,TX",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
    "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

Caso de uso 3

O exemplo a seguir demonstra como fazer upgrade do serviço de banda larga de um usuário para uma velocidade mais alta. Inventário de serviço com ID: É um inventário de produto com Especificação de serviço: "Serviço de banda larga", Local: 20220 Bow Willow, Houston, TX, características:[[Speed:Medium]].

{
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "serviceInventory": {
          "id": "f1b2d99e777301108e191e599a5a99d2"
        },
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ]
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

Resposta, em que placee. specificationsão preenchidos a partir de serviceInventoryna solicitação.

Nota:

As características são obtidas da carga da solicitação primeiro e, em seguida, as características restantes (se houver) são obtidas de serviceInventory.

{
    "id": " db8485b138b35110f877c8d44c4b892b",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/ db8485b138b35110f877c8d44c4b892b",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "serviceQualificationItem": [
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [
                    {
                        "name": "Speed",
                        "valueType": "choice",
                        "value": "High"
                    }
                ],
                "serviceSpecification": {
                    "id": "91478553b7969910ff00f203ae11a97d",
                    "name": "Broadband Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "91478553b7969910ff00f203ae11a97d",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "25aba4010a0a0bb3008f329002f12211",
                    "name": "20220 Bow Willow, Houston,TX",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
    "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

Caso de uso 4

Descreve a hierarquia de itens de linha primários e secundários e seus tipos de relacionamento. Demonstra como vários itens de linha podem ser criados por meio do atributo Quantidade.

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "quantity": 2,
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasChild",
          "id": "110"
        },
        {
          "relationshipType": "HasChild",
          "id": "120"
        },
        {
          "relationshipType": "HasChild",
          "id": "130"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "string",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "b3933d9d45f31150f877e0588eca21fc",
          "name": "Access Service"
        }
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "110",
      "action": "add",
      "expectedServiceAvailabilityDate": "2022-12-10T19:20:39.239Z",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Fiber Speed",
            "value": "1Gbps"
          }
        ],
        "serviceSpecification": {
          "name": "CFS3",
          "internalVersion": "1",
          "id": "4d2b5799457b1150f877e0588eca2116"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "120",
      "action": "add",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "expectedServiceAvailabilityDate": "2022-11-12T19:20:39.239Z",
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "DSL Speed",
            "value": "500 Mbps"
          }
        ],
        "serviceSpecification": {
          "name": "CF1",
          "internalVersion": "1",
          "id": "1d43f91d45f31150f877e0588eca21cd"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "130",
      "action": "add",
      "expectedServiceAvailabilityDate": "2020-04-11T19:20:39.239Z",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Wireless Speed",
            "value": "100 Mbps"
          }
        ],
        "serviceSpecification": {
          "name": "CFS2",
          "internalVersion": "1",
          "id": "28733d1d45f31150f877e0588eca2163"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

Resposta:

{
  "id": "7bf9cd7538b35110f877c8d44c4b89e4",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/7bf9cd7538b35110f877c8d44c4b89e4",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "none",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "120",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "DSL Speed",
            "valueType": "choice",
            "value": "500 Mbps"
          }
        ],
        "serviceSpecification": {
          "id": "1d43f91d45f31150f877e0588eca21cd",
          "name": "CFS1",
          "version": "",
          "internalVersion": "1",
          "internalId": "1d43f91d45f31150f877e0588eca21cd",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "110",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Fiber Speed",
            "valueType": "choice",
            "value": "1Gbps"
          }
        ],
        "serviceSpecification": {
          "id": "4d2b5799457b1150f877e0588eca2116",
          "name": "CFS3",
          "version": "",
          "internalVersion": "1",
          "internalId": "4d2b5799457b1150f877e0588eca2116",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "130",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Wireless Speed",
            "valueType": "choice",
            "value": "100 Mbps"
          }
        ],
        "serviceSpecification": {
          "id": "28733d1d45f31150f877e0588eca2163",
          "name": "CFS2",
          "version": "",
          "internalVersion": "1",
          "internalId": "28733d1d45f31150f877e0588eca2163",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "100",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "2",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "b3933d9d45f31150f877e0588eca21fc",
          "name": "Access Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "b3933d9d45f31150f877e0588eca21fc",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

API aberta de qualificação de serviço técnico - POST sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

Processa um resultado de qualificação de serviço técnico enviado para Qualificação de serviço técnico em aberto API.

Formato de URL

URL padrão: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

Parâmetros de solicitação compatíveis

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

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

Tabela 22. Solicitar parâmetros do corpo (XML ou JSON)
Parâmetro	Descrição
ServiceQualificationItem	Obrigatório. Lista de itens de qualificação de serviço, cada um representando uma ordem de domínio na tabela Ordem de serviço [sn_ind_tmt_ORM_service_order] para o item de linha de pedido principal solicitado. Todos os pedidos de domínio representados por cada um dos itens de qualificação de serviço devem pertencer ao mesmo item de linha de pedido principal. Tipo de dados: Matriz de objetos `"serviceQualificationItem": [ { "@type": "String", "alternateServiceProposal": [Array], "id": "String", "qualificationResult": "String" } ]`
ServiceQualificationItem. No tipo	Opcional. Padrão de API aberta do TMF. Anotação para item de qualificação. Este valor é sempre `ServiceQualificationItem` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alternateProposal	Propostas alternativas fornecidas para o item de qualificação. Tipo de dados: Matriz de objetos `"alternateServiceProposal": [ { "@type": "String", "alternateService": {Object}, "alternateServiceAvailabilityDate": "Number", "id": "String", "serviceCharacteristic": [Array] } ]` Armazenado em: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateProposal. No tipo	Padrão de API aberta do TMF. Anotação para informações de serviço para o item de qualificação. Este valor é sempre `Serviço` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alterneProposal.alterneService	Obrigatório. Informações de serviço para a proposta alternativa que contém especificações e características de serviço. Tipo de dados: Objeto `"alternateService": { "@type": "String", "serviceSpecification": {Object}, "serviceCharacteristic": [Array] }`
serviceQualificationItem.alternateProposal.alternateService.alternateService.serviceCharacteristic.valueType	Tipo de valor da característica na proposta de serviço alternativo. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic	Características de serviço para a proposta de serviço alternativo. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]` Armazenado em: O campo order_characteristics da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal].
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name	Obrigatório. Nome da característica que pertence à proposta de serviço alternativo. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value	Valor da característica que pertence à proposta de serviço alternativo. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.valueType	Tipo de característica. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alterneProposal.alterneService .serviceSpecification	Obrigatório. Especificação de serviço para a proposta alternativa. Tipo de dados: Objeto `"serviceSpecification": { “@type”: ”String” "id": "String", "name": "String" }` Armazenado em: O campo de especificação da entrada de proposta alternativa da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal].
ServiceQualificationItem.alterneProposal.alterneService .serviceSpecificationItem.alterneProposal.alterneService .ServiceSpecificationSpecificationItem	Padrão de API aberta do TMF. Anotação para a Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id	Obrigatório. ID externo ou versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name	Nome da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alterneProposal.alterneServiceAvailabilityDate	Data de disponibilidade do serviço alternativo. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Tabela: No campo available_date da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal], em que as informações de pedido de domínio pertencem à ordem de domínio representada pelo item de qualificação de serviço atual.
serviceQualificationItem.alternateProposal.id	ID definido pelo usuário para a proposta alternativa. Esses dados não são persistentes. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityMoason	Motivo pelo qual a qualificação de serviço não está qualificada. Tipo de dados: Objeto `"eligibilityUnavailabilityReason": [ { "code": "String", "label": "String" } ]` Armazenado em: A lista inteira de motivos persiste com seus campos de rótulo como uma cadeia de caracteres no campo inavailability_reason da tabela Ordem de domínio [sn_ind_tmt_orn_domain_order].
ServiceQualificationItem.eligibilityInavailabilityMoason.code	Código do motivo da indisponibilidade de qualificação. Essas informações não são persistentes. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityReason.label	Obrigatório. Rótulo do motivo da indisponibilidade de qualificação. Se houver vários motivos de inqualificação, os rótulos serão separados por uma vírgula. Tipo de dados: Cadeia de caracteres Armazenado em: O campo inavailability_reason da tabela Ordem de domínio [sn_ind_tmt_orn_domain_order].
serviceQualificationItem.id	Obrigatório. Sys_id da ordem de domínio representada pelo item de qualificação. Tipo de dados: Cadeia de caracteres : Campo sys_id da tabela Ordem de domínio [sn_ind_tmt_orn_service_order].
ServiceQualificationItem.qualificationResult	Obrigatório. Resultado da qualificação para cada item de qualificação de serviço. Tipo de dados: Cadeia de caracteres Armazenado em: O campo Resultado da tabela Ordem de domínio [sn_ind_tmt_orn_service_order].

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/jsonou application/xml. Padrão: application/json

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

Códigos de status

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

Tabela 25. Códigos de status
Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: Carga inválida: O resultado da qualificação deve ser um de [alternativo, pendente, qualificado, não qualificado]. Carga inválida: O ID do item de qualificação não existe. Todos os itens de qualificação devem pertencer ao mesmo Item de linha de pedido principal. Carga inválida: ServiceQualificationItem qualificationResult está ausente. Carga inválida: O consumidor não existe.

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


Nome	Descrição
id	Sys_id da ordem do cliente de qualificação. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
href	Link relativo para o registro do pedido de qualificação. Tipo de dados: Cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida no campo short_description da ordem de venda. Tipo de dados: Cadeia de caracteres Ordem do cliente [sn_ind_tmt_orn_order]
externalId	ID externo da ordem de venda. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Ordem do cliente [sn_ind_tmt_orn_order].
QualificationResult	Status de qualificação do campo de resultado da ordem de venda. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres
estado	Estado da ordem de venda no campo de status da ordem de venda. Tipo de dados: Cadeia de caracteres
.	Padrão de API aberta do TMF. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
VerificarServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
EfectiQualitionDate	Data de qualificação efetiva obtida do campo order_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistente no campo expected_end_date da ordem do cliente. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DDTHH:MM:SS.SSSZ Ordem do cliente [sn_ind_tmt_orn_order]
RelatedParty	Lista de contatos da solicitação de qualificação. Cada contato é um objeto na matriz. Tipo de dados: Matriz de objetos `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
IdentidadeRelatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. Tipo de dados: Cadeia de caracteres Tabela: Tabela Conta [customer_account], tabela Contato [customer_contact] ou Consumidor [csm_consumer]
relatedParty.name	Nome da conta, cliente ou consumidor. Tipo de dados: Cadeia de caracteres
RelatedParty. Em	Padrão de API aberta do TMF. Anotação para o contato do item de linha do pedido. Este valor é sempre `Relacionada` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
RelatedParty. Em referredType	Tipo de parte relacionada. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
ServiceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre local, informações de serviço e características de serviço. Armazenado como itens de linha do pedido para a ordem do cliente. Tipo de dados: Matriz de objetos `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualificationItem.id	ID do item de qualificação. Tipo de dados: Cadeia de caracteres Armazenado em: O campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orn_order_line_item].
ServiceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "Resultado" do item de linha da ordem do cliente. Valores possíveis: alternativo nenhum pendente(s) qualificado não qualificado Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Tipo de dados: Cadeia de caracteres Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem.Quantidade	Quantidade do item de qualificação derivado do campo "Quantidade" do item de linha do pedido do cliente. Tipo de dados: Número Tabela: Item de linha do pedido [sn_ind_tmt_orn_order_line_item]
ServiceQualificationItem. No tipo	Padrão de API aberta do TMF. Anotação para o item de qualificação. Este valor é sempre ServiceQualificationItem . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service	Informações de serviço que incluem detalhes sobre local (local), especificações de serviço e características de serviço. Tipo de dados: Objeto `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Op. Da TMF Padrão de API en. Anotação para o serviço. Este valor é sempre `Serviço` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place	Informações de local para o item de qualificação de serviço. Tipo de dados: Matriz de objetos Nota: Esta matriz pode conter apenas um local. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id do local. Tipo de dados: Cadeia de caracteres Tabela: Local [cmn_location]
serviceQualificationItem.service.place.name	Nome do local. Não verificado em relação a uma entrada na tabela Local [cmn_location]. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.place.@type	Padrão de API aberta do TMF. Anotação para serviço. Este valor é sempre `GeographicSite` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification	Detalhes da especificação do serviço para o item de qualificação. Tipo de dados: Matriz de objetos `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	ID externo ou versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação do serviço. Tipo de dados: Número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Padrão de API aberta do TMF. Anotação para Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic	Lista de características de serviço. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Tipo de valor da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
serviceQualificationItem.service.serviceCharacteristic.value	Valor da característica. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal	Proposta de serviço alternativo para a ordem de qualificação. Tipo de dados: Cadeia de caracteres Armazenado em: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.id	Sys_id do registro de proposta alternativa. Tipo de dados: Cadeia de caracteres Tabela: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alterneServiceProposal.alterneServiceAvailabilityDate	O valor do campo available_date da entrada de proposta alternativa na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.alterneServiceProposal.alterneService	Informações de serviço representadas pela proposta alternativa. Tipo de dados: Objeto
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	A especificação de serviço da proposta alternativa persistia na especificação. Tipo de dados: Objeto Tabela: Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	ID externo ou versão inicial da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Nome da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Versão externa da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação de serviço alternativo. Tipo de dados: Número
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Versão inicial da especificação de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type	Padrão de API aberta do TMF. Anotação para Especificação de serviço. Este valor é sempre `ServiceSpecification` . Essas informações não são armazenadas. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic	Lista de características de serviço para a proposta de serviço alternativo. Tipo de dados: Matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Tipo de valor da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Nome da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Valor da característica de serviço alternativo. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityMoason	Lista de motivos de indisponibilidade de qualificação do serviço para explicar por que o serviço não está disponível. Tipo de dados: Matriz Armazenado em: O campo inavailability_reason da tabela Ordem de domínio [sn_ind_tmt_orn_domain_order].
ServiceQualificationItem.eligibilityInavailabilityMoason.code	Código do motivo de indisponibilidade da qualificação do serviço. Tipo de dados: Cadeia de caracteres
ServiceQualificationItem.eligibilityInavailabilityReason.label	Rótulo do motivo de indisponibilidade da qualificação do serviço. Tipo de dados: Cadeia de caracteres

Solicitação de cURL de amostra

O exemplo a seguir mostra como o endpoint processa uma ordem de qualificação enviada na solicitação de API.

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "serviceQualificationItem": [
    {
      "eligibilityUnavailabilityReason": [
        {
          "code": "26-001",
          "label": "not enough bandwith at this place"
        }
      ],
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "295580b938bf1110f877c8d44c4b8912"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "action": "add",
      "id": "295580b938bf1110f877c8d44c4b8915"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "2d5580b938bf1110f877c8d44c4b8902"
    }
  ],
  "@type": "CheckServiceQualification",
  "description": "check service qualification illustration"
}

Corpo da resposta:

{
  "id": "0b45c47938bf1110f877c8d44c4b895d",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0b45c47938bf1110f877c8d44c4b895d",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "alternate",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "qualificationResult": "alternate",
      "state": "in_progress",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "91478553b7969910ff00f203ae11a97d",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      },
      "alternateServiceProposal": [
        {
          "id": "350e66a2e5331110f87741b459ef19b0",
          "alternateServiceAvailabilityDate": "2022-12-15 19:20:39",
          "alternateService": {
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ],
            "serviceSpecification": {
              "id": "23e7ed67c32310105252716b7d40dd80",
              "name": "Mobile Service",
              "version": "",
              "internalVersion": "1",
              "internalId": "23e7ed67c32310105252716b7d40dd80",
              "@type": "ServiceSpecification"
            },
            "@type": "Service"
          },
          "@type": "AlternateServiceProposal"
        }
      ],
      "eligibilityUnavailabilityReason": [
        {
          "label": "not enough bandwith at this place",
          "@type": "string"
        }
      ]
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}