API Abrir Catálogo de produtos

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 160 min. de leitura
  • . Catálogo de produtos aberto A API fornece endpoints para criar e recuperar catálogos de produtos, ofertas de produtos e especificações de produtos.

    Use esta API para gerenciar informações do catálogo de produtos entre sistemas externos e o. ServiceNow AI Platform. . Catálogo de produtos aberto A API é um ServiceNow® Implementação da especificação REST da API Gestão de catálogo de produtos do TM Forum. Esta implementação é baseada no TMF620 Product Catalog Management API REST Specification Versão 4 Abril de 2021.

    Esta API está incluída na aplicação Catálogo de produtos avançada, que está disponível no ServiceNow Store.

    Esta API é fornecida no sn_tmf_api namespace.

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

    Esta API cria e atualiza dados nas tabelas a seguir.
    • Característica [sn_prd_pm_characteristic]
    • Opção de característica [sn_prd_pm_characteristic_option]
    • Oferta de produto [sn_prd_pm_product_offering]
    • Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]
    • Característica de oferta de produto [sn_prd_pm_product_offering_characteristic]
    • Especificação do produto [sn_prd_pm_product_specification]
    • Relacionamento de especificação [sn_prd_pm_specification_relationship]

    API aberta do Catálogo de produtos - EXCLUA /sn_tmf_api/catalogmanagement/productOffering/

    Exclui a oferta de produto especificada.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering/

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    id Sys_id da oferta de produto a ser excluída.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

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

    Cabeçalhos

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

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

    Padrão: application/json

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

    Códigos de status

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

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.

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

    Nome Descrição
    mensagem Uma mensagem de falha ou sucesso sobre a exclusão ou arquivamento da especificação do produto.

    Solicitação de curl

    O exemplo a seguir exclui a oferta de produto com um ID d6f8d9995b020210235d85cced81c7eb.

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
    --request DELETE\ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

    O corpo da resposta retorna uma mensagem de exclusão bem-sucedida:

    "The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"

    API aberta do Catálogo de produtos - EXCLUA /sn_tmf_api/catalogmanagement/productOfferingPrice/

    Desativa, mas não exclui, uma linha de lista de preços com um sys_id específico.

    Para definir uma linha de lista de preços para um estado inativo, este método DE EXCLUSÃO atualiza a data de término da linha da lista de preços para a data de hoje. Uma linha de lista de preços com uma data de término anterior à data de hoje também é considerada inativa. As linhas da lista de preços inativas não podem ser recuperadas nos métodos GET relacionados.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    id Sys_id da linha da lista de preços a ser excluída.

    Tabela: Linha da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

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

    Cabeçalhos

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

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

    Padrão: application/json

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

    Códigos de status

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

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta.
    Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

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

    Nome Descrição
    mensagem Código de status com uma mensagem sobre a inativação bem-sucedida ou com falha da linha da lista de preços.

    Solicitação de curl

    O exemplo a seguir demonstra como desativar ou excluir com sucesso uma lista de preços do sys_id fornecido, 994d...

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
    --request DELETE\
    --user 'username':'password'

    Resposta. A resposta retorna um código de status 200 com detalhes sobre a inativação bem-sucedida.

    Status: 200 OK
    "The price list line (994d5d364f8b5210f899f61d20ce0b7c) is inactive successfully"

    API aberta do Catálogo de produtos - EXCLUA /sn_tmf_api/catalogmanagement/productSpecification/

    Exclui ou arquiva a especificação de produto especificada.

    Ao chamar este método DE EXCLUSÃO, uma especificação de produto pode ser excluída ou arquivada, dependendo do estado em que está:
    • Uma especificação de produto no estado de rascunho foi excluída com sucesso. A resposta retorna uma mensagem de sucesso.
    • Uma especificação de produto no estado arquivado não pode ser excluída. A resposta retorna uma mensagem de que a especificação já está arquivada.
    • Uma especificação de produto que não está no estado de rascunho e associada a outras especificações ou ofertas de produto é arquivada, mas não excluída. A resposta retorna uma mensagem de que a especificação foi movida de um estado ativo para um estado arquivado.
    • Uma especificação de produto associada a uma especificação ou oferta de produto ativa não pode ser excluída. A resposta retorna uma mensagem de erro.

    Formato de URL

    URL padrão: /Sn_tmf_api/catalogmanagement/productSpecification/

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    id Sys_id da especificação do produto a ser excluída.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json

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

    Códigos de status

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

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.

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

    Nome Descrição
    mensagem Uma mensagem de falha ou sucesso sobre a exclusão ou arquivamento da especificação do produto.

    Solicitação de curl

    O exemplo a seguir exclui a especificação do produto com o ID 8ef57fa05b308210235d85cced81c7d8.

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/8ef57fa05b308210235d85cced81c7d8" \ 
    --request DELETE\ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

    O corpo da resposta retorna uma mensagem de sucesso ou falha:

    "The product specification (8ef57fa05b308210235d85cced81c7d8) is successfully deleted"

    API aberta do Catálogo de produtos - OBTENHA /sn_tmf_api/catalogmanagement/catalog

    Recupera uma lista de todos os catálogos de ofertas de produtos.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/catalog

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.

    Tipo de dados: Cadeia de caracteres

    Padrão: Todos os campos retornados.

    limite Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro.

    Tipo de dados: Número

    Padrão: 20

    Máximo: 100

    deslocamento Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Tipo de dados: Número

    Padrão: 0

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

    Cabeçalhos

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

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Intervalo de conteúdo retornado em uma chamada paginada.

    Por exemplo, se deslocamento: 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .

    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    X-Total-Count Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

    Códigos de status

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

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

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    descrição Descrição do catálogo de ofertas de produtos. Retornado somente se o campo contiver um valor.

    Tipo de dados: Cadeia de caracteres

    id Sys_id do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]

    LifeycleStatus Status do ciclo de vida atual da linha da lista de preços.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    nome Nome do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    status Status do catálogo de ofertas de produtos.

    Valor possível: Publicado

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Este exemplo recupera todos os catálogos de ofertas de produtos.

    curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
    --user 'username':'password'
    

    Corpo da resposta.

    [
      {
        "id": "341f4953b71a9910ff00f203ae11a9bb",
        "name": "Home Internet Plan",
        "lifecycleStatus": "Active",
        "status": "published"
      },
      {
        "id": "69f494792b11525047f3f3e30391bf66",
        "name": "Chemical Processing",
        "lifecycleStatus": "Active",
        "description": " Catalog for Chemical Processing Industry",
        "status": "published"
      }
    ]

    API aberta do Catálogo de produtos - OBTER /sn_tmf_api/catalogmanagement/catalog/

    Recupera um catálogo de ofertas de produtos.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/catalog/

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    id Sys_id do catálogo de ofertas de produtos a ser recuperado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]

    Tabela 26. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.

    Tipo de dados: Cadeia de caracteres

    Padrão: Todos os campos.

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

    Cabeçalhos

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

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

    Códigos de status

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

    Tabela 30. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400
    Solicitação Incorreta. Qualquer um dos seguintes motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    descrição Descrição do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    id Sys_id do catálogo de ofertas de produtos .

    Tipo de dados: Cadeia de caracteres

    Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]

    LifeycleStatus Status do ciclo de vida atual da linha da lista de preços.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    nome Nome do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Este exemplo recupera um catálogo de ofertas de produtos para um plano móvel empresarial.

    curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog/69f494792b11525047f3f3e30391bf66" \
    --user 'username':'password'

    Corpo da resposta.

    {
      "id": "69f494792b11525047f3f3e30391bf66",
      "name": "Chemical Processing",
      "lifecycleStatus": "Active",
      "description": " Catalog for Chemical Processing Industry"
    }

    API aberta do Catálogo de produtos - OBTER /sn_tmf_api/catalogmanagement/productOffering

    Recupera todas as ofertas de produto ou um subconjunto de ofertas de produto, com base nas configurações de filtro especificadas.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.
    Campos válidos:
    • categoria
    • canal
    • descrição
    • externalId
    • id
    • internalId
    • InternalVersion
    • LastUpdate
    • nome
    • ProdutorCaracterística
    • ProductOfferingPrice
    • OfertaçãoprodutoTerm
    • ProductSpecification
    • ProdSpecCharValueUse
    • ValidFor
    • versão

    Tipo de dados: Cadeia de caracteres

    Padrão: Todos os campos são retornados.

    limite Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro.

    Tipo de dados: Número

    Padrão: 20

    Máximo: 100

    deslocamento Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Tipo de dados: Número

    Padrão: 0

    especificação Filtrar ofertas de produtos por sys_id de especificação de produto. Somente ofertas de produto com a especificação de produto sys_id especificada são retornadas na resposta.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    estado Filtrar ofertas de produtos por estado. Somente ofertas de produto no estado especificado são retornadas na resposta.

    Valores válidos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: Cadeia de caracteres

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

    Cabeçalhos

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

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 35. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Intervalo de conteúdo retornado em uma chamada paginada.

    Por exemplo, se deslocamento: 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .

    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    X-Total-Count Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

    Códigos de status

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

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

    Parâmetros do corpo da resposta

    Nome Descrição
    BundledGroupProductOffering Grupos secundários de ofertas de produtos. Mostram subagrupamento hierárquico.

    Tipo de dados: Matriz de objetos

    "bundledGroupProductOffering": [
      {
        "bundledGroupProductOfferingOption": {Object},
        "bundledProductOffering": [Array],
        "id": "String",
        "name": "String"
      }
    ]
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption Um intervalo de números que especifica os limites inferior e superior do número da oferta de produto associada que pode ser adquirida como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Objeto

    "bundledGroupProductOfferingOption": {
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledProductOffering Grupos secundários de ofertas de produtos associados ao pacote. Mesmo formato que bundledProductOfferingespecificado abaixo.

    Tipo de dados: Matriz de objetos

    BundledGroupProductOffering. ​id Sys_id do registro do grupo agrupado. Útil nos casos em que a oferta ou grupo de produto primário inclui vários grupos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo de relacionamento da oferta de produto [sn_prd_pm_product_offering_relationship_group]

    BundledGroupProductOffering. ​nome Nome do grupo de ofertas de produtos secundários.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering Lista de ofertas de produtos incluídas no pacote de ofertas de produtos. O pacote de oferta de produto herda todos os atributos das ofertas de produto incluídas.

    Tipo de dados: Matriz de objetos

    "bundledProductOffering": [
      {
        "bundledProductOfferingOption": {Object},
        "externalId": "String",
        "href": "String",
        "id": "String",
        "name": "String",
        "version": Number
      }
    ]
    BundledProductOffering. ​BundledProductOfferingOption Opções de pacote de produtos, como o número padrão de ofertas de produtos e restrições de aquisição de ofertas de produtos superiores e inferiores.

    Tipo de dados: Objeto

    "bundledProductOfferingOption": {
      "numberRelOfferDefault": "String",
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferPadrão Número padrão de ofertas de produto que devem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​ExternalId ID externo do  relacionamento de oferta de produto.

    Para obter informações adicionais sobre relacionamentos de oferta de produto, consulte Create product offering relationships.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​href Link relativo para a oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​id Sys_id ou ID externo da oferta de produto agrupada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    BundledProductOffering. ​nome Nome do pacote de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​versão Versão do catálogo da oferta de produto.  

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].  

    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: Matriz de objetos

    "category:" [
      {
        "id": "String",
        "name": "String"
      }
    ]
    category.id ID da categoria.

    Tipo de dados: Cadeia de caracteres

    category.name Nome da categoria.

    Tipo de dados: Cadeia de caracteres

    canal Canais a serem usados para vender a oferta de produto.

    Tipo de dados: Matriz de objetos

    "channel:" [
      {
        "description": "String",
        "id": "String",
        "name": "String"
      }
    ]
    channel.description Descrição do canal.

    Tipo de dados: Cadeia de caracteres

    channel.id Sys_id do canal.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]

    channel.name Nome do canal.

    Tipo de dados: Cadeia de caracteres

    descrição Descrição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    displayName Nome de exibição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    externalId ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Obrigatório. Versão inicial ou ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    internalId Sys_id ou ID interno do registro de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    InternalVersion Versão da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    IsPacote Sinalizador que indica se a oferta de produto é um pacote.
    Valores possíveis:
    • Verdadeiro: A oferta de produto é um pacote.
    • Falso: Oferta de produto único.

    Tipo de dados: Booliano

    Padrão: falso

    ÉVenível Sinalizador que indica se a oferta de produto associada pode ser vendida sozinha ou deve fazer parte de um pacote de oferta de produto.
    Valores possíveis:
    • Verdadeiro: Pode ser vendido separadamente.
    • Vendido somente como parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    LifeycleStatus Status do ciclo de vida atual da oferta de produto.

    Valores válidos:

    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse Características da oferta do produto.

    Tipo de dados: Matriz de objetos

    "prodSpecCharValueUse": [
       {
          "description": "String",
          "name": "String",
          "productSpecCharacteristicValue": [Array],
          "validFor": {Object},
          "valueType": "String"
       }
    ]
    ProdSpecCharValueUse. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​nome
    Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ValorType Tipo de dados do prodSpecCharValueUse.productSpecCharacteristicValue.valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística Lista de características do produto.

    Tipo de dados: Matriz de objetos

    "productCharacteristic": [
      {
        "name": "String",
        "value": "String"
      }
    ]
    ProdutorCaracterística. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística. ​valor Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic Caraterística de qualidade ou caraterística distintiva de uma oferta de produto. As características podem assumir um valor discreto que é fixado no tempo de design (criação de catálogo), como Classificação do plano para celular. Geralmente, essas características não são modificáveis no nível de inventário.

    Para obter informações adicionais sobre as características da oferta do produto, consulte Create product characteristics and characteristic options.

    Tipo de dados: Matriz de objetos

    productOfferingCharacteristic": [  
      {
        "characteristicValueSpecification": [Array],
        "name": "String",
        "valueType": "String"
      }
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification Lista de valores de características associados à característica de oferta de produto.

    Tipo de dados: Matriz de objetos

    "characteristicValueSpecification": [  
      { 
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "value": "String"
      }  
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica associada.
    Valores possíveis:
    • Verdadeiro: É o valor padrão.
    • Falso: Não é o valor padrão.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​É Obrigatório Sinalizador que indica se o valor da característica associada é obrigatório para a característica associada.
    Valores possíveis:
    • Verdadeiro: É obrigatório.
    • Falso: Não é obrigatório.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​valor Número ou texto atribuído à característica de especificação do produto associada .
    Por exemplo:
    "characteristicValueSpecification": [
      {
        "value": "choice 1"
      },
      {
        "value": "choice 2"
      }
    ]

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​nome Nome da característica de oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​ValorType Tipo de dados do productOfferingCharacteristic.​characteristicValueSpecification.​valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice Informações de preço da oferta do produto.

    Tipo de dados: Matriz de objetos

    "productOfferingPrice": [
      {
        "price": {Object},
        "priceType": "String"
      }
    ]
    ProductOfferingPrice. ​preço Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "price": {
      "taxIncludedAmount": {Object}
    }
    ProductOfferingPrice. ​price.taxIncludedAmount Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "taxIncludedAmount": {
      "unit": "String",
      "value": "String"
    }
    ProductOfferingPrice.price.​TaxIncludedAmount.unit Código da moeda do preço de oferta do produto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice.price.​TaxIncludedAmount.value Preço da oferta do produto, incluindo imposto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice. ​PriceType Preço de oferta de produto, pagamento único ou recorrente.
    Valores possíveis:
    • Não recorrente (uma vez)
    • recorrente

    Tipo de dados: Cadeia de caracteres

    OfertaçãoprodutoTerm Duração válida do termo do contrato para a oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecification Especificação do produto.

    Tipo de dados: Objeto

    "productSpecification": {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
    }
    ProductSpecification. ​id Sys_id do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalId Sys_id ou ID interno do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​nome Nome da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de nome da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    status Status da oferta de produto.
    Valores possíveis:
    • rascunho
    • publicado

    Tipo de dados: Cadeia de caracteres

    ValidFor Intervalo de datas para o qual a oferta de produto é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​​EndDateTime Data de término da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: YYY-MM-DD

    ValidFor.startDateTime Data de início da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: YYY-MM-DD

    versão Versão externa da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    O exemplo de código a seguir recupera os dois primeiros registros de oferta de produto.

    curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering?limit=2" \
    --header "Accept:application/json" \
    --user 'username':'password'

    Corpo da resposta:

    [
      {
        "id": "7b012c4d41ea7910f8771355f12634a4",
        "externalId": "7b012c4d41ea7910f8771355f12634a4",
        "href": "/api/sn_tmf_api/catalogmanagement/productOffering/0361dd9fd0a63110f8770dbf976be16f",
        "name": "Ultimate internet - 1Gbps Plan",
        "displayName": "Ultimate internet - 1Gbps Plan",
        "description": "Ultimate internet - 1Gbps Plan",
        "isSellable": true,
        "lifecycleStatus": "Active",
        "isBundle": false,
        "lastUpdate": "2025-03-08 02:07:04",
        "version": "",
        "internalVersion": "1",
        "internalId": "0361dd9fd0a63110f8770dbf976be16f",
        "validFor": {
          "startDateTime": "2023-11-14",
          "endDateTime": ""
        },
        "productOfferingTerm": "not_applicable",
        "productOfferingPrice": [
          {
            "priceType": "recurring",
            "price": {
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 0
              }
            }
          },
          {
            "priceType": "nonRecurring",
            "price": {
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 0
              }
            }
          }
        ],
        "productOfferingCharacteristic": "",
        "bundledProductOffering": [],
        "bundledGroupProductOffering": [],
        "productSpecification": {},
        "prodSpecCharValueUse": [],
        "channel": "",
        "category": [
          {
            "id": "e6f0159fd0a63110f8770dbf976be18c",
            "name": "Internet"
          }
        ],
        "status": "published"
      },
      {
        "id": "313b917843235210a82ed6085bb8f2c7",
        "externalId": "313b917843235210a82ed6085bb8f2c7",
        "href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
        "name": "Internet bundle",
        "displayName": "Internet bundle",
        "description": "Internet bundle",
        "isSellable": false,
        "lifecycleStatus": "Draft",
        "isBundle": true,
        "lastUpdate": "2025-04-09 15:59:09",
        "version": "",
        "internalVersion": "1",
        "internalId": "03c99cb53bf066509b48d69a04e45a11",
        "validFor": {
          "startDateTime": "2028-12-15",
          "endDateTime": "2034-01-14"
        },
        "productOfferingTerm": "not_applicable",
        "productOfferingPrice": [
          {
            "priceType": "recurring",
            "price": {
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 0
              }
            }
          },
          {
            "priceType": "nonRecurring",
            "price": {
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 0
              }
            }
          }
        ],
        "productOfferingCharacteristic": [
          {
            "name": "Connectivity need",
            "valueType": "choice",
            "characteristicValueSpecification": [
              {
                "isMandatory": false,
                "isDefault": false,
                "value": "When in use"
              }
            ]
          },
          {
            "name": "Firewall Security",
            "valueType": "choice",
            "characteristicValueSpecification": [
              {
                "isMandatory": false,
                "isDefault": true,
                "value": "Premium"
              }
            ]
          }
        ],
        "bundledProductOffering": [
          {
            "href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
            "id": "0f61dd9fd0a63110f8770dbf976be168",
            "externalId": "EXT-123",
            "name": "Solana Sports streaming channel",
            "version": "1",
            "bundledProductOfferingOption": {
              "numberRelOfferDefault": "1",
              "numberRelOfferLowerLimit": "1",
              "numberRelOfferUpperLimit": "1"
            }
          }
        ],
        "bundledGroupProductOffering": [
          {
            "id": "063b957843235210a82ed6085bb8f205",
            "name": "Streaming Channel",
            "bundledProductOffering": [
              {
                "href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
                "id": "62619d9fd0a63110f8770dbf976be180",
                "externalId": "EXT-345",
                "name": "Solana Movie streaming channel",
                "version": "1",
                "bundledProductOfferingOption": {
                  "numberRelOfferDefault": "1",
                  "numberRelOfferLowerLimit": "1",
                  "numberRelOfferUpperLimit": "1"
                }
              }
            ],
            "bundledGroupProductOfferingOption": {
              "numberRelOfferLowerLimit": "1",
              "numberRelOfferUpperLimit": "1"
            }
          }
        ],
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "version": "",
          "internalVersion": "3",
          "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
        },
        "prodSpecCharValueUse": [
          {
            "name": "Tenancy",
            "description": "Tenancy",
            "valueType": "choice",
            "validFor": {
              "startDatetime": "2025-02-27 21:04:24"
            },
            "productSpecCharacteristicValue": [
              {
                "value": "Premium (>50 sites)",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": false
              },
              {
                "value": "Base (10 site)",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": false
              }
            ],
            "productSpecification": {
              "id": "216663aa53702010cd6dddeeff7b12b5",
              "name": "SD-WAN Controller",
              "version": "",
              "internalVersion": "1",
              "internalId": "216663aa53702010cd6dddeeff7b12b5"
            }
          }
        ],
        "channel": [
          {
            "id": "58ad5522c3702010df4773ce3640ddb2",
            "name": "Agent Assist"
          }
        ],
        "category": [
          {
            "id": "13e305a143b631105029d1529ab8f267",
            "name": "SD-WAN_all_offers"
          }
        ],
        "status": "draft"
      }
    ]

    API aberta do Catálogo de produtos - OBTER /sn_tmf_api/catalogmanagement/productOffering/

    Recupera uma oferta de produto.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering/

    Parâmetros de solicitação compatíveis

    Tabela 37. Parâmetros de caminho
    Nome Descrição
    id Versão inicial da oferta de produto a ser recuperada.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tabela 38. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.
    Campos válidos:
    • categoria
    • canal
    • descrição
    • externalId
    • id
    • internalId
    • InternalVersion
    • LastUpdate
    • nome
    • ProdutorCaracterística
    • ProductOfferingPrice
    • OfertaçãoprodutoTerm
    • ProductSpecification
    • ProdSpecCharValueUse
    • ValidFor
    • versão

    Tipo de dados: Cadeia de caracteres

    Padrão: Todos os campos são retornados.

    especificação Filtrar ofertas de produtos por sys_id de especificação de produto. Somente ofertas de produto com a especificação de produto sys_id especificada são retornadas na resposta.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    estado Filtrar ofertas de produtos por estado. Somente ofertas de produto no estado especificado são retornadas na resposta.

    Valores válidos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: Cadeia de caracteres

    Tabela 39. Parâmetros do corpo da solicitação
    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 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 41. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 42. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400
    Solicitação incorreta. Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

    Parâmetros do corpo da resposta

    Nome Descrição
    BundledGroupProductOffering Grupos secundários de ofertas de produtos. Mostram subagrupamento hierárquico.

    Tipo de dados: Matriz de objetos

    "bundledGroupProductOffering": [
      {
        "bundledGroupProductOfferingOption": {Object},
        "bundledProductOffering": [Array],
        "id": "String",
        "name": "String"
      }
    ]
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption Um intervalo de números que especifica os limites inferior e superior do número da oferta de produto associada que pode ser adquirida como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Objeto

    "bundledGroupProductOfferingOption": {
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledProductOffering Grupos secundários de ofertas de produtos associados ao pacote. Mesmo formato que bundledProductOfferingespecificado abaixo.

    Tipo de dados: Matriz de objetos

    BundledGroupProductOffering. ​id Sys_id do registro do grupo agrupado. Útil nos casos em que a oferta ou grupo de produto primário inclui vários grupos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo de relacionamento da oferta de produto [sn_prd_pm_product_offering_relationship_group]

    BundledGroupProductOffering. ​nome Nome do grupo de ofertas de produtos secundários.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering Lista de ofertas de produtos incluídas no pacote de ofertas de produtos. O pacote de oferta de produto herda todos os atributos das ofertas de produto incluídas.

    Tipo de dados: Matriz de objetos

    "bundledProductOffering": [
      {
        "bundledProductOfferingOption": {Object},
        "externalId": "String",
        "href": "String",
        "id": "String",
        "name": "String",
        "version": Number
      }
    ]
    BundledProductOffering. ​BundledProductOfferingOption Opções de pacote de produtos, como o número padrão de ofertas de produtos e restrições de aquisição de ofertas de produtos superiores e inferiores.

    Tipo de dados: Objeto

    "bundledProductOfferingOption": {
      "numberRelOfferDefault": "String",
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferPadrão Número padrão de ofertas de produto que devem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​ExternalId ID externo do  relacionamento de oferta de produto.

    Para obter informações adicionais sobre relacionamentos de oferta de produto, consulte Create product offering relationships.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​href Link relativo para a oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​id Sys_id ou ID externo da oferta de produto agrupada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    BundledProductOffering. ​nome Nome do pacote de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​versão Versão do catálogo da oferta de produto.  

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].  

    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: Matriz de objetos

    "category:" [
      {
        "id": "String",
        "name": "String"
      }
    ]
    category.id Sys_id da categoria.

    Tipo de dados: Cadeia de caracteres

    category.name Nome da categoria.

    Tipo de dados: Cadeia de caracteres

    canal Canais a serem usados para vender a oferta de produto.

    Tipo de dados: Matriz de objetos

    "channel:" [
      {
        "description": "String",
        "id": "String",
        "name": "String"
      }
    ]
    canal. ​descrição Descrição do canal.

    Tipo de dados: Cadeia de caracteres

    channel.id Sys_id do canal.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]

    channel.name Nome do canal.

    Tipo de dados: Cadeia de caracteres

    descrição Descrição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    displayName Nome de exibição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    externalId ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Obrigatório. Versão inicial ou ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    internalId Sys_id ou ID interno do registro de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    InternalVersion Versão da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    IsPacote Sinalizador que indica se a oferta de produto é um pacote.
    Valores possíveis:
    • Verdadeiro: A oferta de produto é um pacote.
    • Falso: Oferta de produto único.

    Tipo de dados: Booliano

    Padrão: falso

    ÉVenível Sinalizador que indica se a oferta de produto associada pode ser vendida sozinha ou deve fazer parte de um pacote de oferta de produto.
    Valores possíveis:
    • Verdadeiro: Pode ser vendido separadamente.
    • Vendido somente como parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH-MM-SS

    LifeycleStatus Status do ciclo de vida atual da oferta de produto.
    Valores possíveis:
    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse Características da oferta do produto.

    Tipo de dados: Matriz de objetos

    "prodSpecCharValueUse": [
       {
          "description": "String",
          "name": "String",
          "productSpecCharacteristicValue": [Array],
          "validFor": {Object},
          "valueType": "String"
       }
    ]
    ProdSpecCharValueUse. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​nome
    Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ValorType Tipo de dados do prodSpecCharValueUse.productSpecCharacteristicValue.valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística Lista de características do produto.

    Tipo de dados: Matriz de objetos

    "productCharacteristic": [
       {
          "name": "String",
          "value": "String"
       }
    ]
    ProdutorCaracterística. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística. ​valor Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic Caraterística de qualidade ou caraterística distintiva de uma oferta de produto. As características podem assumir um valor discreto que é fixado no tempo de design (criação de catálogo), como Classificação do plano para celular. Geralmente, essas características não são modificáveis no nível de inventário.

    Para obter informações adicionais sobre as características da oferta do produto, consulte Create product characteristics and characteristic options.

    Tipo de dados: Matriz de objetos

    productOfferingCharacteristic": [  
      {
        "characteristicValueSpecification": [Array],
        "name": "String",
        "valueType": "String"
      }
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification Lista de valores de características associados à característica de oferta de produto.

    Tipo de dados: Matriz de objetos

    "characteristicValueSpecification": [  
      { 
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "value": "String"
      }  
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica associada.
    Valores possíveis:
    • Verdadeiro: É o valor padrão.
    • Falso: Não é o valor padrão.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​É Obrigatório Sinalizador que indica se o valor da característica associada é obrigatório para a característica associada.
    Valores possíveis:
    • Verdadeiro: É obrigatório.
    • Falso: Não é obrigatório.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​valor Número ou texto atribuído à característica de especificação do produto associada .
    Por exemplo:
    "characteristicValueSpecification": [
      {
        "value": "choice 1"
      },
      {
        "value": "choice 2"
      }
    ]

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​nome Nome da característica de oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​ValorType Tipo de dados do productOfferingCharacteristic.​characteristicValueSpecification.​valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice Informações de preço da oferta do produto.

    Tipo de dados: Matriz de objetos

    "productOfferingPrice": [
       {
          "price": {Object},
          "priceType": "String"
       }
    ]
    ProductOfferingPrice. ​preço Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "price": {
       "taxIncludedAmount": {Object}
    }
    ProductOfferingPrice. ​preço. ​TaxIncludedAmount Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "taxIncludedAmount": {
       "unit": "String",
       "value": "String"
    }
    ProductOfferingPrice. ​preço. ​TaxIncludedAmount. ​unidade Código da moeda do preço de oferta do produto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice. ​preço. ​TaxIncludedAmount. ​valor Preço da oferta do produto, incluindo imposto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice. ​PriceType Identifica se o preço da oferta do produto é um pagamento único ou recorrente.
    Valores possíveis:
    • Não recorrente
    • recorrente

    Tipo de dados: Cadeia de caracteres

    OfertaçãoprodutoTerm Duração válida do termo do contrato para a oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecification Especificação do produto.

    Tipo de dados: Objeto

    "productSpecification": {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
    }
    ProductSpecification. ​id Sys_id do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalId Sys_id ou ID interno do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​nome Nome da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de nome da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    status Status da oferta de produto.
    Valores possíveis:
    • rascunho
    • publicado

    Tipo de dados: Cadeia de caracteres

    ValidFor Intervalo de datas para o qual a oferta de produto é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data de término da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    ValidFor. ​StartDateTime Data de início da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    versão Versão externa da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    Solicitação de curl

    Este exemplo recupera a oferta de produto especificada.

    curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11" 
    --user 'username':'password'

    Corpo da resposta:

    {
      "id": "313b917843235210a82ed6085bb8f2c7",
      "externalId": "313b917843235210a82ed6085bb8f2c7",
      "href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
      "name": "Internet bundle",
      "displayName": "Internet bundle",
      "description": "Internet bundle",
      "isSellable": false,
      "lifecycleStatus": "Draft",
      "isBundle": true,
      "lastUpdate": "2025-04-09 15:59:09",
      "version": "",
      "internalVersion": "1",
      "internalId": "03c99cb53bf066509b48d69a04e45a11",
      "validFor": {
        "startDateTime": "2028-12-15",
        "endDateTime": "2034-01-14"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
        {
          "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 0
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 0
            }
          }
        }
      ],
      "productOfferingCharacteristic": [
        {
          "name": "Connectivity need",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "isMandatory": false,
              "isDefault": false,
              "value": "When in use"
            }
          ]
        },
        {
          "name": "Firewall Security",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "isMandatory": false,
              "isDefault": true,
              "value": "Premium"
            }
          ]
        }
      ],
      "bundledProductOffering": [
        {
          "href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
          "id": "0f61dd9fd0a63110f8770dbf976be168",
          "externalId": "EXT-123",
          "name": "Solana Sports streaming channel",
          "version": "1",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOffering": [
        {
          "id": "063b957843235210a82ed6085bb8f205",
          "name": "Streaming Channel",
          "bundledProductOffering": [
            {
              "href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
              "id": "62619d9fd0a63110f8770dbf976be180",
              "externalId": "EXT-345",
              "name": "Solana Movie streaming channel",
              "version": "1",
              "bundledProductOfferingOption": {
                "numberRelOfferDefault": "1",
                "numberRelOfferLowerLimit": "1",
                "numberRelOfferUpperLimit": "1"
              }
            }
          ],
          "bundledGroupProductOfferingOption": {
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "version": "",
        "internalVersion": "3",
        "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
        {
          "name": "Tenancy",
          "description": "Tenancy",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2025-02-27 21:04:24"
          },
          "productSpecCharacteristicValue": [
            {
              "value": "Premium (>50 sites)",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "Base (10 site)",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
          }
        }
      ],
      "channel": [
        {
          "id": "58ad5522c3702010df4773ce3640ddb2",
          "name": "Agent Assist"
        }
      ],
      "category": [
        {
          "id": "13e305a143b631105029d1529ab8f267",
          "name": "SD-WAN_all_offers"
        }
      ],
      "status": "draft"
    }

    API aberta do Catálogo de produtos - OBTER /sn_tmf_api/catalogmanagement/productOfferingPrice

    Recupera todos os registros de linha da lista de preços na instância.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOfferingPrice

    Parâmetros de solicitação compatíveis

    Tabela 43. Parâmetros de caminho
    Nome Descrição
    nenhum
    Tabela 44. Parâmetros de consulta
    Nome Descrição
    LastUpdate Filtrar resultados pela data em que a linha de preço foi atualizada pela última vez.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    nome Filtrar linhas da lista de preços que pertencem ao nome de uma determinada lista de preços.

    Tabela: Listas de preços [sn_csm_pricing_price_list]

    Tipo de dados: Cadeia de caracteres

    valor.preço Filtre os resultados por um valor de preço de lista específico.

    Tipo de dados: Cadeia de caracteres

    priceList.id Filtre os resultados para retornar somente uma lista de preços com um sys_id fornecido.

    Tabela: Listas de preços [sn_csm_pricing_price_list]

    Tipo de dados: Cadeia de caracteres

    PriceType Filtre os resultados pelo método de preço da oferta de produto.
    Valores válidos:
    • Recorrente: Permite que as empresas cobrem valores de preço recorrentes com uma frequência especificada.
    • One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​id Filtre a linha da lista de preços pelo sys_id da oferta de produto.

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​id Filtre a linha da lista de preços por sys_id da unidade de medida.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​EndDateTime Filtre a linha da lista de preços por uma determinada data e hora de término.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​StartDateTime Filtrar linha da lista de preços por uma determinada data e hora de início.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

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

    Cabeçalhos

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

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

    Códigos de status

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

    Tabela 48. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta.
    Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

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

    Nome Descrição
    . Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice .

    Tipo de dados: Cadeia de caracteres

    href URL para o registro de linha da lista de preços na instância.

    Tipo de dados: Cadeia de caracteres

    id Sys_id da linha da lista de preços.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    IsPacote Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A linha da lista de preços faz parte de um pacote.
    • Falso: A linha da lista de preços não faz parte de um pacote.

    Tipo de dados: Booliano

    LastUpdate Data e hora em que a linha da lista de preços foi atualizada pela última vez.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    LifeycleStatus Status do ciclo de vida atual da linha da lista de preços.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    preço Detalhes do preço de lista da linha da lista de preços.

    Tipo de dados: Objeto

    "price": {
      "units": "String",
      "value": "String"
    }
    price.units Código da moeda do preço. Por exemplo, USD ou EUR .

    Moeda [fx_currency]

    Tipo de dados: Cadeia de caracteres

    valor.preço Valor do preço.

    Tipo de dados: Cadeia de caracteres (representada por um número)

    priceList Informações da lista de preços associadas à linha da lista de preços.

    Tipo de dados: Objeto

    "priceList": {
      "id": "String",
      "name": "String",
      "@type": "String"
    }
    Lista de preços.id Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list].

    Tipo de dados: Cadeia de caracteres

    priceList.name Nome da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Tipo de lista de preços O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços .

    Tipo de dados: Cadeia de caracteres

    PriceType O método de preço da oferta de produto associado a esta linha de lista de preços.
    Valores possíveis:
    • Recorrente: Cobra valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança.
    • One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    productOffering Oferta de produto associada à linha da lista de preços.

    Tipo de dados: Objeto

    "productOffering": {
      "id": "String",
      "name": "String",
      "internalVersion": "String"
    }
    ProductOffering.id Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​InternalVersion Número da versão interna da oferta do produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​nome Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    RecurringChargePeriodType A periodicidade ou frequência da oferta de produto associada a esta linha de lista de preços. Retorna um tipo de frequência se priceTypedefinido como recorrente caso contrário, retornará uma cadeia de caracteres vazia.
    Valores possíveis:
    • anualmente
    • mensal

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure Detalhes sobre a unidade de medida associada à linha da lista de preços.

    Tipo de dados: Objeto

    "unitOfMeasure": {
      "id": "String",
      "amount": Number,
      "units": "String"
    }
    UnitOfMeasure.Amount Valor da unidade de medida.

    Tipo de dados: Número

    UnitOfMeasure.id Sys_id da unidade de medida.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​unidades Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote .

    Tipo de dados: Cadeia de caracteres

    ValidFor A duração de tempo em que a linha da lista de preços é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDate": "String",
      "startDate": "String"
    }
    ValidFor.endDate Data e hora de término para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.StartDate Data e hora de início para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    Solicitação de curl

    O exemplo a seguir retorna todas as duas linhas de lista de preços existentes na instância.

    curl "http://instance.servicenow.com/api/sn_tmf_api/ catalogmanagement/productOfferingPrice " \
    --request GET\
    --user 'username':'password'

    Corpo da resposta.

    [
      {
        "id": "2c4628ac7f4f9e50f8994fa63c86653c",
        "name": "new Price list",
        "lastUpdate": "2025-01-08 19:57:28",
        "isBundle": false,
        "lifecycleStatus": "Draft",
        "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/2c4628ac7f4f9e50f8994fa63c86653c",
        "validFor": {
          "startDateTime": "2027-03-22 22:15:58",
          "endDateTime": ""
        },
        "productOffering": {
          "id": "f2c92ac6a5260210f8774c9b4be6ce56",
          "name": "Managed Connectivity Services Supreme Bundle",
          "internalVersion": "1"
        },
        "priceType": "one_time",
        "recurringChargePeriodType": "",
        "unitOfMeasure": {
          "id": "9a7a119953020110286eddeeff7b1238",
          "amount": 1,
          "units": "Month"
        },
        "price": {
          "units": "USD",
          "value": "800"
        },
        "priceList": {
          "id": "d653246c7f4f9e50f8994fa63c86655a",
          "name": "new Price list",
          "@type": "priceList"
        },
        "@type": "ProductOfferingPrice"
      },
      {
        "id": "dfb7ec607f8f9e50f8994fa63c866569",
        "name": "new Price list",
        "lastUpdate": "2025-01-08 19:57:46",
        "isBundle": false,
        "lifecycleStatus": "Draft",
        "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
        "validFor": {
          "startDateTime": "2026-05-28 22:15:58",
          "endDateTime": ""
        },
        "productOffering": {
          "id": "f2c92ac6a5260210f8774c9b4be6ce56",
          "name": "Managed Connectivity Services Supreme Bundle",
          "internalVersion": "1"
        },
        "priceType": "one_time",
        "recurringChargePeriodType": "",
        "unitOfMeasure": {
          "id": "1eaa559953020110286eddeeff7b12c7",
          "amount": 1,
          "units": "Year"
        },
        "price": {
          "units": "USD",
          "value": "800"
        },
        "priceList": {
          "id": "d653246c7f4f9e50f8994fa63c86655a",
          "name": "new Price list",
          "@type": "priceList"
        },
        "@type": "ProductOfferingPrice"
      }
    ]

    API aberta do Catálogo de produtos - OBTER /sn_tmf_api/catalogmanagement/productOfferingPrice/

    Recupere detalhes sobre uma linha de lista de preços específica.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/

    Parâmetros de solicitação compatíveis

    Tabela 49. Parâmetros de caminho
    Nome Descrição
    id Obrigatório. Sys_id da linha da lista de preços a ser recuperada.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    Tabela 50. Parâmetros de consulta
    Nome Descrição
    LastUpdate Filtrar resultados pela data em que a linha de preço foi atualizada pela última vez.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    nome Filtrar linhas da lista de preços que pertencem ao nome de uma determinada lista de preços.

    Tabela: Listas de preços [sn_csm_pricing_price_list]

    Tipo de dados: Cadeia de caracteres

    valor.preço Filtre os resultados por um valor de preço de lista específico.

    Tipo de dados: Cadeia de caracteres

    priceList.id Filtre os resultados para retornar somente uma lista de preços com um sys_id fornecido.

    Tabela: Listas de preços [sn_csm_pricing_price_list]

    Tipo de dados: Cadeia de caracteres

    PriceType Filtre os resultados pelo método de preço da oferta de produto.
    Valores válidos:
    • Recorrente: Permite que as empresas cobrem valores de preço recorrentes com uma frequência especificada.
    • One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​id Filtre a linha da lista de preços pelo sys_id da oferta de produto.

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​id Filtre a linha da lista de preços por sys_id da unidade de medida.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​EndDateTime Filtre a linha da lista de preços por uma determinada data e hora de término.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​StartDateTime Filtrar linha da lista de preços por uma determinada data e hora de início.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

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

    Cabeçalhos

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

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

    Códigos de status

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

    Tabela 54. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta.
    Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

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

    Nome Descrição
    . Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice .

    Tipo de dados: Cadeia de caracteres

    href URL para o registro de linha da lista de preços na instância.

    Tipo de dados: Cadeia de caracteres

    id Sys_id da linha da lista de preços.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    IsPacote Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A linha da lista de preços faz parte de um pacote.
    • Falso: A linha da lista de preços não faz parte de um pacote.

    Tipo de dados: Booliano

    LastUpdate Data e hora em que a linha da lista de preços foi atualizada pela última vez.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    LifeycleStatus Status do ciclo de vida atual da linha da lista de preços.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    preço Detalhes do preço de lista da linha da lista de preços.

    Tipo de dados: Objeto

    "price": {
      "units": "String",
      "value": "String"
    }
    price.units Código da moeda do preço. Por exemplo, USD ou EUR .

    Moeda [fx_currency]

    Tipo de dados: Cadeia de caracteres

    valor.preço Valor do preço.

    Tipo de dados: Cadeia de caracteres (representada por um número)

    priceList Informações da lista de preços associadas à linha da lista de preços.

    Tipo de dados: Objeto

    "priceList": {
      "id": "String",
      "name": "String",
      "@type": "String"
    }
    Lista de preços.id Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list].

    Tipo de dados: Cadeia de caracteres

    priceList.name Nome da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Tipo de lista de preços O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços .

    Tipo de dados: Cadeia de caracteres

    PriceType O método de preço da oferta de produto associado a esta linha de lista de preços.
    Valores possíveis:
    • Recorrente: Cobra valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança.
    • One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    productOffering Oferta de produto associada à linha da lista de preços.

    Tipo de dados: Objeto

    "productOffering": {
      "id": "String",
      "name": "String",
      "internalVersion": "String"
    }
    ProductOffering.id Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​InternalVersion Número da versão interna da oferta do produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​nome Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    RecurringChargePeriodType A periodicidade ou frequência da oferta de produto associada a esta linha de lista de preços. Retorna um tipo de frequência se priceTypedefinido como recorrente caso contrário, retornará uma cadeia de caracteres vazia.
    Valores possíveis:
    • anualmente
    • mensal

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure Detalhes sobre a unidade de medida associada à linha da lista de preços.

    Tipo de dados: Objeto

    "unitOfMeasure": {
      "id": "String",
      "amount": Number,
      "units": "String"
    }
    UnitOfMeasure.Amount Valor da unidade de medida.

    Tipo de dados: Número

    UnitOfMeasure.id Sys_id da unidade de medida.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​unidades Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote .

    Tipo de dados: Cadeia de caracteres

    ValidFor A duração de tempo em que a linha da lista de preços é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDate": "String",
      "startDate": "String"
    }
    ValidFor.endDate Data e hora de término para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.StartDate Data e hora de início para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    Solicitação de curl

    O exemplo a seguir retorna detalhes do preço de oferta do produto com ID dfb7ec60...

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569" \
    --request GET\
    --user 'username':'password'

    Resposta.

    {
      "id": "dfb7ec607f8f9e50f8994fa63c866569",
      "name": "new Price list",
      "lastUpdate": "2025-01-08 19:57:46",
      "isBundle": false,
      "lifecycleStatus": "Draft",
      "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
      "validFor": {
        "startDateTime": "2026-05-28 22:15:58",
        "endDateTime": ""
      },
      "productOffering": {
        "id": "f2c92ac6a5260210f8774c9b4be6ce56",
        "name": "Managed Connectivity Services Supreme Bundle",
        "internalVersion": "1"
      },
      "priceType": "one_time",
      "recurringChargePeriodType": "",
      "unitOfMeasure": {
        "id": "1eaa559953020110286eddeeff7b12c7",
        "amount": 1,
        "units": "Year"
      },
      "price": {
        "units": "USD",
        "value": "800"
      },
      "priceList": {
        "id": "d653246c7f4f9e50f8994fa63c86655a",
        "name": "new Price list",
        "@type": "priceList"
      },
      "@type": "ProductOfferingPrice"
    }

    API aberta do Catálogo de produtos - OBTER /sn_tmf_api/catalogmanagement/productSpecification

    Recupera todos os registros de especificação do produto.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productSpecification

    Parâmetros de solicitação compatíveis

    Tabela 55. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 56. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.
    Campos válidos:
    • descrição
    • externalId
    • id
    • internalId
    • InternalVersion
    • LastUpdate
    • nome
    • ProductSpecCharacteristic
    • ProductSpecificationRelationship
    • ResourceSpecification
    • ServiceSpecification
    • ValidFor
    • versão

    Tipo de dados: Cadeia de caracteres

    Padrão: Todos os campos são retornados.

    limite Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro.

    Tipo de dados: Número

    Padrão: 20

    Máximo: 100

    deslocamento Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Tipo de dados: Número

    Padrão: 0

    estado Filtrar especificações do produto por estado. Somente as especificações do produto no estado especificado são retornadas na resposta.

    Valores aceitos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: Cadeia de caracteres

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

    Cabeçalhos

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

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

    Padrão: application/json

    Tabela 59. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Intervalo de conteúdo retornado em uma chamada paginada.

    Por exemplo, se deslocamento: 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .

    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    X-Total-Count Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

    Códigos de status

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

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

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    descrição Descrição da especificação.

    Tipo de dados: Cadeia de caracteres

    displayName Nome de exibição da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    externalId
    ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Sys_id ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    internalId
    Sys_id ou ID interno da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].

    IsPacote Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos.
    Valores possíveis:
    • Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos.
    • Falso: A especificação do produto contém um único produto.
    Tipo de dados: Booliano
    LastUpdate Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    LifeycleStatus Status do ciclo de vida atual da especificação do produto.

    Valores possíveis:

    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: Cadeia de caracteres

    nome Nome da especificação.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic Característica de especificação do produto.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristic": [
      {
        "description": "String",
        "name": "String",
        "productSpecCharacteristicValue": [Array],
        "validFor": {Object},
        "valueType": "String"
      }
    ]
    ProductSpecCharacteristic. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor. ​​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser do tipo complexo ou não complexo.

    Tipo de dados: Cadeia de caracteres

    Valores aceitos:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Teste de linha única
    • Array.Object
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha
    ProductSpecificationRelationship Relações desta especificação com outras especificações de produto.

    Tipo de dados: Matriz de objetos

    "productSpecificationRelationship": [
      {
        "compatibilityRelationshipType": "String",
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "prodSpecRelationshipOption": {Object},
        "type": "String",
        "validFor": {Object},
        "version": "String"
    ]
    ProductSpecificationRelationship. ​RelationshipType Tipo de relacionamento de compatibilidade nos valores esperados da especificação do produto.

    Para obter informações adicionais sobre relacionamentos de compatibilidade, consulte Configuring compatibility rules for horizontal relationships.

    Tabela: Compatíveis [sn_compt_mgmt_compatibles]

    ProductSpecificationRelationship​.id Sys_id da especificação relacionada.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​InternalId Sys_id (ID interno) do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​InternalVersion Versão do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​nome Nome do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ProdSpecRelationshipOption Cardinalidade do relacionamento de especificação do produto.

    Tipo de dados: Objeto

    "prodSpecRelationshipOption": {
      "numberSpecRelDefault": "String",
      "numberSpecRelLowerLimit": "String",
      "numberSpecRelUpperLimit": "String"
    }
    ProductSpecificationRelationship. ​ProdSpecRelationshipOption. ​NumberSpecRelDefault Valor padrão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ProdSpecRelationshipOption. ​NumberSpecRelLowLimit Número mínimo de pedidos que podem ser comprados.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ProdSpecRelationshipOption. ​NumberSpecRelUpperLimit Número máximo de pedidos que podem ser comprados.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​tipo Tipo de relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor Intervalo de datas para o qual o relacionamento de especificação do produto é válido.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecificationRelationship. ​ValidFor. ​EndDateTime Data de término do relacionamento.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor. ​StartDateTime Data de início do relacionamento.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​versão Versão do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Lista de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "resourceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ResourceSpecification. ​id Sys_id ou ID externo da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalId Versão inicial (sys_id) do registro de especificação de recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalVersion Versão da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​nome Nome da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de recurso [sn_prd_pm_resource_specification]

    ResourceSpecification. ​versão Versão externa da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ServiceSpecification Lista de especificações de serviço relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "serviceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ServiceSpecification. ​id Versão inicial ou ID externo da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalId Versão inicial da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalVersion Versão da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​nome Nome da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    ServiceSpecification. ​versão Versão externa da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    status Status da especificação do produto.
    Valores possíveis:
    • rascunho
    • publicado

    Tipo de dados: Cadeia de caracteres

    ValidFor Intervalo de datas para o qual a especificação é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data de término da especificação.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    ValidFor. ​StartDateTime Data de início da especificação.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    Solicitação de curl

    Este exemplo recupera os dois primeiros registros de especificação do produto.

    curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification?limit=2" \
    --header "Accept:application/json" \
    --user 'username':'password'
    

    Corpo da resposta:

    [
      {
        "id": "0435b48a742e4a10f877468e695efa3c",
        "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/0435b48a742e4a10f877468e695efa3c",
        "name": "Managed PoS PS",
        "displayName": "Managed PoS PS",
        "version": "",
        "internalVersion": "1",
        "internalId": "0435b48a742e4a10f877468e695efa3c",
        "description": "Managed PoS PS",
        "lastUpdate": "2032-09-26 20:07:12",
        "lifecycleStatus": "Active",
        "isBundle": false,
        "validFor": {
          "startDateTime": "2032-09-26",
          "endDateTime": ""
        },
        "serviceSpecification": [],
        "productSpecificationRelationship": [],
        "resourceSpecification": [],
        "productSpecCharacteristic": [
          {
            "productSpecCharacteristicValue": [
              {
                "value": "4",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": true
              },
              {
                "value": "2",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": true
              },
              {
                "value": "1",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": true
              }
            ],
            "name": "Number of POS Terminals",
            "description": "Number of POS Terminals",
            "valueType": "choice",
            "validFor": {
              "startDatetime": "2024-05-31 21:43:14"
            }
          },
          {
            "productSpecCharacteristicValue": [
              {
                "value": "Gold",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": true
              },
              {
                "value": "Bronze",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": true
              },
              {
                "value": "Silver",
                "validFor": {
                  "startDateTime": ""
                },
                "isDefault": false,
                "isMandatory": true
              }
            ],
            "name": "Managed Service Level",
            "description": "Managed Service Level",
            "valueType": "choice",
            "validFor": {
              "startDatetime": "2024-05-31 21:15:24"
            }
          }
        ],
        "status": "published"
      },
      {
        "id": "1a0936f840102610f87798b149fd435d",
        "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/1a0936f840102610f87798b149fd435d",
        "name": "Wi-Fi Configuration Setup Service PS",
        "displayName": "Wi-Fi Configuration Setup Service PS",
        "version": "",
        "internalVersion": "1",
        "internalId": "1a0936f840102610f87798b149fd435d",
        "description": "Wi-Fi Configuration Setup Service PS",
        "lastUpdate": "2025-03-13 21:01:14",
        "lifecycleStatus": "Active",
        "isBundle": false,
        "validFor": {
          "startDateTime": "2025-03-12",
          "endDateTime": ""
        },
        "serviceSpecification": [],
        "productSpecificationRelationship": [],
        "resourceSpecification": [],
        "productSpecCharacteristic": [],
        "status": "published"
      }
    ]

    API aberta do Catálogo de produtos - OBTER /sn_tmf_api/catalogmanagement/productSpecification/

    Recupera um registro de especificação de produto especificado.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productSpecification/

    Parâmetros de solicitação compatíveis

    Tabela 61. Parâmetros de caminho
    Nome Descrição
    Id Sys_id ou versão inicial da especificação do produto a ser recuperada.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tabela 62. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.
    Campos válidos:
    • descrição
    • externalId
    • id
    • internalId
    • InternalVersion
    • LastUpdate
    • nome
    • ProductSpecCharacteristic
    • ProductSpecificationRelationship
    • ResourceSpecification
    • ServiceSpecification
    • ValidFor
    • versão

    Tipo de dados: Cadeia de caracteres

    Padrão: Todos os campos são retornados.

    estado Filtrar especificações do produto por estado. Somente as especificações do produto no estado especificado são retornadas na resposta.

    Valores aceitos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: Cadeia de caracteres

    Tabela 63. Parâmetros do corpo da solicitação
    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 64. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 65. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 66. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400
    Solicitação incorreta. Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    descrição Descrição da especificação.

    Tipo de dados: Cadeia de caracteres

    displayName Nome de exibição da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    externalId
    ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Sys_id ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    internalId
    Sys_id ou ID interno da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].

    IsPacote Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos.
    • Falso: A especificação do produto contém um único produto.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a especificação do produto foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    LifeycleStatus Status do ciclo de vida atual da especificação do produto.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Nome da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic Especificações do produto.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristic": [
      {
        "description": "String",
        "name": "String",
        "productSpecCharacteristicValue": [Array],
        "validFor": {Object},
        "valueType": "String"
      }
    ]
    ProductSpecCharacteristic. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​valor Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser do tipo complexo ou não complexo.

    Tipo de dados: Cadeia de caracteres

    Valores aceitos:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Teste de linha única
    • Array.Object
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha
    ProductSpecificationRelationship Relações desta especificação com outras especificações de produto.

    Tipo de dados: Matriz de objetos

    "productSpecificationRelationship": [
      {
        "compatibilityRelationshipType": "String",
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "prodSpecRelationshipOption": {Object},
        "type": "String",
        "validFor": {Object},
        "version": "String"
    ]
    ProductSpecificationRelationship. ​RelationshipType Tipo de relacionamento de compatibilidade nos valores esperados da especificação do produto.

    Para obter informações adicionais sobre relacionamentos de compatibilidade, consulte Configuring compatibility rules for horizontal relationships.

    Tabela: Compatíveis [sn_compt_mgmt_compatibles]

    ProductSpecificationRelationship​.id Sys_id da especificação relacionada.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​InternalId Sys_id (ID interno) do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​InternalVersion Versão do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​nome Nome do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ProdSpecRelationshipOption Cardinalidade do relacionamento de especificação do produto.

    Tipo de dados: Objeto

    "prodSpecRelationshipOption": {
      "numberSpecRelDefault": "String",
      "numberSpecRelLowerLimit": "String",
      "numberSpecRelUpperLimit": "String"
    }
    ProductSpecificationRelationship. ​ProdSpecRelationshipOption. ​NumberSpecRelDefault Valor padrão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ProdSpecRelationshipOption. ​NumberSpecRelLowLimit Número mínimo de pedidos que podem ser comprados.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ProdSpecRelationshipOption. ​NumberSpecRelUpperLimit Número máximo de pedidos que podem ser comprados.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​tipo Tipo de relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor Intervalo de datas para o qual o relacionamento de especificação do produto é válido.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecificationRelationship. ​ValidFor. ​EndDateTime Data de término do relacionamento.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor. ​StartDateTime Data de início do relacionamento.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​versão Versão do relacionamento de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Lista de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "resourceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ResourceSpecification. ​id Sys_id ou ID externo da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalId Versão inicial (sys_id) do registro de especificação de recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalVersion Versão da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​nome Nome da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de recurso [sn_prd_pm_resource_specification]

    ResourceSpecification. ​versão Versão externa da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ServiceSpecification Lista de especificações de serviço relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "serviceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ServiceSpecification. ​id Versão inicial ou ID externo da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalId Versão inicial da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalVersion Versão da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​nome Nome da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    ServiceSpecification. ​versão Versão externa da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    status Status da especificação do produto.
    Valores possíveis:
    • rascunho
    • publicado

    Tipo de dados: Cadeia de caracteres

    ValidFor Intervalo de datas para o qual a especificação é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data de término da especificação.

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​StartDateTime Data de início da especificação.

    Tipo de dados: Cadeia de caracteres

    versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    Este exemplo recupera o registro de especificação do produto especificado.

    curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6" \
    --header "Accept:application/json" \
    --user 'username':'password'

    Corpo da resposta:

    {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/497a39a7c3d312105acc9e62b540dd14",
      "name": "SD-WAN Service Package",
      "displayName": "SD-WAN Service Package v4",
      "version": "",
      "internalVersion": "4",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "description": "SD WAN Service Package",
      "lastUpdate": "2029-04-15 20:05:37",
      "lifecycleStatus": "Active",
      "isBundle": true,
      "validFor": {
        "startDateTime": "2033-04-15",
        "endDateTime": ""
      },
      "serviceSpecification": [],
      "productSpecificationRelationship": [
        {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "version": "",
          "internalVersion": "2",
          "internalId": "a6514bd3534560102f18ddeeff7b1247",
          "type": "Service",
          "compatibilityRelationshipType": "",
          "validFor": {
            "startDateTime": "2030-09-25",
            "endDateTime": "2035-10-27"
          }
        },
        {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "version": "",
          "internalVersion": "2",
          "internalId": "39b627aa53702010cd6dddeeff7b1202",
          "type": "Service",
          "compatibilityRelationshipType": "",
          "validFor": {
            "startDateTime": "2030-09-27",
            "endDateTime": "2035-10-27"
          }
        },
        {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "version": "",
          "internalVersion": "2",
          "internalId": "216663aa53702010cd6dddeeff7b12b5",
          "type": "Service",
          "compatibilityRelationshipType": "",
          "validFor": {
            "startDateTime": "2029-04-03",
            "endDateTime": ""
          }
        }
      ],
      "resourceSpecification": [],
      "productSpecCharacteristic": [
        {
          "productSpecCharacteristicValue": [
            {
              "value": "0.01",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "0.25",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "0.5",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "1",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "name": "Down Time",
          "description": "Down Time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-12-13 02:36:15"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1 hr",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "2 hrs",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "4 hrs",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "name": "Mean Time to Restore (MTR)",
          "description": "Mean Time to Restore (MTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-12-13 02:39:05"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1 hr",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "4 hrs",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "2 hrs",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "name": "Time to Restore (TTR)",
          "description": "Time to Restore (TTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-12-13 02:37:25"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "99.50",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "99.99",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "99.00",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "99.75",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "name": "Up Time",
          "description": "Up time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-12-13 02:34:30"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "5 Gbps",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "1 Gbps",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "500 Mbps",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "2 Gbps",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "name": "Bandwidth",
          "description": "Bandwidth",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-12-13 02:32:11"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "No",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "name": "Application Encryption",
          "description": "Application Encryption",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-12-13 02:29:08"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            },
            {
              "value": "No",
              "validFor": {
                "startDateTime": ""
              },
              "isDefault": false,
              "isMandatory": false
            }
          ],
          "name": "Application Flow Backup",
          "description": "Application Flow Backup",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-12-13 02:30:39"
          }
        }
      ],
      "status": "published"
    }

    API aberta do Catálogo de produtos - PATCH /sn_tmf_api/catalogmanagement/productOffering/

    Atualiza a oferta de produto especificada.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering/

    Parâmetros de solicitação compatíveis

    Tabela 67. Parâmetros de caminho
    Nome Descrição
    id Sys_id da oferta de produto a ser atualizada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    Tabela 68. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 69. Parâmetros do corpo da solicitação
    Nome Descrição
    BundledGroupProductOffering Grupos secundários de ofertas de produtos. Mostram subagrupamento hierárquico.

    Tipo de dados: Matriz de objetos

    "bundledGroupProductOffering": [
      {
        "bundledGroupProductOfferingOption": {Object},
        "bundledProductOffering": [Array],
        "id": "String",
        "name": "String"
      }
    ]
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption Um intervalo de números que especifica os limites inferior e superior do número da oferta de produto associada que pode ser adquirida como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Objeto

    "bundledGroupProductOfferingOption": {
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledProductOffering Grupos secundários de ofertas de produtos associados ao pacote. Mesmo formato que bundledProductOfferingespecificado abaixo.

    Tipo de dados: Matriz de objetos

    BundledGroupProductOffering. ​id Sys_id do registro do grupo agrupado. Útil nos casos em que a oferta ou grupo de produto primário inclui vários grupos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo de relacionamento da oferta de produto [sn_prd_pm_product_offering_relationship_group]

    BundledGroupProductOffering. ​nome Nome do grupo de ofertas de produtos secundários.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering Lista de ofertas de produtos incluídas no pacote de ofertas de produtos. O pacote de oferta de produto herda todos os atributos das ofertas de produto incluídas.

    Tipo de dados: Matriz de objetos

    "bundledProductOffering": [
      {
        "bundledProductOfferingOption": {Object},
        "externalId": "String",
        "id": "String",
        "name": "String",
        "version": Number
      }
    ]
    BundledProductOffering. ​BundledProductOfferingOption Opções de pacote de produtos, como o número padrão de ofertas de produtos e restrições de aquisição de ofertas de produtos superiores e inferiores.

    Tipo de dados: Objeto

    "bundledProductOfferingOption": {
      "numberRelOfferDefault": "String",
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferPadrão Número padrão de ofertas de produto que devem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​id Sys_id ou ID externo da oferta de produto agrupada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    BundledProductOffering. ​ExternalId ID externo do  relacionamento de oferta de produto.

    Para obter informações adicionais sobre relacionamentos de oferta de produto, consulte Create product offering relationships.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​nome Nome do pacote de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​versão Versão do catálogo da oferta de produto.  

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].  

    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: Matriz de objetos

    "category:" [
      {
        "id": "String",
        "name": "String"
      }
    ]

    Tabela: Categoria [sc_category]

    category.id Necessário se estiver usando categoryparâmetro. ID da categoria.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria [sc_category]

    category.name Nome da categoria.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    canal Obrigatório. Canais a serem usados para vender a oferta de produto.

    Tipo de dados: Matriz de objetos

    "channel:" [
      {
        "description": "String",
        "id": "String",
        "name": "String"
      }
    ]
    channel.description Descrição do canal.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    channel.id Obrigatório. Sys_id do canal.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]

    channel.name Nome do canal.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    descrição Obrigatório. Descrição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    displayName Nome de exibição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    externalId ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    id Obrigatório. Versão inicial ou ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    internalId Sys_id ou ID interno do registro de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    InternalVersion Versão da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    IsPacote Sinalizador que indica se a oferta de produto é um pacote.
    Valores possíveis:
    • Verdadeiro: A oferta de produto é um pacote.
    • Falso: Oferta de produto único.

    Tipo de dados: Booliano

    Padrão: falso

    ÉVenível Sinalizador que indica se a oferta de produto associada pode ser vendida sozinha ou deve fazer parte de um pacote de oferta de produto.
    Valores possíveis:
    • Verdadeiro: Pode ser vendido separadamente.
    • Vendido somente como parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    Cadeia de caracteres em branco

    LifeycleStatus Status do ciclo de vida atual da oferta de produto.
    Valores possíveis:
    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: Cadeia de caracteres

    nome Obrigatório. Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse Características da oferta do produto.

    Tipo de dados: Matriz de objetos

    "prodSpecCharValueUse": [
       {
          "description": "String",
          "name": "String",
          "productSpecCharacteristicValue": [Array],
          "validFor": {Object},
          "valueType": "String"
       }
    ]
    ProdSpecCharValueUse. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    prodSpecCharValueUse.name Obrigatório.
    Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ValorType Tipo de dados do prodSpecCharValueUse.productSpecCharacteristicValue.valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística Lista de características do produto.

    Tipo de dados: Matriz de objetos

    "productCharacteristic": [
      {
        "name": "String",
        "value": "String"
      }
    ]
    productCharacteristic.name Nome da característica.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    ProdutoCaracteristic.value Valor da característica.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    ProductOfferingCharacteristic Caraterística de qualidade ou caraterística distintiva de uma oferta de produto. As características podem assumir um valor discreto que é fixado no tempo de design (criação de catálogo), como Classificação do plano para celular. Geralmente, essas características não são modificáveis no nível de inventário.

    Para obter informações adicionais sobre as características da oferta do produto, consulte Create product characteristics and characteristic options.

    Tipo de dados: Matriz de objetos

    productOfferingCharacteristic": [  
      {
        "characteristicValueSpecification": [Array],
        "name": "String",
        "valueType": "String"
      }
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification Lista de valores de características associados à característica de oferta de produto.

    Tipo de dados: Matriz de objetos

    "characteristicValueSpecification": [  
      { 
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "value": "String"
      }  
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica associada.
    Valores possíveis:
    • Verdadeiro: É o valor padrão.
    • Falso: Não é o valor padrão.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​É Obrigatório Sinalizador que indica se o valor da característica associada é obrigatório para a característica associada.
    Valores possíveis:
    • Verdadeiro: É obrigatório.
    • Falso: Não é obrigatório.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​valor Número ou texto atribuído à característica de especificação do produto associada .
    Por exemplo:
    "characteristicValueSpecification": [
      {
        "value": "choice 1"
      },
      {
        "value": "choice 2"
      }
    ]

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​nome Nome da característica de oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​ValorType Tipo de dados do productOfferingCharacteristic.​characteristicValueSpecification.​valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice Informações de preço da oferta do produto.

    Tipo de dados: Matriz de objetos

    "productOfferingPrice": [
      {
        "price": {Object},
        "priceType": "String"
      }
    ]
    ProductOfferingPrice.price Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "price": {
      "taxIncludedAmount": {Object}
    }
    ProductOfferingPrice.price.taxIncludedAmount Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "taxIncludedAmount": {
      "unit": "String",
      "value": "String"
    }
    ProductOfferingPrice.price.taxIncludedAmount.unit Código da moeda do preço de oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    ProductOfferingPrice.price.taxIncludedAmount.Value Preço da oferta do produto, incluindo imposto.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    ProductOfferingPrice.PriceType Tipo de tipo de oferta de produto. Necessário se estiver usando productOfferingPriceparâmetro.
    Valores válidos:
    • Não recorrente (uma vez)
    • recorrente

    Tipo de dados: Cadeia de caracteres

    OfertaçãoprodutoTerm Duração válida do termo do contrato para a oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    ProductSpecification Obrigatório. Especificação do produto.

    Tipo de dados: Objeto

    "productSpecification": {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
    }
    productSpecification.id Obrigatório. Sys_id ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Nos campos sys_id ou external_id em Especificação do produto [sn_prd_pm_product_specification]

    ProductSpecification. ​InternalId Sys_id ou ID interno do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​nome Nome da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de nome da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    status Status da oferta de produto.
    Valores possíveis:
    • rascunho
    • publicado

    Tipo de dados: Cadeia de caracteres

    ValidFor Obrigatório. Intervalo de datas para o qual a oferta de produto é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor.endDateTime Obrigatório. Data e hora de término da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    ValidFor.startDateTime Obrigatório. Data e hora de início da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    versão Versão externa da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    Parâmetros do corpo da resposta (JSON)

    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 70. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 71. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

    Códigos de status

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

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

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

    Nome Descrição
    BundledGroupProductOffering Grupos secundários de ofertas de produtos. Mostram subagrupamento hierárquico.

    Tipo de dados: Matriz de objetos

    "bundledGroupProductOffering": [
      {
        "bundledGroupProductOfferingOption": {Object},
        "bundledProductOffering": [Array],
        "id": "String",
        "name": "String"
      }
    ]
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption Um intervalo de números que especifica os limites inferior e superior do número da oferta de produto associada que pode ser adquirida como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Objeto

    "bundledGroupProductOfferingOption": {
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledProductOffering Grupos secundários de ofertas de produtos associados ao pacote. Mesmo formato que bundledProductOfferingespecificado abaixo.

    Tipo de dados: Matriz de objetos

    BundledGroupProductOffering. ​id Sys_id do registro do grupo agrupado. Útil nos casos em que a oferta ou grupo de produto primário inclui vários grupos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo de relacionamento da oferta de produto [sn_prd_pm_product_offering_relationship_group]

    BundledGroupProductOffering. ​nome Nome do grupo de ofertas de produtos secundários.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering Lista de ofertas de produtos incluídas no pacote de ofertas de produtos. O pacote de oferta de produto herda todos os atributos das ofertas de produto incluídas.

    Tipo de dados: Matriz de objetos

    "bundledProductOffering": [
      {
        "bundledProductOfferingOption": {Object},
        "externalId": "String",
        "id": "String",
        "name": "String",
        "version": Number
      }
    ]
    BundledProductOffering. ​BundledProductOfferingOption Opções de pacote de produtos, como o número padrão de ofertas de produtos e restrições de aquisição de ofertas de produtos superiores e inferiores.

    Tipo de dados: Objeto

    "bundledProductOfferingOption": {
      "numberRelOfferDefault": "String",
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferPadrão Número padrão de ofertas de produto que devem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​id Sys_id ou ID externo da oferta de produto agrupada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    BundledProductOffering. ​ExternalId ID externo do  relacionamento de oferta de produto.

    Para obter informações adicionais sobre relacionamentos de oferta de produto, consulte Create product offering relationships.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​nome Nome do pacote de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​versão Versão do catálogo da oferta de produto.  

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].  

    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: Matriz de objetos

    "category:" [
      {
        "id": "String",
        "name": "String"
      }
    ]
    category.id ID da categoria.

    Tipo de dados: Cadeia de caracteres

    category.name Nome da categoria.

    Tipo de dados: Cadeia de caracteres

    canal Canais a serem usados para vender a oferta de produto.

    Tipo de dados: Matriz de objetos

    "channel:" [
      {
        "description": "String",
        "id": "String",
        "name": "String"
      }
    ]
    channel.description Descrição do canal.

    Tipo de dados: Cadeia de caracteres

    channel.id Sys_id do canal.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]

    channel.name Nome do canal.

    Tipo de dados: Cadeia de caracteres

    descrição Descrição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    displayName Nome de exibição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    externalId ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Obrigatório. Versão inicial ou ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    internalId Sys_id ou ID interno do registro de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    InternalVersion Versão da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    IsPacote Sinalizador que indica se a oferta de produto é um pacote.
    Valores possíveis:
    • Verdadeiro: A oferta de produto é um pacote.
    • Falso: Oferta de produto único.

    Tipo de dados: Booliano

    Padrão: falso

    ÉVenível Sinalizador que indica se a oferta de produto associada pode ser vendida sozinha ou deve fazer parte de um pacote de oferta de produto.
    Valores possíveis:
    • Verdadeiro: Pode ser vendido separadamente.
    • Vendido somente como parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    LiftcycleStatus Status do ciclo de vida atual. Valores aceitos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse Características da oferta do produto.

    Tipo de dados: Matriz de objetos

    "prodSpecCharValueUse": [
       {
          "description": "String",
          "name": "String",
          "productSpecCharacteristicValue": [Array],
          "validFor": {Object},
          "valueType": "String"
       }
    ]
    ProdSpecCharValueUse. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​nome
    Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ValorType Tipo de dados do prodSpecCharValueUse.productSpecCharacteristicValue.valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística Lista de características do produto.

    Tipo de dados: Matriz de objetos

    "productCharacteristic": [
      {
        "name": "String",
        "value": "String"
      }
    ]
    ProdutorCaracterística. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística. ​valor Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic Caraterística de qualidade ou caraterística distintiva de uma oferta de produto. As características podem assumir um valor discreto que é fixado no tempo de design (criação de catálogo), como Classificação do plano para celular. Geralmente, essas características não são modificáveis no nível de inventário.

    Para obter informações adicionais sobre as características da oferta do produto, consulte Create product characteristics and characteristic options.

    Tipo de dados: Matriz de objetos

    productOfferingCharacteristic": [  
      {
        "characteristicValueSpecification": [Array],
        "name": "String",
        "valueType": "String"
      }
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification Lista de valores de características associados à característica de oferta de produto.

    Tipo de dados: Matriz de objetos

    "characteristicValueSpecification": [  
      { 
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "value": "String"
      }  
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica associada.
    Valores possíveis:
    • Verdadeiro: É o valor padrão.
    • Falso: Não é o valor padrão.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​É Obrigatório Sinalizador que indica se o valor da característica associada é obrigatório para a característica associada.
    Valores possíveis:
    • Verdadeiro: É obrigatório.
    • Falso: Não é obrigatório.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​valor Número ou texto atribuído à característica de especificação do produto associada .
    Por exemplo:
    "characteristicValueSpecification": [
      {
        "value": "choice 1"
      },
      {
        "value": "choice 2"
      }
    ]

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​nome Nome da característica de oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​ValorType Tipo de dados do productOfferingCharacteristic.​characteristicValueSpecification.​valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice Informações de preço da oferta do produto.

    Tipo de dados: Matriz de objetos

    "productOfferingPrice": [
      {
        "price": {Object},
        "priceType": "String"
      }
    ]
    ProductOfferingPrice. ​preço Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "price": {
      "taxIncludedAmount": {Object}
    }
    ProductOfferingPrice. ​preço. ​TaxIncludedAmount Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "taxIncludedAmount": {
      "unit": "String",
      "value": "String"
    }
    ProductOfferingPrice. ​preço. ​TaxIncludedAmount.unit Código da moeda do preço de oferta do produto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice. ​preço. ​TaxIncludedAmount. ​valor Preço da oferta do produto, incluindo imposto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice. ​PriceType Tipo de preço de oferta de produto, pagamento único ou recorrente.
    Valores possíveis:
    • Não recorrente (uma vez)
    • recorrente

    Tipo de dados: Cadeia de caracteres

    OfertaçãoprodutoTerm Duração válida do termo do contrato para a oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecification Especificação do produto.

    Tipo de dados: Objeto

    "productSpecification": {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "status": "String",
      "sys_id": "String",
      "version": "String"
    }
    ProductSpecification. ​id Sys_id do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalId Sys_id ou ID interno do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​status Status da especificação do produto, como publicado ou rascunho.

    Tipo de dados: Cadeia de caracteres

    ProductSpecification. ​sys_id Sys_id da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    ProductSpecification. ​versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    status Status da oferta de produto.
    Valores possíveis:
    • rascunho
    • publicado

    Tipo de dados: Cadeia de caracteres

    ValidFor Intervalo de datas para o qual a oferta de produto é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data de término da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​StartDateTime Data de início da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    versão Versão externa da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    O exemplo a seguir atualiza a oferta de produto com o sys_id 313b917843235210a82ed6085bb8f2c7 com as informações fornecidas no corpo da solicitação.

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7" \ 
    --request PATCH\ 
    --header "Accept:application/json" \ 
    --user 'username':'password'
    --data '{
      "id": "313b917843235210a82ed6085bb8f2c7",
      "name": "Internet bundle",
      "displayName": "Internet bundle",
      "description": "Internet bundle",
      "isSellable": false,
      "lifecycleStatus": "Draft",
      "isBundle": true,
      "lastUpdate": "2025-02-05 06:39:45",
      "version": "",
      "internalVersion": "1",
      "internalId": "313b917843235210a82ed6085bb8f2c7",
      "validFor": {
        "startDateTime": "2028-12-15",
        "endDateTime": "2034-01-14"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
        {
          "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        }
      ],
      "productOfferingCharacteristic": [
        {
          "name": "Firewall Security",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "Premium",
              "isMandatory": false,
              "isDefault": true
            }
          ]
        },
        {
          "name": "Connectivity need",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "When in use",
              "isMandatory": false,
              "isDefault": false
            }
          ]
        }
      ],
      "bundledProductOffering": [
        {
         
          "id": "0f61dd9fd0a63110f8770dbf976be168",
          "name": "Solana Sports streaming channel",
          "version": "1",
          "externalId": "EXT-123",
    
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOffering": [
        {
          "id": "063b957843235210a82ed6085bb8f205",
          "name": "Streaming Channel",
          "bundledProductOffering": [
            {
              "id": "62619d9fd0a63110f8770dbf976be180",
              "name": "Solana Movie streaming channel",
              "version": "1",
              "externalId": "EXT-123",
              "bundledProductOfferingOption": {
                "numberRelOfferDefault": "1",
                "numberRelOfferLowerLimit": "1",
                "numberRelOfferUpperLimit": "1"
              }
            }
          ],
          "bundledGroupProductOfferingOption": {
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "version": "",
        "internalVersion": "3",
        "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
        {
          "name": "Tenancy",
          "description": "Tenancy",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2024-12-18 21:04:24"
          },
          "productSpecCharacteristicValue": [
            {
              "value": "Premium (>50 sites)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Base (10 site)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
          }
        }
      ],
      "channel": [
        {
          "id": "58ad5522c3702010df4773ce3640ddb2",
          "name": "Agent Assist"
        }
      ],
      "category": [
        {
          "id": "13e305a143b631105029d1529ab8f267",
          "name": "SD-WAN_all_offers"
        }
      ],
      "status": "draft"
    }'

    Corpo da resposta:

    {
      "id": "313b917843235210a82ed6085bb8f2c7",
      "href": "/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7",
     "name": "Internet",
      "displayName": "Internet",
      "description": "Internet bundle",
      "isSellable": false,
      "lifecycleStatus": "Draft",
      "isBundle": true,
      "lastUpdate": "2025-02-05 06:39:45",
      "version": "",
      "internalVersion": "1",
      "internalId": "313b917843235210a82ed6085bb8f2c7",
      "validFor": {
        "startDateTime": "2028-12-15",
        "endDateTime": "2034-01-14"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
        {
          "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        }
      ],
      "productOfferingCharacteristic": [
        {
          "name": "Firewall Security",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "Premium",
              "isMandatory": false,
              "isDefault": true
            }
          ]
        },
        {
          "name": "Connectivity need",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "When in use",
              "isMandatory": false,
              "isDefault": false
            }
          ]
        }
      ],
      "bundledProductOffering": [
        {
                "id": "0f61dd9fd0a63110f8770dbf976be168",
          "name": "Solana Sports streaming channel",
          "version": "1",
          "externalId": "EXT-123",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        },
        {
          "id": "0f61dd9fd0a63110f8770dbf976be16c",
          "name": "Solana TV shows streaming channel",
          "version": "1",
          "externalId": "EXT-456",
    
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOffering": [
        {
          "id": "063b957843235210a82ed6085bb8f205",
          "name": "Streaming Channel",
          "bundledProductOffering": [
            {
              
              "name": "Internet",
              "version": "1",
              "externalId": "EXT-678",
              "bundledProductOfferingOption": {
                "numberRelOfferDefault": "1",
                "numberRelOfferLowerLimit": "1",
                "numberRelOfferUpperLimit": "1"
              }
            }
          ],
          "bundledGroupProductOfferingOption": {
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "3"
          }
        },
        {
          "id": "313b917843235210a82ed6085bb8f2c7",
          "name": "Streaming Channel",
          "bundledProductOffering": [
            {
              "id": "1161a4f8436b1210a82ed6085bb8f216",
              "name": "Internet",
              "version": "1",
              "externalId": "EXT-910",
              "bundledProductOfferingOption": {
                "numberRelOfferDefault": "1",
                "numberRelOfferLowerLimit": "1",
                "numberRelOfferUpperLimit": "1"
              }
            }
          ],
          "bundledGroupProductOfferingOption": {
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "version": "",
        "internalVersion": "3",
        "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
        {
          "name": "Tenancy",
          "description": "Tenancy",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2024-12-18 21:04:24"
          },
          "productSpecCharacteristicValue": [
            {
              "value": "Premium (>50 sites)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Advance (50 site)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Base (10 site)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
          }
        }
      ],
      "channel": [
        {
          "id": "58ad5522c3702010df4773ce3640ddb2",
          "name": "Agent Assist"
        }
      ],
      "category": [
        {
          "id": "13e305a143b631105029d1529ab8f267",
          "name": "SD-WAN_all_offers"
        }
      ],
      "status": "draft"
    }

    API aberta do Catálogo de produtos - PATCH /sn_tmf_api/catalogmanagement/productOfferingPrice/

    Atualiza um registro de linha de lista de preços com um sys_id fornecido na tabela Linha de lista de preços [sn_csm_pricing_price_list_line].

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/

    Parâmetros de solicitação compatíveis

    Tabela 73. Parâmetros de caminho
    Nome Descrição
    id Obrigatório. Sys_id da linha da lista de preços a ser recuperada.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    Tabela 74. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 75. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    . Obrigatório. Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice .

    Tipo de dados: Cadeia de caracteres

    externalId O ID externo da linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    IsPacote Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A linha da lista de preços faz parte de um pacote.
    • Falso: A linha da lista de preços não faz parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Obrigatório. Data em que a linha de preço foi atualizada pela última vez.

    FORMATO: AAAA-MM-DD

    Tipo de dados: Cadeia de caracteres

    LifeCycleStatus Obrigatório. Status do ciclo de vida atual da linha da lista de produtos.
    Valores válidos:
    • ativo
    • rascunho
    • inativo

    Tipo de dados: Cadeia de caracteres

    Rascunho

    nome Obrigatório. Nome para fornecer a linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    preço Obrigatório. Detalhes do preço de lista da linha da lista de preços.

    Tipo de dados: Objeto

    "price": {
      "unit": "String",
      "value": "String"
    }
    price.unit Obrigatório. Código da moeda da linha da lista de preços. Por exemplo, USD ou EUR .

    Tabela: Tabela Moeda [fx_currency].

    Tipo de dados: Cadeia de caracteres

    valor.preço Obrigatório. Valor do preço.

    Tipo de dados: Cadeia de caracteres (representada por um número. Por exemplo, "800" .)

    priceList Obrigatório. Informações da lista de preços associadas à linha da lista de preços.

    Tipo de dados: Objeto

    "priceList": {
      "id": "String",
      "name": "String",
      "@type": "String"
    }
    Lista de preços.id Obrigatório. Sys_id da linha da lista de preços.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    priceList.name Nome da linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Tipo de lista de preços O tipo de linha da lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. O valor é sempre Lista de preços .

    Tipo de dados: Cadeia de caracteres

    PriceType Obrigatório. Filtre a linha da lista de preços pelo método de preço da oferta de produto.
    Valores válidos:
    • Recorrente: Cobra valores de preço recorrentes com uma frequência especificada. A frequência é definida em recurringChargePeriodTypeparâmetro.
    • One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Padrão: Recorrente

    productOffering Obrigatório. Oferta de produto da linha da lista de preços.

    Tipo de dados: Objeto

    "productOffering": {
      "id": "String",
      "name": "String",
      "internalVersion": "String"
    }
    ProdutoOferta. ​id Obrigatório. Sys_id da oferta de produto.

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​InternalVersion Número da versão interna da oferta do produto.

    Tipo de dados: Cadeia de caracteres (representada por um número. Por exemplo, "1" .)

    ProdutoOferta. ​nome Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    RecurringChargePeriodType Necessário se priceTypeé recorrente. Termos de compromisso que são selecionados quando a oferta de produto foi criada.
    Valores válidos:
    • anualmente
    • mensal

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure Obrigatório. Detalhes sobre a unidade de medida associada à linha da lista de preços.

    Tipo de dados: Objeto

    "unitOfMeasure": {
      "id": "String",
      "amount": Number,
      "units": "String"
    }
    UnitOfMeasure. ​valor Valor da unidade de medida.

    Tipo de dados: Número

    UnitOfMeasure. ​id Obrigatório. Sys_id da unidade de medida na tabela Lista de linhas de preço.

    Tabela: Linha da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​unidades Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, cada um ou pacote .

    Tipo de dados: Cadeia de caracteres

    ValidFor Obrigatório. A duração de tempo em que a linha da lista de preços é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDate": "String",
      "startDate": "String"
    }
    ValidFor.endDate Data de término para a qual a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.endDateTime Data e hora de término para as quais a linha da lista de preços é válida.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres (glide_date)

    ValidFor.StartDate Data de início para a qual a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.startDateTime Data e hora de início para as quais a linha da lista de preços é válida.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres (glide_date)

    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 76. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 77. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 78. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta.
    Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

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

    Nome Descrição
    id Sys_id da linha da lista de preços.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    href URL para o registro de linha da lista de preços na instância.

    Tipo de dados: Cadeia de caracteres

    LastUpdate Data e hora em que a linha da lista de preços foi atualizada pela última vez.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    ValidFor A duração de tempo em que a linha da lista de preços é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDate": "String",
      "startDate": "String"
    }
    ValidFor.endDate Data e hora de término para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.StartDate Data e hora de início para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    IsPacote Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A linha da lista de preços faz parte de um pacote.
    • Falso: A linha da lista de preços não faz parte de um pacote.

    Tipo de dados: Booliano

    LifeycleStatus Status do ciclo de vida atual da linha da lista de preços.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    productOffering Oferta de produto associada à linha da lista de preços.

    Tipo de dados: Objeto

    "productOffering": {
      "id": "String",
      "name": "String",
      "internalVersion": "String"
    }
    ProductOffering.id Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​InternalVersion Número da versão interna da oferta do produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​nome Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    PriceType O método de preço da oferta de produto associado a esta linha de lista de preços.
    Valores possíveis:
    • Recorrente: Cobra valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança.
    • One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    RecurringChargePeriodType A periodicidade ou frequência da oferta de produto associada a esta linha de lista de preços. Retorna um tipo de frequência se priceTypedefinido como recorrente caso contrário, retornará uma cadeia de caracteres vazia.
    Valores possíveis:
    • anualmente
    • mensal

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure Detalhes sobre a unidade de medida associada à linha da lista de preços.

    Tipo de dados: Objeto

    "unitOfMeasure": {
      "id": "String",
      "amount": Number,
      "units": "String"
    }
    UnitOfMeasure.Amount Valor da unidade de medida.

    Tipo de dados: Número

    UnitOfMeasure.id Sys_id da unidade de medida.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​unidades Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote .

    Tipo de dados: Cadeia de caracteres

    preço Detalhes do preço de lista da linha da lista de preços.

    Tipo de dados: Objeto

    "price": {
      "units": "String",
      "value": "String"
    }
    price.units Código da moeda do preço. Por exemplo, USD ou EUR .

    Moeda [fx_currency]

    Tipo de dados: Cadeia de caracteres

    valor.preço Valor do preço.

    Tipo de dados: Cadeia de caracteres (representada por um número)

    priceList Informações da lista de preços associadas à linha da lista de preços.

    Tipo de dados: Objeto

    "priceList": {
      "id": "String",
      "name": "String",
      "@type": "String"
    }
    Lista de preços.id Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list].

    Tipo de dados: Cadeia de caracteres

    priceList.name Nome da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Tipo de lista de preços O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços .

    Tipo de dados: Cadeia de caracteres

    . Sempre um valor de ProductOfferingPrice . Ao subclassificar, isso define o nome extensível da subclasse.

    Tipo de dados: Cadeia de caracteres

    estado O estado da lista de preços associada a esta linha de lista de preços.

    Tipo de dados: Cadeia de caracteres

    externalId O ID externo desta linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir atualiza as datas de quando o preço de oferta do produto com ID 3ddd0... válido para.

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
    --request patch\
    --user 'username':'password'
    --data {
      "validFor": {
        "endDateTime": "2024-06-25 15:15:58"
      }
    }

    Corpo da resposta:

    {
      "validFor": {
        "endDateTime": "2024-06-25 15:15:58"
      },
      "id": "994d5d364f8b5210f899f61d20ce0b7c",
      "name": "new Price list",
      "lastUpdate": "2025-01-16 00:15:32",
      "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c",
      "lifecycleStatus": "Draft"
    }

    API aberta do Catálogo de produtos - PATCH /sn_tmf_api/catalogmanagement/productSpecification/

    Atualiza a especificação do produto especificada.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productSpecification/

    Parâmetros de solicitação compatíveis

    Tabela 79. Parâmetros de caminho
    Nome Descrição
    id Sys_id da oferta de produto a ser atualizada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    Tabela 80. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 81. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    descrição Obrigatório. Descrição da especificação.

    Tipo de dados: Cadeia de caracteres

    externalId Obrigatório.
    ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    id Sys_id ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    internalId Obrigatório.
    Sys_id ou ID interno da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].

    IsPacote Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos.
    • Falso: A especificação do produto contém um único produto.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Obrigatório. Nome da especificação.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic Característica de especificação.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristic": [
      {
        "description": "String",
        "name": "String",
        "productSpecCharacteristicValue": [Array],
        "validFor": {Object},
        "valueType": "String"
      }
    ]
    ProductSpecCharacteristic. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​nome Obrigatório. Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
       "endDateTime": "String",
       "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ValidFor. ​EndDateTime Data e hora de término da característica.

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor. ​StartDateTime Data e hora de início da característica.

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser do tipo complexo ou não complexo.

    Tipo de dados: Cadeia de caracteres

    Valores aceitos:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Teste de linha única
    • Array.Object
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha

    Valor padrão: Cadeia de caracteres vazia

    ProductSpecificationRelationship Detalhes das relações da especificação com outras especificações do produto.

    Tipo de dados: Matriz de objetos

    "productSpecificationRelationship": [
      {
        "id": "String",
        "type": "String",
        "validFor": {Object}
      }
    ]
    ProductSpecificationRelationship. ​id ID da especificação relacionada.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​tipo Necessário se estiver usando productSpecificationRelationshipparâmetro. Tipo de relacionamento.
    Valores válidos:
    • pacotes
    • composto_de

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor Intervalo de datas para o qual o relacionamento é válido.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecificationRelationship. ​ValidFor. ​EndDateTime Data de término do relacionamento.

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor. ​StartDateTime Data de início do relacionamento.

    FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 .

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Obrigatório. Detalhes das especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "resourceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ResourceSpecification. ​id Obrigatório. Versão inicial ou ID externo da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalId Versão inicial (sys_id) do registro de especificação de recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalVersion Versão da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​nome Nome da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de recurso [sn_prd_pm_resource_specification]

    ResourceSpecification. ​versão Versão externa da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ServiceSpecification Lista de especificações de serviço relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "serviceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ServiceSpecification. ​id Versão inicial ou ID externo da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalId Versão inicial da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalVersion Versão da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​nome Nome da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    ServiceSpecification. ​versão Versão externa da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ValidFor Obrigatório. Intervalo de datas para o qual a especificação é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data e hora de término da especificação.

    FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 .

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​StartDateTime Data e hora de início da especificação.

    FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 .

    Tipo de dados: Cadeia de caracteres

    versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    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 82. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 83. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 84. Códigos de status
    Código do status Descrição
    200 Solicitação processada com sucesso.
    400 Solicitação incorreta. Possíveis motivos:
    • Carga vazia.
    • Carga inválida. Campo obrigatório ausente: <field name>
    404 Não encontrado. O item solicitado não foi encontrado.

    Parâmetros do corpo da resposta

    Nome Descrição
    descrição Descrição da especificação.

    Tipo de dados: Cadeia de caracteres

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    id Sys_id ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    internalId Obrigatório.
    Sys_id ou ID interno da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].

    LastUpdate Data em que a especificação foi atualizada pela última vez.

    FORMATO: AAAA-MM-DD 00:00:00.

    Tipo de dados: Cadeia de caracteres

    nome Nome da especificação.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic Caraterísticas da especificação.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristic": [
      {
        "description": "String",
        "name": "String",
        "productSpecCharacteristicValue": [Array],
        "validFor": {Object},
        "valueType": "String"
      }
    ]
    ProductSpecCharacteristic. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ValidFor. ​EndDateTime Data e hora de término da característica.

    FORMATO: AAAA-MM-DD 00:00:00.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor. ​StartDateTime Data e hora de início da característica.

    FORMATO: AAAA-MM-DD 00:00:00.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser do tipo complexo ou não complexo.

    Tipo de dados: Cadeia de caracteres

    Valores aceitos:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Teste de linha única
    • Array.Object
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha
    ProductSpecificationRelationship Relações desta especificação com outras especificações de produto.

    Tipo de dados: Matriz de objetos

    "productSpecificationRelationship": [
      {
        "id": "String",
        "type": "String",
        "validFor": {Object}
      }
    ]
    ProductSpecificationRelationship. ​id Sys_id da especificação relacionada.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​tipo Tipo de relacionamento.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor Intervalo de datas para o qual o relacionamento é válido.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecificationRelationship. ​ValidFor. ​EndDateTime Data de término e tipo do relacionamento.

    FORMATO: AAAA-MM-DD

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor. ​StartDateTime Data de início e tipo do relacionamento.

    FORMATO: AAAA-MM-DD

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Lista de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "resourceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ResourceSpecification. ​id Sys_id ou ID externo da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalId Versão inicial (sys_id) do registro de especificação de recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalVersion Versão da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​nome Nome da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de recurso [sn_prd_pm_resource_specification]

    ResourceSpecification. ​versão Versão externa da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ServiceSpecification Lista de especificações de serviço relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "serviceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ServiceSpecification. ​id Versão inicial ou ID externo da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalId Versão inicial da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalVersion Versão da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​nome Nome da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    ServiceSpecification. ​versão Versão externa da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ValidFor Intervalo de datas para o qual a especificação é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data e hora de término da especificação.

    Formato: AAAA-MM-DD HH:MM:SS.

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​StartDateTime Data e hora de início da especificação.

    Formato: AAAA-MM-DD HH:MM:SS.

    Tipo de dados: Cadeia de caracteres

    versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    O exemplo a seguir atualiza o ID de especificação do produto d6f8d9995b020210235d85cced81c7eb com as informações fornecidas no corpo da solicitação.

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/d6f8d9995b020210235d85cced81c7eb" \ 
    --request PATCH\ 
    --header "Accept:application/json" \ 
    --user 'username':'password'
    --data '{
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "displayName": "SD-WAN Service Package v3",
      "version": "",
      "internalVersion": "3",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "description": "SD WAN Service Package",
      "lastUpdate": "2027-10-11 06:58:12",
      "isBundle": true,
      "validFor": {
        "startDateTime": "2029-02-05",
        "endDateTime": ""
      },
      "serviceSpecification": [],
      "productSpecificationRelationship": [
        {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "version": "",
          "internalVersion": "1",
          "internalId": "216663aa53702010cd6dddeeff7b12b5",
          "type": "Service",
          "validFor": {
            "startDateTime": "2025-01-24",
            "endDateTime": ""
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "1",
            "numberSpecRelUpperLimit": "1"
          }
        },
        {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "version": "",
          "internalVersion": "2",
          "internalId": "39b627aa53702010cd6dddeeff7b1202",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-05",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "2",
            "numberSpecRelUpperLimit": "4"
          }
        },
        {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "version": "",
          "internalVersion": "2",
          "internalId": "a6514bd3534560102f18ddeeff7b1247",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-03",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "4",
            "numberSpecRelUpperLimit": "20"
          }
        }
      ],
      "resourceSpecification": [],
      "productSpecCharacteristic": [
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.25",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.01",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.5",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Down Time",
          "description": "Down Time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:36:15"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "500 Mbps",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "5 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Bandwidth",
          "description": "Bandwidth",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:32:11"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "4 hrs",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 hr",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Time to Restore (TTR)",
          "description": "Time to Restore (TTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:37:25"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1 hr",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "4 hrs",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Mean Time to Restore (MTR)",
          "description": "Mean Time to Restore (MTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:39:05"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Flow Backup",
          "description": "Application Flow Backup",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:30:39"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "99.00",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.50",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.75",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.99",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Up Time",
          "description": "Up time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:34:30"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Encryption",
          "description": "Application Encryption",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:29:08"
          }
        }
      ],
      "status": "published"
    }'

    Corpo da resposta:

    { 
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "displayName": "SD-WAN Service Package v3",
      "version": "",
      "internalVersion": "3",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "description": "SD WAN Service Package",
      "lastUpdate": "2027-10-11 06:58:12",
      "isBundle": true,
      "validFor": {
        "startDateTime": "2029-02-05",
        "endDateTime": ""
      },
      "serviceSpecification": [],
      "productSpecificationRelationship": [
        {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "version": "",
          "internalVersion": "1",
          "internalId": "216663aa53702010cd6dddeeff7b12b5",
          "type": "Service",
          "validFor": {
            "startDateTime": "2025-01-24",
            "endDateTime": ""
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "1",
            "numberSpecRelUpperLimit": "1"
          }
        },
        {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "version": "",
          "internalVersion": "2",
          "internalId": "39b627aa53702010cd6dddeeff7b1202",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-05",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "2",
            "numberSpecRelUpperLimit": "4"
          }
        },
        {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "version": "",
          "internalVersion": "2",
          "internalId": "a6514bd3534560102f18ddeeff7b1247",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-03",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "4",
            "numberSpecRelUpperLimit": "20"
          }
        }
      ],
      "resourceSpecification": [],
      "productSpecCharacteristic": [
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.25",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.01",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.5",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Down Time",
          "description": "Down Time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:36:15"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "500 Mbps",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "5 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Bandwidth",
          "description": "Bandwidth",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:32:11"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "4 hrs",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 hr",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Time to Restore (TTR)",
          "description": "Time to Restore (TTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:37:25"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1 hr",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "4 hrs",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Mean Time to Restore (MTR)",
          "description": "Mean Time to Restore (MTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:39:05"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Flow Backup",
          "description": "Application Flow Backup",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:30:39"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "99.00",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.50",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.75",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.99",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Up Time",
          "description": "Up time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:34:30"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Encryption",
          "description": "Application Encryption",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:29:08"
          }
        }
      ],
      "status": "published"
    }'

    API aberta do Catálogo de produtos - POST /sn_tmf_api/catalogmanagement/catalog

    Cria um catálogo de ofertas de produtos.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/catalog

    Parâmetros de solicitação compatíveis

    Tabela 85. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 86. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 87. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    descrição Descrição do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    externalId Identificador exclusivo do catálogo de ofertas de produtos do sistema externo.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Obrigatório. Nome do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    Cabeçalhos

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

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

    Códigos de status

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

    Tabela 90. Códigos de status
    Código do status Descrição
    201 Solicitação processada com sucesso.
    400 Solicitação Incorreta. Qualquer um dos seguintes motivos:
    • Carga vazia.
    • Carga inválida. Campo obrigatório ausente: <field name>

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    descrição Descrição do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    id Sys_id do catálogo de ofertas de produtos

    Tipo de dados: Cadeia de caracteres

    Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]

    nome Nome do catálogo de ofertas de produtos.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Este exemplo cria um catálogo de ofertas de produtos.

    curl --location --request POST "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
    --header "Content-Type: application/json" \
    --data-raw '{
        "id": "testId",
        "name": "Catalog",
        "description": "Description"
    }'
    --user 'username':'password'

    Corpo da resposta:

    {
       "id": "45715d02c3510110bc0526083c40dd6b",
       "description": "Description",
       "name": "Catalog1"
    }

    API aberta do Catálogo de produtos - POST /sn_tmf_api/catalogmanagement/productOffering

    Cria uma oferta de produto e pacotes de oferta de produto associados.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering

    Parâmetros de solicitação compatíveis

    Tabela 91. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 92. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 93. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    BundledGroupProductOffering Grupos secundários de ofertas de produtos. Mostram subagrupamento hierárquico.

    Tipo de dados: Matriz de objetos

    "bundledGroupProductOffering": [
      {
        "bundledGroupProductOfferingOption": {Object},
        "bundledProductOffering": [Array],
        "id": "String",
        "name": "String"
      }
    ]
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption Um intervalo de números que especifica os limites inferior e superior do número da oferta de produto associada que pode ser adquirida como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Objeto

    "bundledGroupProductOfferingOption": {
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledProductOffering Grupos secundários de ofertas de produtos associados ao pacote. Mesmo formato que bundledProductOfferingespecificado abaixo.

    Tipo de dados: Matriz de objetos

    BundledGroupProductOffering. ​id Sys_id do registro do grupo agrupado. Útil nos casos em que a oferta ou grupo de produto primário inclui vários grupos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo de relacionamento da oferta de produto [sn_prd_pm_product_offering_relationship_group]

    BundledGroupProductOffering. ​nome Nome do grupo de ofertas de produtos secundários.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering Lista de ofertas de produtos incluídas no pacote de ofertas de produtos. O pacote de oferta de produto herda todos os atributos das ofertas de produto incluídas.

    Tipo de dados: Matriz de objetos

    "bundledProductOffering": [
      {
        "bundledProductOfferingOption": {Object},
        "externalId": "String",
        "id": "String",
        "name": "String",
        "version": Number
      }
    ]
    BundledProductOffering. ​BundledProductOfferingOption Opções de pacote de produtos, como o número padrão de ofertas de produtos e restrições de aquisição de ofertas de produtos superiores e inferiores.

    Tipo de dados: Objeto

    "bundledProductOfferingOption": {
      "numberRelOfferDefault": "String",
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferPadrão Número padrão de ofertas de produto que devem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​ExternalId ID externo do  relacionamento de oferta de produto.

    Para obter informações adicionais sobre relacionamentos de oferta de produto, consulte Create product offering relationships.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​id Sys_id ou ID externo da oferta de produto agrupada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    BundledProductOffering. ​nome Nome do pacote de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​versão Versão do catálogo da oferta de produto.  

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].  

    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: Matriz de objetos

    "category:" [
      {
        "id": "String",
        "name": "String"
      }
    ]
    category.id Necessário se estiver usando categoryparâmetro. ID da categoria.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria [sc_category]

    category.name Nome da categoria.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria [sc_category]

    canal Obrigatório. Canais a serem usados para vender a oferta de produto.

    Tipo de dados: Matriz de objetos

    "channel:" [
      {
        "description": "String",
        "id": "String",
        "name": "String"
      }
    ]
    channel.description Descrição do canal.

    Tipo de dados: Cadeia de caracteres

    channel.id Obrigatório. Sys_id do canal.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]

    channel.name Nome do canal.

    Tipo de dados: Cadeia de caracteres

    descrição Obrigatório. Descrição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    displayName Nome de exibição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    externalId Identificador exclusivo da oferta de produto do sistema externo.

    Tipo de dados: Cadeia de caracteres

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    id Obrigatório. Versão inicial ou ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Nos campos initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    internalId Sys_id ou ID interno do registro de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    InternalVersion Versão da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    IsPacote Sinalizador que indica se a oferta de produto é um pacote.
    Valores possíveis:
    • Verdadeiro: A oferta de produto é um pacote.
    • Falso: Oferta de produto único.

    Tipo de dados: Booliano

    Padrão: falso

    ÉVenível Sinalizador que indica se a oferta de produto associada pode ser vendida sozinha ou deve fazer parte de um pacote de oferta de produto.
    Valores possíveis:
    • Verdadeiro: Pode ser vendido separadamente.
    • Vendido somente como parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    LifeycleStatus Status do ciclo de vida atual.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    nome Obrigatório. Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse Características da oferta do produto.

    Tipo de dados: Matriz de objetos

    "prodSpecCharValueUse": [
       {
          "description": "String",
          "name": "String",
          "productSpecCharacteristicValue": [Array],
          "validFor": {Object},
          "valueType": "String"
       }
    ]
    ProdSpecCharValueUse. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​nome
    Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ValorType Tipo de dados do prodSpecCharValueUse.productSpecCharacteristicValue.valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística Lista de características do produto.

    Tipo de dados: Matriz de objetos

    "productCharacteristic": [
      {
        "name": "String",
        "value": "String"
      }
    ]
    productCharacteristic.name Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdutoCaracteristic.value Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic Caraterística de qualidade ou caraterística distintiva de uma oferta de produto. As características podem assumir um valor discreto que é fixado no tempo de design (criação de catálogo), como Classificação do plano para celular. Geralmente, essas características não são modificáveis no nível de inventário.

    Para obter informações adicionais sobre as características da oferta do produto, consulte Create product characteristics and characteristic options.

    Tipo de dados: Matriz de objetos

    productOfferingCharacteristic": [  
      {
        "characteristicValueSpecification": [Array],
        "name": "String",
        "valueType": "String"
      }
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification Lista de valores de características associados à característica de oferta de produto.

    Tipo de dados: Matriz de objetos

    "characteristicValueSpecification": [  
      { 
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "value": "String"
      }  
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica associada.
    Valores possíveis:
    • Verdadeiro: É o valor padrão.
    • Falso: Não é o valor padrão.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​É Obrigatório Sinalizador que indica se o valor da característica associada é obrigatório para a característica associada.
    Valores possíveis:
    • Verdadeiro: É obrigatório.
    • Falso: Não é obrigatório.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​valor Número ou texto atribuído à característica de especificação do produto associada .
    Por exemplo:
    "characteristicValueSpecification": [
      {
        "value": "choice 1"
      },
      {
        "value": "choice 2"
      }
    ]

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​nome Nome da característica de oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​ValorType Tipo de dados do productOfferingCharacteristic.​characteristicValueSpecification.​valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice Informações de preço da oferta do produto.

    Tipo de dados: Matriz de objetos

    "productOfferingPrice": [
      {
        "price": {Object},
        "priceType": "String"
      }
    ]
    ProductOfferingPrice.price Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "price": {
      "taxIncludedAmount": {Object}
    }
    ProductOfferingPrice.price.taxIncludedAmount Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "taxIncludedAmount": {
      "unit": "String",
      "value": "String"
    }
    ProductOfferingPrice.price.taxIncludedAmount.unit Código da moeda do preço de oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Formato: ISO 4217

    ProductOfferingPrice.price.taxIncludedAmount.Value Preço da oferta do produto, incluindo imposto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice.PriceType Necessário se estiver usando productOfferingPriceparâmetro. Tipo de preço de oferta de produto, pagamento único ou recorrente.
    Valores válidos:
    • Não recorrente (uma vez)
    • recorrente

    Tipo de dados: Cadeia de caracteres

    OfertaçãoprodutoTerm Duração válida do prazo do contrato para a oferta do produto, como 12 meses, 24 meses ou not_applicable.

    Tipo de dados: Cadeia de caracteres

    ProductSpecification Obrigatório. Especificação do produto.

    Tipo de dados: Objeto

    "productSpecification": {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name"
      "version": "String"
    }
    productSpecification.id Obrigatório. Versão inicial ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version ou externa_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    ProductSpecification. ​InternalId Sys_id ou ID interno do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​nome Nome da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de nome da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ValidFor Obrigatório. Intervalo de datas para o qual a oferta de produto é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor.endDateTime Data de término da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    ValidFor.startDateTime Data de início da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    FORMATO: AAAA-MM-DD

    versão Versão externa da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    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 94. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 95. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 96. Códigos de status
    Código do status Descrição
    201 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta. Possíveis motivos:
    • Carga vazia.
    • Carga inválida. Campo obrigatório ausente: <field name>

    Parâmetros do corpo da resposta

    Nome Descrição
    BundledGroupProductOffering Grupos secundários de ofertas de produtos. Mostram subagrupamento hierárquico.

    Tipo de dados: Matriz de objetos

    "bundledGroupProductOffering": [
      {
        "bundledGroupProductOfferingOption": {Object},
        "bundledProductOffering": [Array],
        "id": "String",
        "name": "String"
      }
    ]
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption Um intervalo de números que especifica os limites inferior e superior do número da oferta de produto associada que pode ser adquirida como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Objeto

    "bundledGroupProductOfferingOption": {
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledGroupProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior para uma oferta de produto que pode ser adquirida como parte da oferta de produto agrupada relacionada.  

    Tipo de dados: Cadeia de caracteres

    BundledGroupProductOffering. ​BundledProductOffering Grupos secundários de ofertas de produtos associados ao pacote. Mesmo formato que bundledProductOfferingespecificado abaixo.

    Tipo de dados: Matriz de objetos

    BundledGroupProductOffering. ​id Sys_id do registro do grupo agrupado. Útil nos casos em que a oferta ou grupo de produto primário inclui vários grupos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo de relacionamento da oferta de produto [sn_prd_pm_product_offering_relationship_group]

    BundledGroupProductOffering. ​nome Nome do grupo de ofertas de produtos secundários.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering Lista de ofertas de produtos incluídas no pacote de ofertas de produtos. O pacote de oferta de produto herda todos os atributos das ofertas de produto incluídas.

    Tipo de dados: Matriz de objetos

    "bundledProductOffering": [
      {
        "bundledProductOfferingOption": {Object},
        "externalId": "String",
        "href": "String",
        "id": "String",
        "name": "String",
        "version": Number
      }
    ]
    BundledProductOffering. ​BundledProductOfferingOption Opções de pacote de produtos, como o número padrão de ofertas de produtos e restrições de aquisição de ofertas de produtos superiores e inferiores.

    Tipo de dados: Objeto

    "bundledProductOfferingOption": {
      "numberRelOfferDefault": "String",
      "numberRelOfferLowerLimit": "String",
      "numberRelOfferUpperLimit": "String"
    }
    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferPadrão Número padrão de ofertas de produto que devem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfOfOferLimit Limite inferior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​BundledProductOfferingOption. ​NumberRelOfferUpperLimit Limite superior do número de ofertas de produto associadas que podem ser adquiridas como parte da oferta de produto agrupada relacionada.

    Tipo de dados: Cadeia de caracteres

    Valores possíveis: 0 para não vinculado.

    BundledProductOffering. ​ExternalId ID externo do  relacionamento de oferta de produto.

    Para obter informações adicionais sobre relacionamentos de oferta de produto, consulte Create product offering relationships.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​href Link relativo para a oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​id Sys_id ou ID externo da oferta de produto agrupada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    BundledProductOffering. ​nome Nome do pacote de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    BundledProductOffering. ​versão Versão do catálogo da oferta de produto.  

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].  

    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: Matriz de objetos

    "category:" [
      {
        "id": "String",
        "name": "String"
      }
    ]
    category.id ID da categoria.

    Tipo de dados: Cadeia de caracteres

    category.name Nome da categoria.

    Tipo de dados: Cadeia de caracteres

    canal Canais a serem usados para vender a oferta de produto.

    Tipo de dados: Matriz de objetos

    "channel:" [
      {
        "description": "String",
        "id": "String",
        "name": "String"
      }
    ]
    canal. ​descrição Descrição do canal.

    Tipo de dados: Cadeia de caracteres

    channel.id Sys_id do canal.

    Tipo de dados: Cadeia de caracteres

    Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]

    channel.name Nome do canal.

    Tipo de dados: Cadeia de caracteres

    descrição Descrição da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    externalId ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Obrigatório. Versão inicial ou ID externo da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].

    internalId Sys_id ou ID interno do registro de oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    InternalVersion Versão da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    IsPacote Sinalizador que indica se a oferta de produto é um pacote.
    Valores possíveis:
    • Verdadeiro: A oferta de produto é um pacote.
    • Falso: Oferta de produto único.

    Tipo de dados: Booliano

    Padrão: falso

    ÉVenível Sinalizador que indica se a oferta de produto associada pode ser vendida sozinha ou deve fazer parte de um pacote de oferta de produto.
    Valores possíveis:
    • Verdadeiro: Pode ser vendido separadamente.
    • Vendido somente como parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    LifeycleStatus Status do ciclo de vida atual da oferta de produto.

    Valores válidos:

    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse Características da oferta do produto.

    Tipo de dados: Matriz de objetos

    "prodSpecCharValueUse": [
       {
          "description": "String",
          "name": "String",
          "productSpecCharacteristicValue": [Array],
          "validFor": {Object},
          "valueType": "String"
       }
    ]
    ProdSpecCharValueUse. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​nome
    Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProdSpecCharValueUse. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProdSpecCharValueUse. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProdSpecCharValueUse. ​ValorType Tipo de dados do prodSpecCharValueUse.productSpecCharacteristicValue.valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística Lista de características do produto.

    Tipo de dados: Matriz de objetos

    "productCharacteristic": [
      {
        "name": "String",
        "value": "String"
      }
    ]
    ProdutorCaracterística. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProdutorCaracterística. ​valor Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic Caraterística de qualidade ou caraterística distintiva de uma oferta de produto. As características podem assumir um valor discreto que é fixado no tempo de design (criação de catálogo), como Classificação do plano para celular. Geralmente, essas características não são modificáveis no nível de inventário.

    Para obter informações adicionais sobre as características da oferta do produto, consulte Create product characteristics and characteristic options.

    Tipo de dados: Matriz de objetos

    productOfferingCharacteristic": [  
      {
        "characteristicValueSpecification": [Array],
        "name": "String",
        "valueType": "String"
      }
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification Lista de valores de características associados à característica de oferta de produto.

    Tipo de dados: Matriz de objetos

    "characteristicValueSpecification": [  
      { 
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "value": "String"
      }  
    ]
    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica associada.
    Valores possíveis:
    • Verdadeiro: É o valor padrão.
    • Falso: Não é o valor padrão.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​É Obrigatório Sinalizador que indica se o valor da característica associada é obrigatório para a característica associada.
    Valores possíveis:
    • Verdadeiro: É obrigatório.
    • Falso: Não é obrigatório.

    Tipo de dados: Booliano

    Padrão: falso

    ProductOfferingCharacteristic. ​CaracteristicValueSpecification. ​valor Número ou texto atribuído à característica de especificação do produto associada .
    Por exemplo:
    "characteristicValueSpecification": [
      {
        "value": "choice 1"
      },
      {
        "value": "choice 2"
      }
    ]

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​nome Nome da característica de oferta de produto associada.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingCharacteristic. ​ValorType Tipo de dados do productOfferingCharacteristic.​characteristicValueSpecification.​valueparâmetro.
    Valores possíveis:
    • Array.Date
    • Array.Datetime
    • Array.Decimal
    • Array.Integer
    • Array.Object
    • Teste de linha única
    • Caixa de seleção
    • Escolha
    • Data, Endereço
    • E-mail
    • Inteiro, Data/Hora
    • Objeto
    • Texto de Linha Única
    • Sim/Não

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice Informações de preço da oferta do produto.

    Tipo de dados: Matriz de objetos

    "productOfferingPrice": [
      {
        "price": {Object},
        "priceType": "String"
      }
    ]
    ProductOfferingPrice. ​preço Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "price": {
      "taxIncludedAmount": {Object}
    }
    ProductOfferingPrice. ​preço. ​TaxIncludedAmount Informações de preço da oferta do produto.

    Tipo de dados: Objeto

    "taxIncludedAmount": {
      "unit": "String",
      "value": "String"
    }
    ProductOfferingPrice. ​preço. ​TaxIncludedAmount.unit Código da moeda do preço de oferta do produto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice. ​preço. ​TaxIncludedAmount. ​valor Preço da oferta do produto, incluindo imposto.

    Tipo de dados: Cadeia de caracteres

    ProductOfferingPrice. ​PriceType Tipo de preço de oferta de produto, pagamento único ou recorrente.
    Valores possíveis:
    • Não recorrente (uma vez)
    • recorrente

    Tipo de dados: Cadeia de caracteres

    OfertaçãoprodutoTerm Duração válida do termo do contrato para a oferta de produto.

    Tipo de dados: Cadeia de caracteres

    ProductSpecification Especificação do produto.

    Tipo de dados: Objeto

    "productSpecification": {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
    }
    ProductSpecification. ​id Sys_id do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalId Sys_id ou ID interno do registro de especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].

    ProductSpecification. ​versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    status Status da oferta de produto.
    Valores possíveis:
    • rascunho
    • publicado

    Tipo de dados: Cadeia de caracteres

    ValidFor Intervalo de datas para o qual a oferta de produto é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data de término da oferta do produto.

    Tipo de dados: Cadeia de caracteres

    ValidFor. ​StartDateTime Data de início da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    versão Versão externa da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

    Este exemplo cria uma oferta de produto.

    curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering" \
    --header "Content-Type: application/json" \
    --header "Accept:application/json" \
    --data-raw '{
      "id": "313b917843235210a82ed6085bb8f2c7",
      "name": "Internet bundle",
      "displayName": "Internet bundle",
      "description": "Internet bundle",
      "isSellable": false,
      "lifecycleStatus": "Draft",
      "isBundle": true,
      "lastUpdate": "2025-02-05 06:39:45",
      "version": "",
      "internalVersion": "1",
      "internalId": "313b917843235210a82ed6085bb8f2c7",
      "validFor": {
        "startDateTime": "2028-12-15",
        "endDateTime": "2034-01-14"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
        {
          "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        }
      ],
      "productOfferingCharacteristic": [
        {
          "name": "Firewall Security",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "Premium",
              "isMandatory": false,
              "isDefault": true
            }
          ]
        },
        {
          "name": "Connectivity need",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "When in use",
              "isMandatory": false,
              "isDefault": false
            }
          ]
        }
      ],
      "bundledProductOffering": [
        {
          
    
          "id": "0f61dd9fd0a63110f8770dbf976be168",
          "name": "Solana Sports streaming channel",
          "version": "1",
          "externalId": "EXT-123",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOffering": [
        {
          "id": "063b957843235210a82ed6085bb8f205",
          "name": "Streaming Channel",
          "bundledProductOffering": [
            { 
            
    
              "id": "62619d9fd0a63110f8770dbf976be180",
              "name": "Solana Movie streaming channel",
              "version": "1",
              "externalId": "EXT-345",
              "bundledProductOfferingOption": {
                "numberRelOfferDefault": "1",
                "numberRelOfferLowerLimit": "1",
                "numberRelOfferUpperLimit": "1"
              }
            }
          ],
          "bundledGroupProductOfferingOption": {
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "version": "",
        "internalVersion": "3",
        "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
        {
          "name": "Tenancy",
          "description": "Tenancy",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2024-12-18 21:04:24"
          },
          "productSpecCharacteristicValue": [
            {
              "value": "Premium (>50 sites)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Base (10 site)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
          }
        }
      ],
      "channel": [
        {
          "id": "58ad5522c3702010df4773ce3640ddb2",
          "name": "Agent Assist"
        }
      ],
      "category": [
        {
          "id": "13e305a143b631105029d1529ab8f267",
          "name": "SD-WAN_all_offers"
        }
      ],
      "status": "draft"
    }'
    --user 'username':'password'

    Corpo da resposta:

    {
      "id": "313b917843235210a82ed6085bb8f2c7",
      "name": "Internet bundle",
      "displayName": "Internet bundle",
      "description": "Internet bundle",
      "isSellable": false,
      "lifecycleStatus": "Draft",
      "isBundle": true,
      "lastUpdate": "2025-04-09 15:59:09",
      "version": "",
      "internalVersion": "1",
      "validFor": {
        "startDateTime": "2028-12-15",
        "endDateTime": "2034-01-14"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
        {
          "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": "0"
            }
          }
        }
      ],
      "productOfferingCharacteristic": [
        {
          "name": "Firewall Security",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "Premium",
              "isMandatory": false,
              "isDefault": true
            }
          ]
        },
        {
          "name": "Connectivity need",
          "valueType": "choice",
          "characteristicValueSpecification": [
            {
              "value": "When in use",
              "isMandatory": false,
              "isDefault": false
            }
          ]
        }
      ],
      "bundledProductOffering": [
        {
          "id": "0f61dd9fd0a63110f8770dbf976be168",
          "name": "Solana Sports streaming channel",
          "version": "1",
          "externalId": "EXT-123",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOffering": [
        {
          "id": "063b957843235210a82ed6085bb8f205",
          "name": "Streaming Channel",
          "bundledProductOffering": [
            {
              "id": "62619d9fd0a63110f8770dbf976be180",
              "name": "Solana Movie streaming channel",
              "version": "1",
              "externalId": "EXT-345",
              "bundledProductOfferingOption": {
                "numberRelOfferDefault": "1",
                "numberRelOfferLowerLimit": "1",
                "numberRelOfferUpperLimit": "1"
              }
            }
          ],
          "bundledGroupProductOfferingOption": {
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "version": "",
        "internalVersion": "3",
        "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
        {
          "name": "Tenancy",
          "description": "Tenancy",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2024-12-18 21:04:24"
          },
          "productSpecCharacteristicValue": [
            {
              "value": "Premium (>50 sites)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Base (10 site)",
              "isDefault": false,
              "isMandatory": false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
          }
        }
      ],
      "channel": [
        {
          "id": "58ad5522c3702010df4773ce3640ddb2",
          "name": "Agent Assist"
        }
      ],
      "category": [
        {
          "id": "13e305a143b631105029d1529ab8f267",
          "name": "SD-WAN_all_offers"
        }
      ],
      "status": "draft",
      "externalId": "313b917843235210a82ed6085bb8f2c7",
      "internalId": "03c99cb53bf066509b48d69a04e45a11",
      "href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11"
    }

    API aberta do Catálogo de produtos - POST /sn_tmf_api/catalogmanagement/produtoOfferingPrice

    Cria um novo registro de linha de lista de preços na tabela Linha de lista de preços [sn_csm_pricing_price_list_line].

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOfferingPrice

    Parâmetros de solicitação compatíveis

    Tabela 97. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 98. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 99. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    . Obrigatório. Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice .

    Tipo de dados: Cadeia de caracteres

    externalId O ID externo da linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    IsPacote Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A linha da lista de preços faz parte de um pacote.
    • Falso: A linha da lista de preços não faz parte de um pacote.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Obrigatório. Data em que a linha de preço foi atualizada pela última vez.

    FORMATO: AAAA-MM-DD

    Tipo de dados: Cadeia de caracteres

    LifeCycleStatus Obrigatório. Status do ciclo de vida atual da linha da lista de produtos.
    Valores válidos:
    • ativo
    • rascunho
    • inativo

    Tipo de dados: Cadeia de caracteres

    Rascunho

    nome Obrigatório. Nome para fornecer a linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    preço Obrigatório. Detalhes do preço de lista da linha da lista de preços.

    Tipo de dados: Objeto

    "price": {
      "unit": "String",
      "value": "String"
    }
    price.unit Obrigatório. Código da moeda da linha da lista de preços. Por exemplo, USD ou EUR .

    Tabela: Tabela Moeda [fx_currency].

    Tipo de dados: Cadeia de caracteres

    valor.preço Obrigatório. Valor do preço.

    Tipo de dados: Cadeia de caracteres (representada por um número. Por exemplo, "800" .)

    priceList Obrigatório. Informações da lista de preços associadas à linha da lista de preços.

    Tipo de dados: Objeto

    "priceList": {
      "id": "String",
      "name": "String",
      "@type": "String"
    }
    Lista de preços.id Obrigatório. Sys_id da linha da lista de preços.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    priceList.name Nome da linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Tipo de lista de preços O tipo de linha da lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. O valor é sempre Lista de preços .

    Tipo de dados: Cadeia de caracteres

    PriceType Obrigatório. Filtre a linha da lista de preços pelo método de preço da oferta de produto.
    Valores válidos:
    • Recorrente: Cobra valores de preço recorrentes com uma frequência especificada. A frequência é definida em recurringChargePeriodTypeparâmetro.
    • One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    Padrão: Recorrente

    productOffering Obrigatório. Oferta de produto da linha da lista de preços.

    Tipo de dados: Objeto

    "productOffering": {
      "id": "String",
      "name": "String",
      "internalVersion": "String"
    }
    ProdutoOferta. ​id Obrigatório. Sys_id da oferta de produto.

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​InternalVersion Número da versão interna da oferta do produto.

    Tipo de dados: Cadeia de caracteres (representada por um número. Por exemplo, "1" .)

    ProdutoOferta. ​nome Nome da oferta de produto.

    Tipo de dados: Cadeia de caracteres

    RecurringChargePeriodType Necessário se priceTypeé recorrente. Termos de compromisso que são selecionados quando a oferta de produto foi criada.
    Valores válidos:
    • anualmente
    • mensal

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure Obrigatório. Detalhes sobre a unidade de medida associada à linha da lista de preços.

    Tipo de dados: Objeto

    "unitOfMeasure": {
      "id": "String",
      "amount": Number,
      "units": "String"
    }
    UnitOfMeasure. ​valor Valor da unidade de medida.

    Tipo de dados: Número

    UnitOfMeasure. ​id Obrigatório. Sys_id da unidade de medida na tabela Lista de linhas de preço.

    Tabela: Linha da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​unidades Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, cada um ou pacote .

    Tipo de dados: Cadeia de caracteres

    ValidFor Obrigatório. A duração de tempo em que a linha da lista de preços é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDate": "String",
      "startDate": "String"
    }
    ValidFor.endDate Data de término para a qual a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.endDateTime Data e hora de término para as quais a linha da lista de preços é válida.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres (glide_date)

    ValidFor.StartDate Data de início para a qual a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.startDateTime Data e hora de início para as quais a linha da lista de preços é válida.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres (glide_date)

    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 100. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 101. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 102. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta.
    Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Não encontrado. O item solicitado não foi encontrado.

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

    Nome Descrição
    id Sys_id da linha da lista de preços.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    href URL para o registro de linha da lista de preços na instância.

    Tipo de dados: Cadeia de caracteres

    LastUpdate Data e hora em que a linha da lista de preços foi atualizada pela última vez.

    Formato: AAAA-MM-DD HH:mm:ss

    Tipo de dados: Cadeia de caracteres

    ValidFor A duração de tempo em que a linha da lista de preços é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDate": "String",
      "startDate": "String"
    }
    ValidFor.endDate Data e hora de término para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    ValidFor.StartDate Data e hora de início para as quais a linha da lista de preços é válida.

    Tipo de dados: Cadeia de caracteres (glide_date_time)

    IsPacote Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A linha da lista de preços faz parte de um pacote.
    • Falso: A linha da lista de preços não faz parte de um pacote.

    Tipo de dados: Booliano

    LifeycleStatus Status do ciclo de vida atual da linha da lista de preços.
    Valores válidos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    productOffering Oferta de produto associada à linha da lista de preços.

    Tipo de dados: Objeto

    "productOffering": {
      "id": "String",
      "name": "String",
      "internalVersion": "String"
    }
    ProductOffering.id Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​InternalVersion Número da versão interna da oferta do produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    ProdutoOferta. ​nome Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: Cadeia de caracteres

    PriceType O método de preço da oferta de produto associado a esta linha de lista de preços.
    Valores possíveis:
    • Recorrente: Cobra valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança.
    • One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto.

    Tipo de dados: Cadeia de caracteres

    RecurringChargePeriodType A periodicidade ou frequência da oferta de produto associada a esta linha de lista de preços. Retorna um tipo de frequência se priceTypedefinido como recorrente caso contrário, retornará uma cadeia de caracteres vazia.
    Valores possíveis:
    • anualmente
    • mensal

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure Detalhes sobre a unidade de medida associada à linha da lista de preços.

    Tipo de dados: Objeto

    "unitOfMeasure": {
      "id": "String",
      "amount": Number,
      "units": "String"
    }
    UnitOfMeasure.Amount Valor da unidade de medida.

    Tipo de dados: Número

    UnitOfMeasure.id Sys_id da unidade de medida.

    Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line]

    Tipo de dados: Cadeia de caracteres

    UnitOfMeasure. ​unidades Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote .

    Tipo de dados: Cadeia de caracteres

    preço Detalhes do preço de lista da linha da lista de preços.

    Tipo de dados: Objeto

    "price": {
      "units": "String",
      "value": "String"
    }
    price.units Código da moeda do preço. Por exemplo, USD ou EUR .

    Moeda [fx_currency]

    Tipo de dados: Cadeia de caracteres

    valor.preço Valor do preço.

    Tipo de dados: Cadeia de caracteres (representada por um número)

    priceList Informações da lista de preços associadas à linha da lista de preços.

    Tipo de dados: Objeto

    "priceList": {
      "id": "String",
      "name": "String",
      "@type": "String"
    }
    Lista de preços.id Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list].

    Tipo de dados: Cadeia de caracteres

    priceList.name Nome da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Tipo de lista de preços O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços .

    Tipo de dados: Cadeia de caracteres

    . Sempre um valor de ProductOfferingPrice . Ao subclassificar, isso define o nome extensível da subclasse.

    Tipo de dados: Cadeia de caracteres

    estado O estado da lista de preços associada a esta linha de lista de preços.

    Tipo de dados: Cadeia de caracteres

    externalId O ID externo desta linha da lista de preços.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir cria um novo registro de linha de lista de preços de acordo com os dados especificados no corpo da solicitação e o insere na tabela Linha de lista de preços [sn_csm_pricing_price_list_line].

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice " \
    --request POST\
    --user 'username':'password'
    --data {
      "name": "new Price list",
      "validFor": {
        "startDateTime": "2024-05-28 15:15:58",
        "endDateTime": "2025-06-28 15:15:58"
      },
      "priceType": "recurring",
      "recurringChargePeriodType": "monthly",
      "lastUpdate": "2023-09-23 00:00:00",
      "isBundle": false,
      "lifecycleStatus": "Draft",
      "unitOfMeasure": {
        "id": "1eaa559953020110286eddeeff7b12c7",
        "amount": 1,
        "units": "Year"
      },
      "price": {
        "unit": "USD",
        "value": "800"
      },
      "productOffering": {
        "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
        "name": "Maintenance Fee",
        "internalVersion": "1"
      },
      "priceList": {
        "name": "new price list",
        "@type": "priceList"
      },
      "externalId": "test123",
      "@type": "ProductOfferingPrice"
    }

    Corpo da resposta. Este novo registro de linha de lista de preços recebe um ID exclusivo; o corpo da resposta retorna essas informações junto com um URL para o novo registro usando hrefparâmetro de resposta.

    {
      "name": "new Price list",
      "validFor": {
        "startDateTime": "2024-05-28 15:15:58",
        "endDateTime": "2025-06-28 15:15:58"
      },
      "priceType": "recurring",
      "recurringChargePeriodType": "monthly",
      "lastUpdate": "2023-09-23 00:00:00",
      "isBundle": false,
      "lifecycleStatus": "Draft",
      "unitOfMeasure": {
        "id": "1eaa559953020110286eddeeff7b12c7",
        "amount": 1,
        "units": "Year"
      },
      "price": {
        "unit": "USD",
        "value": "800"
      },
      "productOffering": {
        "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
        "name": "Maintenance Fee",
        "internalVersion": "1"
      },
      "priceList": {
        "id": "194d5d364f8b5210f899f61d20ce0b7a",
        "name": "new Price list",
        "@type": "priceList"
      },
      "externalId": "test123",
      "@type": "ProductOfferingPrice",
      "id": "994d5d364f8b5210f899f61d20ce0b7c",
      "state": "draft",
      "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c"
    }

    API aberta do Catálogo de produtos - POST /sn_tmf_api/catalogmanagement/productSpecification

    Cria um registro de especificação do produto com os valores especificados.

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productSpecification

    Parâmetros de solicitação compatíveis

    Tabela 103. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 104. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 105. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    descrição Obrigatório. Descrição da especificação.

    Tipo de dados: Cadeia de caracteres

    externalId Identificador exclusivo para a especificação do produto do sistema externo.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Obrigatório. Sys_id ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Na initial_version ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    internalId Obrigatório.
    Sys_id ou ID interno da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].

    LastUpdate Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Cadeia de caracteres em branco

    nome Obrigatório. Nome da especificação.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic Característica de especificação.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristic": [
      {
        "description": "String",
        "name": "String",
        "productSpecCharacteristicValue": [Array],
        "validFor": {Object},
        "valueType": "String"
      }
    ]
    ProductSpecCharacteristic. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    ProductSpecCharacteristic. ​nome Obrigatório. Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue Obrigatório.
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​valor Obrigatório.
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ValidFor. ​EndDateTime Data de término da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Cadeia de caracteres em branco

    ProductSpecCharacteristic. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Cadeia de caracteres em branco

    ProductSpecCharacteristic. ​ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser do tipo complexo ou não complexo.

    Tipo de dados: Cadeia de caracteres

    Valores aceitos:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Teste de linha única
    • Array.Object
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha

    Cadeia de caracteres em branco

    ProductSpecificationRelationship Relações desta especificação com outras especificações de produto.

    Tipo de dados: Matriz

    "productSpecificationRelationship": [
      {
        "id": "String",
        "type": "String",
        "validFor": Object
      }
    ]
    ProductSpecificationRelationship. ​id ID da especificação relacionada.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    ProductSpecificationRelationship. ​tipo Necessário se estiver usando productSpecificationRelationshipparâmetro. Tipo de relacionamento.
    Valores válidos:
    • pacotes
    • composto_de

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor Intervalo de datas para o qual o relacionamento é válido.

    Tipo de dados: Objeto

    "validFor": {
       "endDateTime": "String",
       "startDateTime": "String"
    }
    ProductSpecificationRelationship. ​ValidFor. ​EndDateTime Data de término do relacionamento.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Cadeia de caracteres em branco

    ProductSpecificationRelationship. ​ValidFor. ​StartDateTime Data de início do relacionamento.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Cadeia de caracteres em branco

    ResourceSpecification Obrigatório. Especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "resourceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ResourceSpecification. ​id Obrigatório. Versão inicial ou ID externo da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalId Versão inicial (sys_id) do registro de especificação de recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalVersion Versão da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​nome Nome da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de recurso [sn_prd_pm_resource_specification]

    ResourceSpecification. ​versão Versão externa da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ServiceSpecification Lista de especificações de serviço relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "serviceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ServiceSpecification. ​id Versão inicial ou ID externo da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalId Versão inicial da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalVersion Versão da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​nome Nome da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    ServiceSpecification. ​versão Versão externa da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ValidFor Obrigatório. Intervalo de datas para o qual a especificação é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data de término da especificação.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Cadeia de caracteres em branco

    ValidFor. ​StartDateTime Data de início da especificação.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS. Por exemplo, 2025-01-31 09:35:43 .

    Cadeia de caracteres em branco

    versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    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 106. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 107. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 108. Códigos de status
    Código do status Descrição
    201 Solicitação processada com sucesso.
    400 Solicitação incorreta. Possíveis motivos:
    • Carga vazia.
    • Carga inválida. Campo obrigatório ausente: <field name>

    Parâmetros do corpo da resposta

    Nome Descrição
    descrição Descrição da especificação.

    Tipo de dados: Cadeia de caracteres

    href Link relativo para o registro de recurso.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    id Sys_id ou ID externo da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].

    internalId Obrigatório.
    Sys_id ou ID interno da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    InternalVersion Versão da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].

    IsPacote Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos.
    Valores válidos:
    • Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos.
    • Falso: A especificação do produto contém um único produto.

    Tipo de dados: Booliano

    Padrão: falso

    LastUpdate Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    LifeycleStatus Status do ciclo de vida atual da especificação do produto.
    Valores possíveis:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco

    nome Nome da especificação.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic Característica de especificação.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristic": [
      {
        "description": "String",
        "name": "String",
        "productSpecCharacteristicValue": [Array],
        "validFor": {Object},
        "valueType": "String"
      }
    ]
    ProductSpecCharacteristic. ​descrição Descrição da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​nome Nome da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue
    Lista dos valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "productSpecCharacteristicValue": [
     {
        "isDefault": Boolean,
        "isMandatory": Boolean,
        "validFor": {Object},
        "value": "String"
     }
    ]
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ÉPadrão Sinalizador que indica se o valor da característica associada é o valor padrão da característica.
    Valores possíveis:
    • Verdadeiro: Valor padrão.
    • Falso: Não é o valor padrão.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​É Obrigatório Sinalizador que indica se o valor da característica associada é um valor obrigatório para a característica.
    Valores possíveis:
    • Verdadeiro: Valor obrigatório.
    • Falso: Não é um valor obrigatório.

    Padrão: falso

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor Data e hora em que a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​ValidFor. ​StartDateTime Data e hora de início em que o valor da característica é válido.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ProductSpecCharacteristicValue. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    ProductSpecCharacteristic. ​ValidFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecCharacteristic. ​ValidFor. ​EndDateTime Data de término da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ValidFor. ​StartDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecCharacteristic. ​ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser do tipo complexo ou não complexo.

    Tipo de dados: Cadeia de caracteres

    Valores aceitos:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Teste de linha única
    • Array.Object
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha
    ProductSpecificationRelationship Relações desta especificação com outras especificações de produto.

    Tipo de dados: Matriz de objetos

    "productSpecificationRelationship": [
      {
        "id": "String",
        "type": "String",
        "validFor": Object
      }
    ]
    ProductSpecificationRelationship. ​id Sys_id da especificação relacionada.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​tipo Tipo de relacionamento.

    Tipo de dados: Cadeia de caracteres

    ProductSpecificationRelationship. ​ValidFor Intervalo de datas para o qual o relacionamento é válido.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ProductSpecificationRelationship. ​ValidFor. ​EndDateTime Data de término do relacionamento.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ProductSpecificationRelationship. ​ValidFor. ​StartDateTime Data de início do relacionamento.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ResourceSpecification Lista de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "resourceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ResourceSpecification. ​id Sys_id ou ID externo da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalId Versão inicial (sys_id) do registro de especificação de recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​InternalVersion Versão da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ResourceSpecification. ​nome Nome da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de recurso [sn_prd_pm_resource_specification]

    ResourceSpecification. ​versão Versão externa da especificação do recurso.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    ServiceSpecification Lista de especificações de serviço relacionadas a esta especificação de produto.

    Tipo de dados: Matriz de objetos

    "serviceSpecification": [
      {
        "id": "String",
        "internalId": "String",
        "internalVersion": "String",
        "name": "String",
        "version": "String"
      }
    ]
    ServiceSpecification. ​id Versão inicial ou ID externo da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalId Versão inicial da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​InternalVersion Versão da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ServiceSpecification. ​nome Nome da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    ServiceSpecification. ​versão Versão externa da especificação do serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].

    ValidFor Intervalo de datas para o qual a especificação é válida.

    Tipo de dados: Objeto

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor. ​EndDateTime Data de término da especificação.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    ValidFor. ​StartDateTime Data de início da especificação.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD HH:MM:SS

    versão Versão externa da especificação do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

    Este exemplo cria um registro de especificação de produto com os valores especificados.

    curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
    --header "Content-Type: application/json" \
    --data-raw '{
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "displayName": "SD-WAN Service Package v3",
      "version": "",
      "internalVersion": "3",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "description": "SD WAN Service Package",
      "lastUpdate": "2027-10-11 06:58:12",
      "isBundle": true,
      "validFor": {
        "startDateTime": "2029-02-05",
        "endDateTime": ""
      },
      "serviceSpecification": [],
      "productSpecificationRelationship": [
        {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "version": "",
          "internalVersion": "1",
          "internalId": "216663aa53702010cd6dddeeff7b12b5",
          "type": "Service",
          "validFor": {
            "startDateTime": "2025-01-24",
            "endDateTime": ""
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "1",
            "numberSpecRelUpperLimit": "1"
          }
        },
        {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "version": "",
          "internalVersion": "2",
          "internalId": "39b627aa53702010cd6dddeeff7b1202",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-05",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "2",
            "numberSpecRelUpperLimit": "4"
          }
        },
        {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "version": "",
          "internalVersion": "2",
          "internalId": "a6514bd3534560102f18ddeeff7b1247",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-03",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "4",
            "numberSpecRelUpperLimit": "20"
          }
        }
      ],
      "resourceSpecification": [],
      "productSpecCharacteristic": [
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.25",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.01",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.5",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Down Time",
          "description": "Down Time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:36:15"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "500 Mbps",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "5 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Bandwidth",
          "description": "Bandwidth",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:32:11"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "4 hrs",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 hr",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Time to Restore (TTR)",
          "description": "Time to Restore (TTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:37:25"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1 hr",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "4 hrs",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Mean Time to Restore (MTR)",
          "description": "Mean Time to Restore (MTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:39:05"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Flow Backup",
          "description": "Application Flow Backup",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:30:39"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "99.00",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.50",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.75",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.99",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Up Time",
          "description": "Up time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:34:30"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Encryption",
          "description": "Application Encryption",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:29:08"
          }
        }
      ],
      "status": "published"
    }'
    
    --user 'username':'password'
    

    Corpo da resposta.

    {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "displayName": "SD-WAN Service Package v3",
      "version": "",
      "internalVersion": "3",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "description": "SD WAN Service Package",
      "lastUpdate": "2027-10-11 06:58:12",
      "isBundle": true,
      "validFor": {
        "startDateTime": "2029-02-05",
        "endDateTime": ""
      },
      "serviceSpecification": [],
      "productSpecificationRelationship": [
        {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "version": "",
          "internalVersion": "1",
          "internalId": "216663aa53702010cd6dddeeff7b12b5",
          "type": "Service",
          "validFor": {
            "startDateTime": "2025-01-24",
            "endDateTime": ""
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "1",
            "numberSpecRelUpperLimit": "1"
          }
        },
        {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "version": "",
          "internalVersion": "2",
          "internalId": "39b627aa53702010cd6dddeeff7b1202",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-05",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "2",
            "numberSpecRelUpperLimit": "4"
          }
        },
        {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "version": "",
          "internalVersion": "2",
          "internalId": "a6514bd3534560102f18ddeeff7b1247",
          "type": "Service",
          "validFor": {
            "startDateTime": "2026-06-03",
            "endDateTime": "2031-07-05"
          },
          "relationshipType": "bundles",
          "ProdSpecRelationshipOption": {
            "numberSpecRelLowerLimit": "1",
            "numberSpecRelDefault": "4",
            "numberSpecRelUpperLimit": "20"
          }
        }
      ],
      "resourceSpecification": [],
      "productSpecCharacteristic": [
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.25",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.01",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "0.5",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Down Time",
          "description": "Down Time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:36:15"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "500 Mbps",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "5 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 Gbps",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Bandwidth",
          "description": "Bandwidth",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:32:11"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "4 hrs",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "1 hr",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Time to Restore (TTR)",
          "description": "Time to Restore (TTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:37:25"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "1 hr",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "2 hrs",
              "isMandatory":true,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "4 hrs",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Mean Time to Restore (MTR)",
          "description": "Mean Time to Restore (MTR)",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:39:05"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Flow Backup",
          "description": "Application Flow Backup",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:30:39"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "99.00",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.50",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.75",
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "99.99",
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Up Time",
          "description": "Up time",
          "valueType": "choice",
          "validFor": {
            "startDatetime": "2027-10-11 02:34:30"
          }
        },
        {
          "productSpecCharacteristicValue": [
            {
              "value": "No",
              "isMandatory":true,
              "isDefault":true,
              "validFor": {
                "startDateTime": ""
              }
            },
            {
              "value": "Yes",
              "isMandatory":false,
              "isDefault":false,
              "validFor": {
                "startDateTime": ""
              }
            }
          ],
          "name": "Application Encryption",
          "description": "Application Encryption",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2027-10-11 02:29:08"
          }
        }
      ],
      "status": "published"
    }'