API aberta de qualificação do serviço técnico

Versão de lançamento: Xanadu

Atualizado 1 de ago. de 2024

54 min. de leitura

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

Esta API é uma implementação ServiceNow 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.

A API aberta de qualificação de serviço técnico é fornecida no namespace sn_ord_qual_mgmt e requer os seguintes plug-ins:

Gestão do 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 pedidos [com.sn_ord_qual_mgmt]
Order Management for Telecom, Media & Tech [com.sn_tmt_core]
Telecom Core [com.sn_tmt_core]

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

API aberta de qualificação de serviço técnico - GET sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

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

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

Pedido do cliente [sn_ind_tmt_orm_order]
Item de linha do pedido [sn_ind_tmt_orm_order_line_item]

Formato da URL

URL com controle de versões: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
ID	Sys_id do pedido de qualificação do cliente a ser recuperado. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres

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

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

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 6. Códigos de status

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

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


Nome	Descrição
ID	Sys_id do pedido de qualificação do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
href	Link relativo ao registro do pedido de qualificação. Tipo de dados: cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida do campo short_description do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
externalId	ID externo do campo external_id do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
resultadodequalificação	Status de qualificação do campo de resultado do pedido do cliente. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
estado	Estado do pedido do cliente no campo de status do pedido do cliente. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão TMF Open API. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
checkServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
dataDeQualificaçãoeficaz	Data de qualificação efetiva obtida do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistido no campo opened_end_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos para a 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" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. 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
relatedParty.@type	Parte do padrão TMF Open API. Anotação para o contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de parte relacionada. Valores possíveis: Consumidor Cliente CustomerContact Tipo de dados: cadeia de caracteres
serviceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre localização, informações de serviço e características de serviço. Armazenados como itens de linha do pedido para o pedido 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. Armazenado no campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "resultado" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
serviceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.quantity	Quantidade de item de qualificação derivada do campo "quantidade" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: número
serviceQualificationItem.@type	Parte do padrão TMF Open API. 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 localização (place), 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	Parte do padrão da API TMF Open. 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 do 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 de um local na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
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	Parte do padrão TMF Open API. 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 de 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 de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação de serviço. Tipo de dados: número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. 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
itemDeQualificaçãoDeServiço.serviço.característicadeserviço	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
itemDeQualificaçãoDeServiço.serviço.característica.valor	Valor da característica. Tipo de dados: cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal	Proposta de serviço alternativa para o pedido de qualificação. As propostas alternativas são armazenadas na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal.id	Sys_id da entrada de proposta alternativa na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: cadeia de caracteres
ItemDeQualificaçãoDeServiço.PropostaDeServiçoAlternativa.DataDeDisponibilidadeDeServiço	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.alternateServiceProposal.alternateService	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 persistiu na especificação da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: objeto
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.id	ID externo ou versão inicial da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.name	Nome da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceSpecification.version	Versão externa da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação de serviço alternativa. Tipo de dados: número
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.internalId	Versão inicial da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
ServiceQualificationItem. alternativaServiçoProposta.alternateServiço.EspecificaçãoDeServiço.@tipo	Parte do padrão TMF Open API. 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. alternativaDeServiçoProposal.alternateService.característicadeserviço	Matriz de características de serviço para a proposta de serviço alternativa. Tipo de dados: matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceCharacteristic.valueType	Tipo de valor da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDePropostaDeServiço.serviçoAlternativo.CaracterísticaDeServiço.nome	Nome da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceCharacteristic.value	Valor da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason	Uma lista de motivos de indisponibilidade de qualificação de serviço para explicar por que o serviço não está disponível. Este valor é persistente no campo unavailability_reason da tabela Pedido de domínio [sn_ind_tmt_orm_domain_order]. Tipo de dados: matriz
serviceQualificationItem.eligibilityUnavailabilityReason.code	Código de motivo da indisponibilidade de qualificação para o serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason.label	Rótulo do motivo de indisponibilidade de qualificação de serviço. Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

O exemplo a seguir recupera um pedido de qualificação específico associado a um determinado Sys_id de um pedido de qualificação do cliente.

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 - GET sn_ord_qual_mgmt/qualification/checkServiceQualification

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

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

Pedido do cliente [sn_ind_tmt_orm_order]
Item de linha do pedido [sn_ind_tmt_orm_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 da URL

URL com controle de versões: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 8. Parâmetros de consulta
Parâmetro	Descrição
descrição	Filtra pedidos de qualificação pelo campo "short_description" do pedido do cliente. Somente pedidos com uma descrição resumida correspondente aog valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres
campos	Lista de nomes de campo a serem retornados naresposta. 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, separada por vírgulas
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro de deslocamento [ para paginar a recuperação do registro. Padrão: 20 Máximo: 100 Tipo de dados: número
resultadodequalificação	Filtra pedidos 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 pedidos de qualificação por estado. Somente pedidos com um estado correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres

Tabela 9. Parâmetros do corpo da solicitação (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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 12. Códigos de status
Código de status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado em 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 do pedido de qualificação do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
href	Link relativo ao registro do pedido de qualificação. Tipo de dados: cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida do campo short_description do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
externalId	ID externo do campo external_id do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
resultadodequalificação	Status de qualificação do campo de resultado do pedido do cliente. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
estado	Estado do pedido do cliente no campo de status do pedido do cliente. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão TMF Open API. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
checkServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
dataDeQualificaçãoeficaz	Data de qualificação efetiva obtida do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistido no campo opened_end_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos para a 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" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. 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
relatedParty.@type	Parte do padrão TMF Open API. Anotação para o contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de parte relacionada. Valores possíveis: Consumidor Cliente CustomerContact Tipo de dados: cadeia de caracteres
serviceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre localização, informações de serviço e características de serviço. Armazenados como itens de linha do pedido para o pedido 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. Armazenado no campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "resultado" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
serviceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.quantity	Quantidade de item de qualificação derivada do campo "quantidade" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: número
serviceQualificationItem.@type	Parte do padrão TMF Open API. 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 localização (place), 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	Parte do padrão da API TMF Open. 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 do 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 de um local na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
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	Parte do padrão TMF Open API. 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 de 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 de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação de serviço. Tipo de dados: número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. 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
itemDeQualificaçãoDeServiço.serviço.característicadeserviço	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
itemDeQualificaçãoDeServiço.serviço.característica.valor	Valor da característica. Tipo de dados: cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal	Proposta de serviço alternativa para o pedido de qualificação. As propostas alternativas são armazenadas na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal.id	Sys_id da entrada de proposta alternativa na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: cadeia de caracteres
ItemDeQualificaçãoDeServiço.PropostaDeServiçoAlternativa.DataDeDisponibilidadeDeServiço	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.alternateServiceProposal.alternateService	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 persistiu na especificação da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: objeto
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.id	ID externo ou versão inicial da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.name	Nome da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceSpecification.version	Versão externa da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação de serviço alternativa. Tipo de dados: número
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.internalId	Versão inicial da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
ServiceQualificationItem. alternativaServiçoProposta.alternateServiço.EspecificaçãoDeServiço.@tipo	Parte do padrão TMF Open API. 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. alternativaDeServiçoProposal.alternateService.característicadeserviço	Matriz de características de serviço para a proposta de serviço alternativa. Tipo de dados: matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceCharacteristic.valueType	Tipo de valor da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDePropostaDeServiço.serviçoAlternativo.CaracterísticaDeServiço.nome	Nome da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceCharacteristic.value	Valor da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason	Uma lista de motivos de indisponibilidade de qualificação de serviço para explicar por que o serviço não está disponível. Este valor é persistente no campo unavailability_reason da tabela Pedido de domínio [sn_ind_tmt_orm_domain_order]. Tipo de dados: matriz
serviceQualificationItem.eligibilityUnavailabilityReason.code	Código de motivo da indisponibilidade de qualificação para o serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason.label	Rótulo do motivo de indisponibilidade de qualificação de serviço. Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

A chamada GET a seguir recupera todas as ordens 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 é persistente como um pedido do cliente com o tipo de execução de qualificação. Cada item de qualificação é persistente 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 a matriz [ place (serviceQualificationItem.service.place) para 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 o objeto referenceServiceInventory (serviceQualificationItem.service.referenceServiceInventory) em vez da matriz place. 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 o objeto serviceInventory (serviceQualificationItem.service.ServiceInventory) em vez da matriz place ou do objeto referenceServiceInventory. Neste caso de uso, as informações de localização e os detalhes de especificação são obtidos de um serviço existente. Em sua solicitação, defina as características de serviço que você deseja mudar.
Por exemplo, digamos que você queira 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 o parâmetro serviceInventory 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 na seção Exemplo desta página.

Formato da URL

URL com controle de versões: /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. Parâmetros do corpo da solicitação (XML ou JSON)
Parâmetro	Descrição
@tipo	Opcional. Parte do padrão TMF Open API. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
checkServiceQualificationDate	Opcional. A data e hora em que a solicitação de qualificação foi criada. Localizado no campo order_date da tabela Pedido do cliente [sn_ind_tmt_orm_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 Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres Tamanho máximo de caracteres: 100
dataDeQualificaçãoeficaz	Opcional. A data em que a qualificação entrou em vigor. Persistido no campo "actual_end_date" do pedido do cliente da tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DDTHH:MM:SS.SSSZ
ExpectedQualificationDate	Opcional. A data de qualificação esperada. Persistido no campo opened_end_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DDTHH:MM:SS.SSSZ
externalId	Opcional. ID externo atribuído ao pedido do cliente. Persistido no campo external_id do pedido do cliente da tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos para a solicitação de qualificação. Cada contato é um objeto na matriz. Deve listar pelo menos um item que contenha informações de conta do cliente, contato do cliente ou conta do consumidor. Tipo de dados: matriz de objetos `"relatedParty": [ { "@referredType": "String", "@type": "String", "id": "String", "name": "String" } ]`
relatedParty.@referredType	Tipo de parte relacionada. Valores possíveis: cliente cliente clienteContato Tipo de dados: cadeia de caracteres
relatedParty.@tipo	Opcional. Parte do padrão TMF Open API. Anotação para o contato do item de linha do pedido. Este valor é sempre `RelatedParty`. 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 localização, informações de serviço e características. Armazenados como itens de linha do pedido para o pedido 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.@type	Opcional. Parte do padrão TMF Open API. 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 do 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.quantity	Opcional. Quantidade do item de qualificação. Persistido no campo "quantidade" do item de linha do pedido do cliente. Tipo de dados: número Padrão se não for especificado: 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. Parte do padrão TMF Open API. Anotação de 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. Parte do padrão TMF Open API. 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 do local deste inventário de serviço. Importante: Use o objeto referenceServiceInventory para qualificar um novo serviço no mesmo local de um serviço do Access existente e ativo. Para fazer isso, você também deve omitir a matriz [ place e o objeto serviceInventory da sua solicitação, caso contrário, a API retornará um erro. Tipo de dados: objeto `"referenceServiceInventory": { "id": "String" }`
serviceQualificationItem.service.referenceServiceInventory.id	Obrigatório se estiver usando serviceQualificationItem.service.referenceServiceInventory na 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
itemDeQualificaçãoDeServiço.serviço.característicadeserviço	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
itemDeQualificaçãoDeServiço.serviço.característica.valor	Opcional. Valor da característica. Parte do padrão TMF Open API. 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 um upgrade ou downgrade. Importante: Use o objeto serviceInventory para upgrades ou downgrades de serviço. Para fazer isso, você deve omitir os objetos local array e referenceServiceInventory 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_orm_order_line_item]. As especificações de serviço de 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. Parte do padrão TMF Open API. 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 de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Opcional. Versão interna da especificação de serviço. Tipo de dados: número
serviceQualificationItem.service.serviceSpecification.name	Obrigatório. Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Opcional. Versão externa da especificação de 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/json ou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 18. Códigos de status
Código de status	Descrição
201	Solicitação processada com sucesso. Nota: Se houver problemas com as características ou informações de 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 do pedido do cliente associado, semelhante aos pedidos de entrega existentes
400	Solicitação Incorreta. Pode ser 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 de 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, serviceInventory ou referenceServiceInventory. 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 do pedido de qualificação do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
href	Link relativo ao registro do pedido de qualificação. Tipo de dados: cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida do campo short_description do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
externalId	ID externo do campo external_id do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
resultadodequalificação	Status de qualificação do campo de resultado do pedido do cliente. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
estado	Estado do pedido do cliente no campo de status do pedido do cliente. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão TMF Open API. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
checkServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
dataDeQualificaçãoeficaz	Data de qualificação efetiva obtida do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistido no campo opened_end_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos para a 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" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. 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
relatedParty.@type	Parte do padrão TMF Open API. Anotação para o contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de parte relacionada. Valores possíveis: Consumidor Cliente CustomerContact Tipo de dados: cadeia de caracteres
serviceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre localização, informações de serviço e características de serviço. Armazenados como itens de linha do pedido para o pedido 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. Armazenado no campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "resultado" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
serviceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.quantity	Quantidade de item de qualificação derivada do campo "quantidade" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: número
serviceQualificationItem.@type	Parte do padrão TMF Open API. 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 localização (place), 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	Parte do padrão da API TMF Open. 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 do 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 de um local na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
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	Parte do padrão TMF Open API. 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 de 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 de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação de serviço. Tipo de dados: número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. 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
itemDeQualificaçãoDeServiço.serviço.característicadeserviço	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
itemDeQualificaçãoDeServiço.serviço.característica.valor	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:

O inventário de serviço de referência com ID = é um inventário de produtos com localização = 20220 Bow William, 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 place é preenchido a partir de referenceServiceInventory na 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 maior. O 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 William, TX, características=[{Velocidade:Média}].

{
  "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 place e specification são preenchidos a partir de serviceInventory na 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. Ele demonstra como vários itens de linha podem ser criados por meio do atributo de 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 a API aberta de qualificação de serviço técnico.

Formato da URL

URL com controle de versã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
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, `v1` ou `v2`. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

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

Tabela 22. Parâmetros do corpo da solicitação (XML ou JSON)
Parâmetro	Descrição
serviceQualificationItem	Obrigatório. Lista de itens de qualificação de serviço, cada um representando um pedido de domínio na tabela Ordem de serviço [sn_ind_tmt_orm_service_order] para o item de linha do pedido superior 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 do pedido principal. Tipo de dados: matriz de objetos `"serviceQualificationItem": [ { "@type": "String", "alternateServiceProposal": [Array], "id": "String", "qualificationResult": "String" } ]`
serviceQualificationItem.@type	Opcional. Parte do padrão TMF Open API. 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	Opcional. Propostas alternativas fornecidas para o item de qualificação. Armazenado na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: matriz de objetos `"alternateServiceProposal": [ { "@type": "String", "alternateService": {Object}, "alternateServiceAvailabilityDate": "Number", "id": "String", "serviceCharacteristic": [Array] } ]`
serviceQualificationItem.alternateProposal.@type	Opcional. Parte do padrão TMF Open API. Anotação de 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.alternateProposal.alternateService	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 alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceCaracterística	Matriz de características de serviço para a proposta de serviço alternativa, armazenada como uma cadeia de caracteres no campo "order_characteristics" da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: matriz de objetos `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name	Obrigatório. Nome da característica pertencente à proposta de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value	Valor da característica pertencente à proposta de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification	Obrigatório. Especificação de serviço para a proposta alternativa. Armazenado no campo de especificação da entrada de proposta alternativa da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: objeto `"serviceSpecification": { “@type”: ”String” "id": "String", "name": "String" }`
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type	Parte do padrão TMF Open API. 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 de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.alternateServiceAvailabilityDate	Opcional. Data alternativa de disponibilidade do serviço. Localizado no campo "available_date" da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal], em que as informações do pedido de domínio pertencem ao pedido de domínio representado pelo item de qualificação de serviço atual. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
serviceQualificationItem.alternateProposal.id	Opcional. ID definido pelo usuário para a proposta alternativa. Esses dados não são persistentes. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason	Opcional. Motivo pelo qual a qualificação de serviço não está qualificada. A lista inteira de motivos é persistente com seus campos de rótulo como uma cadeia de caracteres no campo "unavailability_reason" da tabela Pedido de domínio [sn_ind_tmt_orm_domain_order]. Tipo de dados: objeto `"eligibilityUnavailabilityReason": [ { "code": "String", "label": "String" } ]`
serviceQualificationItem.eligibilityUnavailabilityReason.code	Opcional. Código do motivo da indisponibilidade de qualificação. Essas informações não são persistentes. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason.label	Obrigatório. Rótulo para o motivo da indisponibilidade de qualificação. Se houver vários motivos de inelegibilidade, os rótulos serão separados por "", "" e armazenados no campo "unavailability_reason" da tabela Pedido de domínio [sn_ind_tmt_orm_domain_order]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.id	Obrigatório. Sys_id do pedido de domínio representado pelo item de qualificação. Armazenado no campo Sys_id do pedido de domínio [sn_ind_tmt_orm_service_order]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.qualificationResult	Obrigatório. Resultado de qualificação para cada item de qualificação de serviço persistente no campo de resultado da tabela Pedido de domínio [sn_ind_tmt_orm_service_order]. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

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

Códigos de status

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

Tabela 25. Códigos de status
Código de status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos: Carga inválida: o resultado da qualificação deve ser [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 do 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 do pedido de qualificação do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
href	Link relativo ao registro do pedido de qualificação. Tipo de dados: cadeia de caracteres
descrição	Descrição da solicitação de qualificação que é obtida do campo short_description do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
externalId	ID externo do campo external_id do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Tipo de dados: cadeia de caracteres
resultadodequalificação	Status de qualificação do campo de resultado do pedido do cliente. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
estado	Estado do pedido do cliente no campo de status do pedido do cliente. Tipo de dados: cadeia de caracteres
@tipo	Parte do padrão TMF Open API. Anotação para a qualificação. Este valor é sempre `CheckServiceQualification`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
checkServiceQualificationDate	Data e hora em que a solicitação de qualificação foi criada a partir do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
dataDeQualificaçãoeficaz	Data de qualificação efetiva obtida do campo order_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
ExpectedQualificationDate	Armazena a data de qualificação esperada. Persistido no campo opened_end_date do pedido do cliente. Localizado na tabela Pedido do cliente [sn_ind_tmt_orm_order]. Formato: AAAA-MM-DDTHH:MM:SS.SSSZ Tipo de dados: cadeia de caracteres
relatedParty	Lista de contatos para a 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" } ]`
relatedParty.id	Sys_id ou external_id da conta, contato do cliente ou consumidor associado ao pedido. 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
relatedParty.@type	Parte do padrão TMF Open API. Anotação para o contato do item de linha do pedido. Este valor é sempre `RelatedParty`. Essas informações não são armazenadas. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de parte relacionada. Valores possíveis: Consumidor Cliente CustomerContact Tipo de dados: cadeia de caracteres
serviceQualificationItem	Lista de itens de qualificação de serviço que contém informações sobre localização, informações de serviço e características de serviço. Armazenados como itens de linha do pedido para o pedido 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. Armazenado no campo external_id do item de linha do pedido do cliente na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.qualificationResult	Resultado do item de qualificação. Armazenado no campo "resultado" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Valores possíveis: alternativo nenhum pendente qualificado não qualificado Tipo de dados: cadeia de caracteres
serviceQualificationItem.state	Estado do item de qualificação derivado do campo "status" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: cadeia de caracteres
serviceQualificationItem.quantity	Quantidade de item de qualificação derivada do campo "quantidade" do item de linha do pedido do cliente. Localizado na tabela Item de linha do pedido [sn_ind_tmt_orm_order_line_item]. Tipo de dados: número
serviceQualificationItem.@type	Parte do padrão TMF Open API. 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 localização (place), 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	Parte do padrão da API TMF Open. 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 do 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 de um local na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres
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	Parte do padrão TMF Open API. 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 de 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 de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.internalVersion	Versão interna da especificação de serviço. Tipo de dados: número
serviceQualificationItem.service.serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.service.serviceSpecification.@type	Parte do padrão TMF Open API. 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
itemDeQualificaçãoDeServiço.serviço.característicadeserviço	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
itemDeQualificaçãoDeServiço.serviço.característica.valor	Valor da característica. Tipo de dados: cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal	Proposta de serviço alternativa para o pedido de qualificação. As propostas alternativas são armazenadas na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: cadeia de caracteres
ServiceQualificationItem.alternateServiceProposal.id	Sys_id da entrada de proposta alternativa na tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: cadeia de caracteres
ItemDeQualificaçãoDeServiço.PropostaDeServiçoAlternativa.DataDeDisponibilidadeDeServiço	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.alternateServiceProposal.alternateService	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 persistiu na especificação da tabela Proposta alternativa [sn_ord_qual_mgmt_alternate_proposal]. Tipo de dados: objeto
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.id	ID externo ou versão inicial da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.name	Nome da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceSpecification.version	Versão externa da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceSpecification.internalVersion	Versão interna da especificação de serviço alternativa. Tipo de dados: número
serviceQualificationItem. alternativaServiçoProposal.alternateService.serviceSpecification.internalId	Versão inicial da especificação de serviço alternativa. Tipo de dados: cadeia de caracteres
ServiceQualificationItem. alternativaServiçoProposta.alternateServiço.EspecificaçãoDeServiço.@tipo	Parte do padrão TMF Open API. 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. alternativaDeServiçoProposal.alternateService.característicadeserviço	Matriz de características de serviço para a proposta de serviço alternativa. Tipo de dados: matriz de objetos `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceCharacteristic.valueType	Tipo de valor da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDePropostaDeServiço.serviçoAlternativo.CaracterísticaDeServiço.nome	Nome da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem. alternativaDeServiçoProposal.alternateService.serviceCharacteristic.value	Valor da característica de serviço alternativa. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason	Uma lista de motivos de indisponibilidade de qualificação de serviço para explicar por que o serviço não está disponível. Este valor é persistente no campo unavailability_reason da tabela Pedido de domínio [sn_ind_tmt_orm_domain_order]. Tipo de dados: matriz
serviceQualificationItem.eligibilityUnavailabilityReason.code	Código de motivo da indisponibilidade de qualificação para o serviço. Tipo de dados: cadeia de caracteres
serviceQualificationItem.eligibilityUnavailabilityReason.label	Rótulo do motivo de indisponibilidade de qualificação de serviço. Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

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"
}