API aberta do Catálogo de produtos

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 81 min. de leitura

    • A API Aberta do Catálogo de produtos 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 Now Platform. A API aberta do Catálogo de produtos é uma ServiceNow® implementação da especificação REST da API de gestão do catálogo de produtos do TM Fórum. Esta implementação é baseada na especificação REST da API de gestão de catálogo de produtos TMF620, versão 4, de abril de 2021.

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

    Esta API é fornecida no namespace sn_tmf_api.

    O usuário de chamada 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 da 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 - DELETE /sn_tmf_api/catalogmanagement/productOffering/{id}

    Exclui a oferta de produto especificada.

    Formato da URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

    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. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

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

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

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

    Solicitação de cURL

    O exemplo a seguir exclui a oferta de produto com um ID de 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 - DELETE /sn_tmf_api/catalogmanagement/productSpecification/{id}

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

    Ao chamar este método DELETE, 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 informando que a especificação já está arquivada.
    • Uma especificação de produto que não esteja 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 informando que a especificação foi movida de um estado ativo para um estado arquivado.
    • Uma especificação de produto associada a uma especificação de produto ou oferta ativa não pode ser excluída. A resposta retorna uma mensagem de erro.

    Formato da URL

    URL padrão: /sn_tmf_api/catalogmanagement/productSpecification/{id}

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    ID Sys_id da especificação do produto a ser excluída. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

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

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

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

    Solicitação de cURL

    O exemplo a seguir exclui a especificação do produto com um ID de 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 - GET /sn_tmf_api/catalogmanagement/catalog

    Recupera uma lista de todos os catálogos de oferta de produto.

    Formato da URL

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

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados.

    Tipo de dados: cadeia de caracteres
    limite Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro.

    Padrão: 20

    Máximo: 100

    Tipo de dados: número
    deslocamento Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Padrão: 0

    Tipo de dados: número
    Tabela 15. Parâmetros do corpo da solicitação (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
    Nenhum(a)
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Especifica o intervalo de conteúdo retornado em uma chamada paginada.

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

    Códigos de status

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

    Tabela 18. Códigos de status
    Código de status Descrição
    200 Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
    206 Recurso parcial retornado em resposta (com paginação).
    400
    Solicitação incorreta. Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 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.

    Tipo de dados: cadeia de caracteres
    ID Sys_id do catálogo de ofertas de produtos da tabela Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog].

    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 todos os catálogos de oferta de produto.

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

    Corpo da resposta.

    [
    {
        "id": "SD-WAN1344314wrfw14345",
        "name": "New Catalog",
        "description": "New Catalog"
    },
    {
        "id": "9919291ac34c20105252716b7d40dd0f",
        "name": "Enterprise Mobile Plan",
        "description": " Product Catalog for Enterprise Mobile Plan"
    }
]

    API aberta do Catálogo de produtos - GET /sn_tmf_api/catalogmanagement/catalog/{id}

    Recupera um catálogo de oferta de produto.

    Formato da URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/catalog/{id}

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    ID Sys_id do catálogo de oferta de produto a ser recuperado. Localizado na tabela Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog].

    Tipo de dados: cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados.

    Tipo de dados: cadeia de caracteres
    Tabela 21. Parâmetros do corpo da solicitação (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
    Nenhum(a)
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 24. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400
    Solicitação Incorreta. Pode ser 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 da tabela Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog].

    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 oferta de produto para um plano móvel empresarial.

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

    Corpo da resposta.

    {
   "id": "9919291ac34c20105252716b7d40dd0f",
   "name": "Enterprise Mobile Plan",
   "description": " Product Catalog for Enterprise Mobile Plan"
}

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

    Recupera todas as ofertas de produtos.

    Formato da URL

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

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 26. 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
    • últimaAtualização
    • nome
    • productCaracterística
    • productOfferingPrice
    • productOfferingTerm
    • productSpecification
    • prodSpecCharValueUse
    • validFor
    • versão

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

    Tipo de dados: cadeia de caracteres
    limite Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro.

    Padrão: 20

    Máximo: 100

    Tipo de dados: número
    deslocamento Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Padrão: 0

    Tipo de dados: número
    especificação Filtrar ofertas de produto por especificação de produto sys_id. Somente ofertas de produto com a especificação de produto sys_id especificada são retornadas na resposta. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    estado Filtrar ofertas de produtos por estado. Somente ofertas de produtos no estado especificado são retornadas na resposta.

    Valores aceitos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: cadeia de caracteres
    Tabela 27. Parâmetros do corpo da solicitação (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
    Nenhum(a)
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Especifica o intervalo de conteúdo retornado em uma chamada paginada.

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

    Códigos de status

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

    Tabela 30. Códigos de status
    Código de status Descrição
    200 Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
    206 Recurso parcial retornado em resposta (com paginação).
    400
    Solicitação incorreta. Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 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
    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
    canal.id Sys_id do canal da tabela Canal de distribuição [sn_prd_pm_distribution_channel].

    Tipo de dados: cadeia de caracteres
    canal.nome Nome do canal.

    Tipo de dados: cadeia de caracteres
    descrição Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    externalId external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    href Um link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Obrigatório. initial_version ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId initial_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    últimaAtualização Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    lifecycleStatus Status do ciclo de vida atual da oferta do produto.

    Valores aceitos:

    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    productCaracterí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
    productCaracterística.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice Informações de preço para a oferta de produto.

    Tipo de dados: matriz de objetos

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfertaPreço.preço Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfertaPreço.preço.impostoIncludedAmount Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    productOfertaPreço.preço.impostoValorincluído.unidade Código da moeda para o preço de oferta do produto.

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoIncludedAmount.value Preço da oferta de produto, incluindo impostos.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice.PriceTipo Tipo de preço de oferta do produto, pagamento único ou recorrente.
    Valores válidos:
    • não recorrente (uma vez)
    • recorrente

    Tipo de dados: cadeia de caracteres
    productOfferingTerm Duração válida do termo de contrato para a oferta de produto.

    Tipo de dados: cadeia de caracteres
    productSpecification Especificação do produto para o produto.

    Tipo de dados: objeto

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalId initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalVersion Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.version external_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse Características da oferta de produto.

    Tipo de dados: matriz de objetos

    "prodSpecCharValueUse": [
  {
    "productSpecCharacteristicValue": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue Valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
  {
    "value": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.description Descrição da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.name Nome 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": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.endDateTime Data de término da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.validFor.startDateTime Data de início da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.valueType Tipo de valor da característica, como opção ou e-mail.
    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 do produto.

    Tipo de dados: cadeia de caracteres
    versão external_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo recupera todas as ofertas de produtos.

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

    Corpo da resposta:

    [
   {
      "id": "24413",
      "name": "Premium SD-WAN Offering New",
      "version": "",
      "internalVersion": "1",
      "internalId": "0199f8e65b430110235d85cced81c7d2",
      "description": "Premium SD-WAN Offering",
      "lastUpdate": "2022-01-27 05:41:16",
      "validFor": {
         "startDateTime": "2021-08-05",
         "endDateTime": "2026-09-04"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
         {
            "priceType": "recurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "JPY",
                  "value": 984.0913
               }
            }
         },
         {
            "priceType": "nonRecurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "GBP",
                  "value": 2434
               }
            }
         }
      ],
      "productSpecification": {
         "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
         "name": "SD-WAN Service Package",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
         {
            "name": "Routing",
            "description": "Routing",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:08:20"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "WAN Optimization",
            "description": "WAN Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:10:28"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "CPE Model",
            "description": "CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:54"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "ISR",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "ASR",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Security Type",
            "description": "Security Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-30 12:51:13"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247"
            }
         },
         {
            "name": "CPE Type",
            "description": "CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:16"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Tenancy",
            "description": "Tenancy",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:04:24"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Advance (50 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base (10 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium (>50 sites)",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5"
            }
         }
      ],
      "channel": [
         {
            "id": "e561aae4c3e710105252716b7d40dd8f",
            "name": "Web"
         }
      ],
      "category": {
         "id": "c0ed043653b02010cd6dddeeff7b1277",
         "name": "SD-WAN"
      }
   }
]

    API aberta do Catálogo de produtos - GET /sn_tmf_api/catalogmanagement/productOffering/{id}

    Recupera uma oferta de produto.

    Formato da URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    ID Initial_version da oferta de produto a ser recuperada. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    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
    • últimaAtualização
    • nome
    • productCaracterística
    • productOfferingPrice
    • productOfferingTerm
    • productSpecification
    • prodSpecCharValueUse
    • validFor
    • versão

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

    Tipo de dados: cadeia de caracteres
    especificação Filtrar ofertas de produto por especificação de produto sys_id. Somente ofertas de produto com a especificação de produto sys_id especificada são retornadas na resposta. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    estado Filtrar ofertas de produtos por estado. Somente ofertas de produtos no estado especificado são retornadas na resposta.

    Valores aceitos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: cadeia de caracteres
    Tabela 33. Parâmetros do corpo da solicitação (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
    Nenhum(a)
    Tabela 35. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 36. Códigos de status
    Código de 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
    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: matriz

    "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

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

    Tipo de dados: cadeia de caracteres
    canal.id Sys_id do canal da tabela Canal de distribuição [sn_prd_pm_distribution_channel].

    Tipo de dados: cadeia de caracteres
    canal.nome Nome do canal.

    Tipo de dados: cadeia de caracteres
    descrição Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    externalId external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    href Um link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Obrigatório. initial_version ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId initial_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    últimaAtualização Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    lifecycleStatus Indica o status do ciclo de vida atual da oferta do produto. Valores aceitos:
    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    productCaracterística Lista de características do produto.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    productCaracterística.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice Informações de preço para a oferta de produto.

    Tipo de dados: matriz

    "productOfferingPrice": [
   {
      "price": Object,
      "priceType": "String"
   }
]
    productOfertaPreço.preço Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "price": {
   "taxIncludedAmount": Object
}
    productOfertaPreço.preço.impostoIncludedAmount Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "taxIncludedAmount": {
   "unit": "String",
   "value": "String"
}
    productOfertaPreço.preço.impostoValorincluído.unidade Código da moeda para o preço de oferta do produto.

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoIncludedAmount.value Preço da oferta de produto, incluindo impostos.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice.PriceTipo Identifica se o preço de oferta do produto é um pagamento único ou recorrente.
    Valores válidos:
    • não recorrente
    • recorrente

    Tipo de dados: cadeia de caracteres
    productOfferingTerm Duração válida do termo de contrato para a oferta de produto.

    Tipo de dados: cadeia de caracteres
    productSpecification Especificação do produto para o produto.

    Tipo de dados: objeto

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalId initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalVersion Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.version external_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse Característica da oferta de produto.

    Tipo de dados: matriz

    "prodSpecCharValueUse": [
   {
      "productSpecCharacteristicValue": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    prodSpecCharValueUse.productSpecCharacteristicValue Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "productSpecCharacteristicValue": [
   {
      "value": "String"
   }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.description Descrição da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.name Nome 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": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.endDateTime Data de término da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.validFor.startDateTime Data de início da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.valueType O tipo de valor da característica, como opção ou e-mail.
    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 do produto.

    Tipo de dados: cadeia de caracteres
    versão external_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo recupera uma oferta de produto.

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

    Corpo da resposta:

    {
   "id": "24413",
   "name": "Premium SD-WAN Offering New",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2022-01-27 05:41:16",
   "version": "",
   "internalVersion": "2",
   "internalId": "69017a0f536520103b6bddeeff7b127d",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "not_applicable",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-30 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "abc",
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}

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

    Recupera todas as especificações do produto.

    Formato da URL

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

    Parâmetros de solicitação compatíveis

    Tabela 37. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    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:
    • descrição
    • externalId
    • ID
    • internalId
    • internalVersion
    • últimaAtualização
    • nome
    • productSpecCharacteristic
    • productSpecificationRelationship
    • especificação de recurso
    • EspecificaçãoDeServiço
    • validFor
    • versão

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

    Tipo de dados: cadeia de caracteres
    limite Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro.

    Padrão: 20

    Máximo: 100

    Tipo de dados: número
    deslocamento Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Padrão: 0

    Tipo de dados: número
    estado Filtrar especificações de produto por estado. Somente especificações de produto no estado especificado são retornadas na resposta.

    Valores aceitos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: cadeia de caracteres
    Tabela 39. Parâmetros do corpo da solicitação (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 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Nenhum(a)
    Tabela 41. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Especifica o intervalo de conteúdo retornado em uma chamada paginada.

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

    Códigos de status

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

    Tabela 42. Códigos de status
    Código de status Descrição
    200 Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
    206 Recurso parcial retornado em resposta (com paginação).
    400
    Solicitação incorreta. Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 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
    externalId Obrigatório. External_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    href Link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Initial_version ou external_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalId Obrigatório. Initial_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    éPacote Sinalizador que indica se productSpecification representa 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
    últimaAtualização Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    lifecycleStatus Status do ciclo de vida atual da especificação do produto.

    Valores aceitos:

    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Nome da especificação.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic Característica da especificação.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.name Nome da característica.

    Tipo de dados: cadeia de caracteres
    CaracterísticaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto Lista de valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
  {
    "value": "String"
  }
]
    característicaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto.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
    productSpecCharacteristic.validFor.startDateTime Data de início da característica.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.valueType Tipo de valor da característica, como opção ou e-mail.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship Relacionamentos desta especificação com outras especificações de 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.type 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
    productSpecificationRelationship.validFor.startDateTime Data de início do relacionamento.

    Tipo de dados: cadeia de caracteres
    especificação de recurso 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 Initial_version ou external_id da especificação de recurso. Localizado no campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Initial_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalVersion Versão da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.name Nome da especificação do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.version External_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    EspecificaçãoDeServiço 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 Initial_version ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalId Initial_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.name Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.version External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    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 External_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo recupera todas as especificações de produto.

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

    Corpo da resposta:

    [
   {
      "id": "0c47f2257441c110f877ca57242ff9bd",
      "name": "SD-WAN My Device",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "0c47f2257441c110f877ca57242ff9bd",
      "description": "This is my product specification ...",
      "lastUpdate": "2022-01-14 17:57:23",
      "validFor": {
         "startDateTime": "2022-01-11",
         "endDateTime": "2027-01-10"
      },
      "serviceSpecification": [
         {
            "id": "e23ae2d01bb420106ba59acf034bcb56",
            "name": "IP Sec Tunnel",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "e23ae2d01bb420106ba59acf034bcb56"
         }
      ],
      "productSpecificationRelationship": [
         {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "1",
            "type": "Service",
            "validFor": {
               "startDateTime": "2022-01-11",
               "endDateTime": "2027-02-12"
            }
         }
      ],
      "resourceSpecification": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "493fa60b536520103b6bddeeff7b12b6"
         }
      ],
      "productSpecCharacteristic": [
         {
            "name": "New characteristic",
            "description": "This product has new spec characteristic.",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-13 06:47:43"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "TestValue",
                  "validFor": {
                     "startDateTime": "2022-01-11"
                  }
               }
            ]
         }
      ]
   }
]

    API aberta do Catálogo de produtos - GET /sn_tmf_api/catalogmanagement/productSpecification/{id}

    Recupera uma especificação de produto especificada.

    Formato da URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

    Parâmetros de solicitação compatíveis

    Tabela 43. Parâmetros de caminho
    Nome Descrição
    especificaçãoId O initial_version da especificação do produto a ser recuperado. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    Tabela 44. 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
    • últimaAtualização
    • nome
    • productSpecCharacteristic
    • productSpecificationRelationship
    • especificação de recurso
    • EspecificaçãoDeServiço
    • validFor
    • versão

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

    Tipo de dados: cadeia de caracteres
    estado Filtrar especificações de produto por estado. Somente especificações de produto no estado especificado são retornadas na resposta.

    Valores aceitos:

    • arquivado
    • rascunho
    • publicado
    • descontinuado

    Tipo de dados: cadeia de caracteres
    Tabela 45. Parâmetros do corpo da solicitação (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
    Nenhum(a)
    Tabela 47. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

    Códigos de status

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

    Tabela 48. Códigos de status
    Código de 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
    externalId Obrigatório. External_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    href Link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Initial_version ou external_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalId Obrigatório. Initial_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    éPacote Sinalizador que indica se productSpecification representa 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
    últimaAtualização Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    lifecycleStatus Indica o status do ciclo de vida atual da especificação do produto.
    Valores válidos:
    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Nome da especificação.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic Características da especificação.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.name Nome da característica.

    Tipo de dados: cadeia de caracteres
    CaracterísticaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto Valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
  {
    "value": "String"
  }
]
    característicaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto.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
    productSpecCharacteristic.validFor.startDateTime Data de início da característica.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.valueType Tipo de valor da característica, como opção ou e-mail.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship Relacionamentos desta especificação com outras especificações de 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.type 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
    productSpecificationRelationship.validFor.startDateTime Data de início do relacionamento.

    Tipo de dados: cadeia de caracteres
    especificação de recurso 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 Initial_version ou external_id da especificação de recurso. Localizado no campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Initial_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalVersion Versão da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.name Nome da especificação do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.version External_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    EspecificaçãoDeServiço 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 Initial_version ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalId Initial_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.name Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.version External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    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 External_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo recupera uma especificação de produto.

    curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification/0c47f2257441c110f877ca57242ff9bd" \
--user 'username':'password'

    Corpo da resposta:

    {
   "id": "0c47f2257441c110f877ca57242ff9bd",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalVersion": "1",
   "internalId": "0c47f2257441c110f877ca57242ff9bd",
   "description": "This is my product specification ...",
   "lastUpdate": "2022-01-14 17:57:23",
   "validFor": {
      "startDateTime": "2022-01-11",
      "endDateTime": "2027-01-10"
   },
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "version": "v1",
         "internalVersion": "1",
         "internalId": " a6514bd3534560102f18ddeeff7b1247",
         "type": "Service",
         "validFor": {
            "startDateTime": "2022-01-11",
            "endDateTime": "2027-02-12"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ],
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-13 06:47:43"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "TestValue",
               "validFor": {
                  "startDateTime": "2022-01-11"
               }
            }
         ]
      }
   ]
}

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

    Atualiza a oferta de produto especificada.

    Formato da URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

    Parâmetros de solicitação compatíveis

    Tabela 49. Parâmetros de caminho
    Nome Descrição
    ID Sys_id da oferta de produto a ser atualizada. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    Tabela 50. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 51. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    categoria Lista de categorias às quais o produto pertence. Localizado na tabela Categoria [sc_category].

    Tipo de dados: matriz de objetos

    "category:" [
  {
    "id": "String",
    "name": "String"
  }
]
    category.id Obrigatório se estiver usando o parâmetro category. ID da categoria. Localizado na tabela Categoria [sc_category].

    Tipo de dados: cadeia de caracteres
    category.name Nome da categoria.

    Tipo de dados: cadeia de caracteres

    Padrão: 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"
  }
]
    canal.descrição Descrição do canal.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    canal.id Obrigatório. Sys_id do canal da tabela Canal de distribuição [sn_prd_pm_distribution_channel].

    Tipo de dados: cadeia de caracteres
    canal.nome Nome do canal.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    descrição Obrigatório. Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    externalId external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    ID Obrigatório. initial_version ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId initial_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    últimaAtualização Data em que a oferta de produto foi atualizada pela última vez.

    Formato: AAAA-MM-DD 00:00:00

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Obrigatório. Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    productCaracterí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

    Padrão: cadeia de caracteres em branco
    productCaracterística.valor Valor da característica.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productOfferingPrice Informações de preço para a oferta de produto.

    Tipo de dados: matriz de objetos

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfertaPreço.preço Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfertaPreço.preço.impostoIncludedAmount Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    productOfertaPreço.preço.impostoValorincluído.unidade Código da moeda para o preço de oferta do produto.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productOfertaPreço.preço.impostoIncludedAmount.value Preço da oferta de produto, incluindo impostos. Use um valor decimal, por exemplo, 123,45.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productOfferingPrice.PriceTipo O tipo de oferta de produto. Obrigatório se estiver usando o parâmetro productOfferingPrice.
    Valores válidos:
    • não recorrente (uma vez)
    • recorrente

    Tipo de dados: cadeia de caracteres
    productOfferingTerm Duração válida do contrato em meses para a oferta do produto.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productSpecification Obrigatório. Especificação do produto para o produto.

    Tipo de dados: objeto

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id Obrigatório. Initial_version ou external_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalId initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalVersion Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.version external_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse Características da oferta de produto.

    Tipo de dados: matriz de objetos

    "prodSpecCharValueUse": [
  {
    "productSpecCharacteristicValue": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
    {
      "validFor": {
        "startDateTime": "String"
      },
      "value": "String"
    }
  ]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.productSpecCharacteristicValue.validFor A data e a 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 a característica é válida.

    Formato: AAAA-MM-DD 00:00:00

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.description 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.validFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: objeto

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.endDateTime Data e hora de término da característica.

    Formato: AAAA-MM-DD 00:00:00

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.validFor.startDateTime Data e hora de início da característica.

    Formato: AAAA-MM-DD 00:00:00

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.valueType Tipo de valor da característica, como opção ou e-mail.

    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 do produto.

    Formato: AAAA-MM-DD 00:00:00

    Tipo de dados: cadeia de caracteres
    validFor.startDateTime Obrigatório. Data e hora de início da oferta do produto.

    Formato: AAAA-MM-DD 00:00:00

    Tipo de dados: cadeia de caracteres
    versão external_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres

    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 52. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

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

    Padrão: application/json

    Códigos de status

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

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

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

    Nome Descrição
    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
    categoria.nome 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
    canal.id Sys_id do canal da tabela Canal de distribuição [sn_prd_pm_distribution_channel].

    Tipo de dados: cadeia de caracteres
    canal.nome Nome do canal.

    Tipo de dados: cadeia de caracteres
    descrição Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    externalId external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    href Um link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Obrigatório. initial_version ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId initial_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    últimaAtualização Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    statuscicloelevador Indica o status do ciclo de vida atual. Valores aceitos:
    • Ativo
    • Rascunho
    • Inativo

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    productCaracterística Lista de características do produto.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    productCaracterística.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice Informações de preço para a oferta de produto.

    Tipo de dados: matriz de objetos

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfertaPreço.preço Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfertaPreço.preço.impostoIncludedAmount Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    productOfertaPreço.preço.impostoValorincluído.unidade Código da moeda para o preço de oferta do produto.

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoIncludedAmount.value Preço da oferta de produto, incluindo impostos.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice.PriceTipo Tipo de preço da oferta de produto, pagamento único ou recorrente.Valores possíveis:
    • não recorrente (uma vez)
    • recorrente

    Tipo de dados: cadeia de caracteres
    productOfferingTerm Duração válida do termo de contrato para a oferta de produto.

    Tipo de dados: cadeia de caracteres
    productSpecification Especificação do produto para o produto.

    Tipo de dados: objeto

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalId initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalVersion Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.version external_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse Características da oferta de produto.

    Tipo de dados: matriz de objetos

    "prodSpecCharValueUse": [
  {
    "productSpecCharacteristicValue": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object}
    "productSpecCharacteristicValue": [Array],
    "valueType": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
    {
      "validFor": {
        "startDateTime": "String"
      },
      "value": "String"
    }
  ]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.productSpecCharacteristicValue.validFor A data e a 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 a característica é válida.

    Formato: AAAA-MM-DD 00:00:00

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.description Descrição da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.name Nome 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": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.endDateTime Data de término da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.validFor.startDateTime Data de início da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.valueType Tipo de valor da característica, como opção ou e-mail.
    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 do produto.

    Tipo de dados: cadeia de caracteres
    versão external_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

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

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "name": "Offering 1",
  "displayName": "Offering 1",
  "description": "Offering 1 desc",
  "lastUpdate": "2024-04-01 16:05:19",
  "version": "Offering 1 EXTV",
  "validFor": {
    "startDateTime": "2028-02-29",
    "endDateTime": "2033-03-30"
  },
  "productOfferingTerm": "12_months",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 632.1483
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 1264.2966
        }
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "internalVersion": "3"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2026-12-06 02:32:11"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "1 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "500 Mbps",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "internalVersion": "3"
      }
    }
  ],
  "channel": [
    {
      "id": "e561aae4c3e710105252716b7d40dd8f",
      "name": "Web"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ]
}'

    Corpo da resposta:

    {
  "result": {
    "name": "Offering 1",
    "displayName": "Offering 1",
    "description": "Offering 1 desc",
    "lastUpdate": "2024-04-01 16:05:19",
    "version": "Offering 1 EXTV",
    "validFor": {
      "startDateTime": "2028-02-29",
      "endDateTime": "2033-03-30"
    },
    "productOfferingTerm": "12_months",
    "productOfferingPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 632.1483
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 1264.2966
          }
        }
      }
    ],
    "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "internalVersion": "3",
      "sys_id": "79fa17da775131108e191e599a5a997b",
      "version": "",
      "status": "published",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
    },
    "prodSpecCharValueUse": [
      {
        "name": "Bandwidth",
        "description": "Bandwidth",
        "valueType": "choice",
        "validFor": {
          "startDatetime": "2026-12-06 02:32:11"
        },
        "productSpecCharacteristicValue": [
          {
            "value": "1 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "5 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "2 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "500 Mbps",
            "validFor": {
              "startDateTime": ""
            }
          }
        ],
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "internalVersion": "3",
          "version": "",
          "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
        }
      }
    ],
    "channel": [
      {
        "id": "e561aae4c3e710105252716b7d40dd8f",
        "name": "Web"
      }
    ],
    "category": [
      {
        "id": "13e305a143b631105029d1529ab8f267",
        "name": "SD-WAN_all_offers"
      }
    ],
    "href": "/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb"
  }
}

    API aberta do Catálogo de produtos - PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}

    Atualiza a especificação do produto especificada.

    Formato da URL

    URL padrão: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

    Parâmetros de solicitação compatíveis

    Tabela 55. Parâmetros de caminho
    Nome Descrição
    ID Sys_id da oferta de produto a ser atualizada. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    Tabela 56. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 57. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    descrição Obrigatório. Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    externalId Obrigatório. External_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    ID Initial_version ou external_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalId Obrigatório. Initial_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    éPacote

    Sinalizador que indica se productSpecification representa 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
    últimaAtualização Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Obrigatório. Nome da especificação.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic Característica da especificação.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.name Obrigatório. Nome da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.productSpecCharacteristicValue Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
    {
      "validFor": {
        "startDateTime": "String"
      },
      "value": "String"
    }
  ]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.productSpecCharacteristicValue.validFor A data e a 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 a característica é válida.

    Formato: AAAA-MM-DD 00:00:00

    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. 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 00:00:00. Por exemplo, 2025-01-31 09:35:43.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.valueType O tipo de valor da característica, como opção ou e-mail.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship Relacionamentos desta especificação com outras especificações de 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.type Obrigatório se estiver usando o parâmetro productSpecificationRelationship. 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 00:00:00. 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
    especificação de recurso Obrigatório. Matriz 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 Obrigatório. Initial_version ou external_id da especificação de recurso. Localizado no campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Initial_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalVersion Versão da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.name Nome da especificação do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.version External_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    EspecificaçãoDeServiço 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 Initial_version ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalId Initial_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.name Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.version External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    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 External_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    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 58. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 59. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 60. Códigos de status
    Código de 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 (JSON ou XML)

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

    Tipo de dados: cadeia de caracteres
    href Um link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres
    ID Initial_version ou external_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalId Obrigatório. Initial_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    últimaAtualização 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 Características da especificação.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.name Nome da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.productSpecCharacteristicValue Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
    {
      "validFor": {
        "startDateTime": "String"
      },
      "value": "String"
    }
  ]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.productSpecCharacteristicValue.validFor A data e a 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 a característica é válida.

    Formato: AAAA-MM-DD 00:00:00

    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.valueType O tipo de valor da característica, como opção ou e-mail.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship Relacionamentos 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.type 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 de relacionamento.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship.validFor.startDateTime Data de início e tipo de relacionamento.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    especificação de recurso 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 Initial_version ou external_id da especificação de recurso. Localizado no campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Initial_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalVersion Versão da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.name Nome da especificação do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.version External_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    EspecificaçãoDeServiço 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 Initial_version ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalId Initial_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.name Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.version External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    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 e hora de término da especificação.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    validFor.startDateTime Data e hora de início da especificação.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    versão External_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    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": "1001",
  "name": "SD-WAN 0322 test",
  "description": "This is my product specification ...",
  "validFor": {
    "startDateTime": "2017-06-19T00:00",
    "endDateTime": "2018-01-13T00:00"
  },
  "productSpecCharacteristic": [
    {
      "name": "New characteristic",
      "description": "This product has new spec characteristic.",
      "valueType": "label",
      "validFor": {
        "startDateTime": "2017-06-20T00:00"
      }
    }
  ],
  "serviceSpecification": [
    {
      "id": "e23ae2d01bb420106ba59acf034bcb56",
      "name": "IP Sec Tunnel",
      "internalVersion": "2"
    }
  ],
  "productSpecificationRelationship": [
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "internalVersion": "2",
      "type": "bundles",
      "validFor": {
        "startDateTime": "2017-06-16T00:00"
      }
    }
  ],
  "resourceSpecification": [
    {
      "id": "493fa60b536520103b6bddeeff7b12b6",
      "name": "Customer Premise SD-WAN Router"
    }
  ],
  "@type": "ProductSpecification"
}

    Corpo da resposta:

    {
  "result": {
    "id": "1001",
    "name": "SD-WAN 0322 test",
    "description": "This is my product specification ...",
    "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
    },
    "productSpecCharacteristic": [
      {
        "name": "New characteristic",
        "description": "This product has new spec characteristic.",
        "valueType": "label",
        "validFor": {
          "startDateTime": "2017-06-20T00:00"
        }
      }
    ],
    "serviceSpecification": [
      {
        "id": "e23ae2d01bb420106ba59acf034bcb56",
        "name": "IP Sec Tunnel",
        "internalVersion": "2",
        "sys_id": "dd8354205b550210235d85cced81c7cd",
        "version": "",
        "status": "published",
        "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
    ],
    "productSpecificationRelationship": [
      {
        "id": "a6514bd3534560102f18ddeeff7b1247",
        "name": "SD-WAN Security",
        "internalVersion": "2",
        "type": "bundles",
        "validFor": {
          "startDateTime": "2017-06-16T00:00"
        },
        "sys_id": "7a491dd3776301108b2a1e599a5a99d3",
        "version": "",
        "status": "published",
        "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
    ],
    "resourceSpecification": [
      {
        "id": "493fa60b536520103b6bddeeff7b12b6",
        "name": "Customer Premise SD-WAN Router",
        "sys_id": "493fa60b536520103b6bddeeff7b12b6",
        "internalVersion": "1",
        "version": "",
        "status": "published",
        "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
    ],
    "@type": "ProductSpecification",
    "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/3d140fe85be1c210235d85cced81c73a"
  }
}

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

    Cria um catálogo de ofertas de produtos.

    Formato da URL

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

    Parâmetros de solicitação compatíveis

    Tabela 61. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 62. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 63. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    descrição Descrição do catálogo de ofertas de produtos.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    externalId Identificador exclusivo do catálogo de ofertas de produtos do sistema externo.

    Tipo de dados: cadeia de caracteres

    Padrão: 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 64. 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 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 66. Códigos de status
    Código de status Descrição
    201 Solicitação processada com sucesso.
    400 Solicitação Incorreta. Pode ser 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 da tabela Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog].

    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 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.

    Formato da 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
    Nenhum(a)
    Tabela 68. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 69. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    categoria Lista de categorias às quais o produto pertence. Localizado na tabela Categoria [sc_category].

    Tipo de dados: matriz de objetos

    "category:" [
  {
    "id": "String",
    "name": "String"
  }
]
    category.id Obrigatório se estiver usando o parâmetro category. ID da categoria.

    Tipo de dados: cadeia de caracteres
    category.name Nome da categoria.

    Tipo de dados: cadeia de caracteres
    canal Obrigatório. Canais a serem usados para vender a oferta de produto.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    canal.id Obrigatório. Sys_id do canal da tabela Canal de distribuição [sn_prd_pm_distribution_channel].

    Tipo de dados: cadeia de caracteres
    canal.nome 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
    externalId Identificador exclusivo da oferta de produto do sistema externo.

    Tipo de dados: cadeia de caracteres
    href Um link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres
    ID Obrigatório. Initial_version ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId initial_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    últimaAtualização Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    lifecycleStatus Indica o status do ciclo de vida atual. Valores aceitos:
    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: cadeia de caracteres
    nome Obrigatório. Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    productCaracterí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
    productCaracterística.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice Informações de preço para a oferta de produto.

    Tipo de dados: matriz de objetos

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfertaPreço.preço Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfertaPreço.preço.impostoIncludedAmount Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    productOfertaPreço.preço.impostoValorincluído.unidade Código da moeda para o preço de oferta do produto.

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoIncludedAmount.value Preço da oferta de produto, incluindo impostos.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice.PriceTipo Obrigatório se estiver usando o parâmetro productOfferingPrice. 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
    productOfferingTerm Duração válida do termo de contrato para a oferta de produto.

    Tipo de dados: cadeia de caracteres
    productSpecification Obrigatório. Especificação do produto para o produto.

    Tipo de dados: objeto

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id Obrigatório. Initial_version ou external_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalId initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalVersion Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.version external_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse Características da oferta de produto.

    Tipo de dados: matriz de objetos

    "prodSpecCharValueUse": [
  {
    "productSpecCharacteristicValue": Array,
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue Obrigatório. Lista dos valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
  {
    "value": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Obrigatório. Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.description 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.validFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: objeto

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.endDateTime Data de término da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.validFor.startDateTime Data de início da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.valueType Tipo de valor da característica, como opção ou e-mail.

    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 Data de término da oferta do produto.

    Tipo de dados: cadeia de caracteres
    validFor.startDateTime Data de início da oferta do produto.

    Tipo de dados: cadeia de caracteres
    versão external_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    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 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 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 72. Códigos de status
    Código de 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 (JSON)

    Nome Descrição
    categoria Lista de categorias às quais o produto pertence.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    categoria.nome 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
    canal.id Sys_id do canal da tabela Canal de distribuição [sn_prd_pm_distribution_channel].

    Tipo de dados: cadeia de caracteres
    canal.nome Nome do canal.

    Tipo de dados: cadeia de caracteres
    descrição Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    externalId external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    href Um link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Obrigatório. initial_version ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId initial_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    últimaAtualização Data em que a oferta de produto foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres
    lifecycleStatus Status do ciclo de vida atual da oferta do produto.

    Valores aceitos:

    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    productCaracterística Lista de características do produto.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    productCaracterística.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice Informações de preço para a oferta de produto.

    Tipo de dados: matriz de objetos

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfertaPreço.preço Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfertaPreço.preço.impostoIncludedAmount Informações de preço para a oferta de produto.

    Tipo de dados: objeto

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    productOfertaPreço.preço.impostoValorincluído.unidade Código da moeda para o preço de oferta do produto.

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoIncludedAmount.value Preço da oferta de produto, incluindo impostos.

    Tipo de dados: cadeia de caracteres
    productOfferingPrice.PriceTipo 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
    productOfferingTerm Duração válida do termo de contrato para a oferta de produto.

    Tipo de dados: cadeia de caracteres
    productSpecification Especificação do produto para o produto.

    Tipo de dados: objeto

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalId initial_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.internalVersion Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    productSpecification.version external_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse Características da oferta de produto.

    Tipo de dados: matriz de objetos

    "prodSpecCharValueUse": [
  {
    "productSpecCharacteristicValue": Array,
    "description": "String",
    "name": "String",
    "validFor": Object,
    "valueType": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue Lista dos valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
  {
    "value": "String"
  }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.value Valor da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.description Descrição da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.name Nome 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": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.endDateTime Data de término da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.validFor.startDateTime Data de início da característica.

    Tipo de dados: cadeia de caracteres
    prodSpecCharValueUse.valueType Tipo de valor da característica, como opção ou e-mail.

    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 do produto.

    Tipo de dados: cadeia de caracteres
    versão external_version da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    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" \
--data-raw '{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": "",
   "internalVersion": "2",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " 39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}'
--user 'username':'password'

    Corpo da resposta:

    {
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": null,
   "internalVersion": "5",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": null,
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": null,
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": null,
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   },
   "internalId": "fbc1c0a25b030110235d85cced81c724",
   "externalId": "d52a756b5bde0110235d85cced81c7ab"
}

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

    Cria uma especificação de produto.

    Formato da URL

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

    Parâmetros de solicitação compatíveis

    Tabela 73. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 74. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 75. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    descrição Obrigatório. Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    externalId Identificador exclusivo da especificação do produto do sistema externo.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Obrigatório. Initial_version ou external_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalId Obrigatório. Initial_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    últimaAtualização Data em que a especificação foi atualizada pela última vez.

    Formato: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Obrigatório. Nome da especificação.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic Característica da especificação.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productSpecCharacteristic.name Obrigatório. Nome da característica.

    Tipo de dados: cadeia de caracteres
    CaracterísticaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto Obrigatório. Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "productSpecCharacteristicValue": [
   {
      "value": "String"
   }
]
    característicaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto.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.

    Formato: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productSpecCharacteristic.validFor.startDateTime Data de início da característica.

    Formato: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productSpecCharacteristic.valueType O tipo de valor da característica, como opção ou e-mail.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productSpecificationRelationship Relacionamentos 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

    Padrão: cadeia de caracteres em branco
    productSpecificationRelationship.type Obrigatório se estiver usando o parâmetro productSpecificationRelationship. Tipo de relacionamento.
    Valores válidos:
    • composto_de
    • pacotes

    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 00:00:00. Por exemplo, 2025-01-31 09:35:43.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    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

    Padrão: cadeia de caracteres em branco
    especificação de recurso Obrigatório. Matriz de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: matriz

    "resourceSpecification": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id Obrigatório. O initial_version ou external_id da especificação de recurso. Localizado no campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Initial_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalVersion Versão da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.name Nome da especificação do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.version External_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    EspecificaçãoDeServiço 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 Initial_version ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalId Initial_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.name Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.version External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    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.

    Formato: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    validFor.startDateTime Data 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

    Padrão: cadeia de caracteres em branco
    versão External_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    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 76. 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 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 78. Códigos de status
    Código de 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 (JSON)

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

    Tipo de dados: cadeia de caracteres
    href Link relativo para o registro do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ID Initial_version ou external_id da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalId Obrigatório. Initial_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres
    éPacote Sinalizador que indica se productSpecification representa 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
    últimaAtualização Data em que a especificação foi atualizada pela última vez.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    lifecycleStatus Status do ciclo de vida atual da especificação do produto.
    Valores possíveis:
    • Ativo
    • Inativo
    • Rascunho

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    nome Nome da especificação.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic Característica da especificação.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.name Nome da característica.

    Tipo de dados: cadeia de caracteres
    CaracterísticaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "productSpecCharacteristicValue": [
   {
      "value": "String"
   }
]
    característicaEspecíficoDoProduto.ValorCaracterísticaEspecíficoDoProduto.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.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.validFor.startDateTime Data de início da característica.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.valueType O tipo de valor da característica, como opção ou e-mail.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship Relacionamentos desta especificação com outras especificações de produto.

    Tipo de dados: matriz

    "productSpecificationRelationship": [
   {
      "id": "String",
      "type": "String",
      "validFor": Object
   }
]
    productSpecificationRelationship.id Sys_id da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship.type 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.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship.validFor.startDateTime Data de início do relacionamento.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    especificação de recurso 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 Initial_version ou external_id da especificação de recurso. Localizado no campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Initial_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalVersion Versão da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.name Nome da especificação do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    resourceSpecification.version External_version da especificação de recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    EspecificaçãoDeServiço 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 Initial_version ou external_id da especificação de serviço. Localizado no campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalId Initial_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.name Nome da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    serviceSpecification.version External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    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.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    validFor.startDateTime Data de início da especificação.

    Formato: AAAA-MM-DD 00:00:00.

    Tipo de dados: cadeia de caracteres
    versão External_version da especificação do produto da tabela Especificação do produto [sn_prd_pm_product_specification].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo cria uma especificação de produto.

    curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--header "Content-Type: application/json" \
--data-raw '{
   "name": "SD-WAN My Device",
   "description": "This is my product specification ...",
   "internalId": "1c3c9a325bc34110235d85cced81c7d5",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "label",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router"
      }
   ]
}'
--user 'username':'password'

    Corpo da resposta.

    {
   "id": "exter123",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalId": "63c3d946745d8150f877ca57242ff918",
   "description": "This is my product specification ...",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         },
         "valid": true,
         "version": "v1",
         "internalVersion": "1",
         "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ]
}