API aberta do Catálogo de produtos

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 55 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 implementação ServiceNow® 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 do catálogo de produtos TMF620, versão 4, abril de 2021.

    Esta API está incluída na aplicação Product Catalog Advanced, que está disponível na ServiceNow Store.

    Esta API é fornecida no namespace sn_prd_pm_adv.

    O usuário que faz a 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 - GET /sn_prd_pm_adv/catalogmanagement/catalog

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

    Formato de URL

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

    Parâmetros de solicitação compatíveis

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

    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 iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta 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 3. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

    Cabeçalhos

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

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Nenhum
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Especifica o intervalo de conteúdo retornado em uma chamada paginada.

    Por exemplo, se deslocamento=2 e limite=3, o valor do cabeçalho Content-Range será 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-Contagem total Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

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

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    description Descrição do catálogo de oferta de produto.

    Tipo de dados: cadeia de caracteres
    id Sys_id do catálogo de oferta de produto da tabela Catálogo de oferta de produto [sn_prd_pm_product_offering_catalog].

    Tipo de dados: cadeia de caracteres
    nome Nome do catálogo da oferta de produto.

    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_prd_pm_adv/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_prd_pm_adv/catalogmanagement/catalog/{catalogId}

    Recupera um catálogo de oferta de produto.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/catalog/{catalogId}

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    IdCatálogo 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 8. 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 9. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

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

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 12. Códigos de status
    Código de status Descrição
    200 Solicitação processada com sucesso.
    400
    Solicitação Incorreta. Pode ser qualquer um dos seguintes motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Registro não encontrado. O registro associado ao ID não foi encontrado na tabela.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    description Descrição do catálogo de oferta de produto.

    Tipo de dados: cadeia de caracteres
    id Sys_id do catálogo de oferta de produto da tabela Catálogo de oferta de produto [sn_prd_pm_product_offering_catalog].

    Tipo de dados: cadeia de caracteres
    nome Nome do catálogo da oferta de produto.

    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_prd_pm_adv/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_prd_pm_adv/catalogmanagement/productoffering

    Recupera todas as ofertas de produto.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/productoffering

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 14. 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
    • description
    • IDexterno
    • id
    • internalId
    • internalVersion
    • últimaAtualização
    • nome
    • Característica do produto
    • productOfferingPrice
    • produtoTermo da oferta
    • 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 iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta 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 Filtre as ofertas de produto por especificação de produto sys_id. Somente as ofertas de produto com a especificação de produto especificada sys_id são retornadas na resposta. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

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

    Tipo de dados: cadeia de caracteres
    Tabela 15. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

    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
    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-Contagem total Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

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

    Parâmetros do corpo da resposta (JSON)

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

    Tipo de dados: matriz de objetos

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

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

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

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    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
    description Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    IDexterno External_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    id Inicial_versão ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId Inicial_versão 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
    nome Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    Característica do produto 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 da oferta de produto.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: objeto

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

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoValorIncluído.valor Preço da oferta de produto, incluindo impostos.

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

    Tipo de dados: cadeia de caracteres
    produtoTermo da oferta Duração de contrato válida 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 Inicial_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.internalId Inicial_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.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 produto.

    curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/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_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

    Recupera uma oferta de produto.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    ID da oferta Inicial_versão 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 20. 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
    • description
    • IDexterno
    • id
    • internalId
    • internalVersion
    • últimaAtualização
    • nome
    • Característica do produto
    • productOfferingPrice
    • produtoTermo da oferta
    • productSpecification
    • prodSpecCharValueUse
    • validFor
    • versão

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

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

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

    Tipo de dados: cadeia de caracteres
    Tabela 21. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

    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
    Tabela 23. 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 códigos de status a seguir 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 da REST API.

    Tabela 24. Códigos de status
    Código de status Descrição
    200 Solicitação processada com sucesso.
    400
    Solicitação incorreta. Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Registro não encontrado. O registro associado ao ID não 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

    "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"
  }
]
    channel.description 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
    description Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    IDexterno External_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    id Inicial_versão ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId Inicial_versão 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
    nome Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    Característica do produto 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 da oferta de produto.

    Tipo de dados: matriz

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

    Tipo de dados: objeto

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

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoValorIncluído.valor Preço da oferta de produto, incluindo impostos.

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

    Tipo de dados: cadeia de caracteres
    produtoTermo da oferta Duração de contrato válida 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 Inicial_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.internalId Inicial_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.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_prd_pm_adv/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_prd_pm_adv/catalogmanagement/productspecification

    Recupera todas as especificações do produto.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/productspecification

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    Nenhum
    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:
    • description
    • IDexterno
    • id
    • internalId
    • internalVersion
    • últimaAtualização
    • nome
    • productSpecCharacteristic
    • productSpecificationRelationship
    • resourceSpecification
    • Especificação do serviç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 iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta 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
    state Filtrar especificações de produtopor estado. Somente as especificações do produto no estado especificado são retornadas na resposta.

    Tipo de dados: cadeia de caracteres
    Tabela 27. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

    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
    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-Contagem total Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

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

    Parâmetros do corpo da resposta (JSON)

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

    Tipo de dados: cadeia de caracteres
    IDexterno 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 Inicial_versão 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 Inicial_versão 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.

    Tipo de dados: cadeia de caracteres
    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
    productSpecCharacteristic.productSpecCharacteristicValue Lista de valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
  {
    "value": "String"
  }
]
    productSpecCaracterística.productSpecCaracterísticaValor.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 Os 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
    resourceSpecification Lista de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: matriz de objetos

    "resourceSpecification": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "name": "String",
    "version": "String"
  }
]
    resourceSpecification.id Inicial_versão 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 Inicial_versão da especificação do 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 do 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 do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    Especificação do serviç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 Inicial_versão 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 Inicial_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.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 do produto.

    curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/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_prd_pm_adv/catalogmanagement/productspecification/{specificationId}

    Recupera uma especificação de produto especificada.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/productspecification/{specificationId}

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    ID da especificação Inicial_versão da especificação do produto a ser recuperada. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification].

    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:
    • description
    • IDexterno
    • id
    • internalId
    • internalVersion
    • últimaAtualização
    • nome
    • productSpecCharacteristic
    • productSpecificationRelationship
    • resourceSpecification
    • Especificação do serviço
    • validFor
    • versão

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

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

    Tipo de dados: cadeia de caracteres
    Tabela 33. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

    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
    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 códigos de status a seguir 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 da REST API.

    Tabela 36. Códigos de status
    Código de status Descrição
    200 Solicitação processada com sucesso.
    400
    Solicitação incorreta. Possíveis motivos:
    • Parâmetro de caminho inválido
    • URI inválido
    404 Registro não encontrado. O registro associado ao ID não foi encontrado na tabela.

    Parâmetros do corpo da resposta (JSON)

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

    Tipo de dados: cadeia de caracteres
    IDexterno 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 Inicial_versão 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 Inicial_versão 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.

    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
    productSpecCharacteristic.productSpecCharacteristicValue Valores possíveis da característica.

    Tipo de dados: matriz de objetos

    "productSpecCharacteristicValue": [
  {
    "value": "String"
  }
]
    productSpecCaracterística.productSpecCaracterísticaValor.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 Os 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
    resourceSpecification Lista de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: matriz de objetos

    "resourceSpecification": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "name": "String",
    "version": "String"
  }
]
    resourceSpecification.id Inicial_versão 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 Inicial_versão da especificação do 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 do 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 do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    Especificação do serviç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 Inicial_versão 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 Inicial_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.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_prd_pm_adv/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 - POST /sn_prd_pm_adv/catalogmanagement/catalog

    Cria um catálogo de oferta de produto.

    Formato de URL

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

    Parâmetros de solicitação compatíveis

    Tabela 37. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 38. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 39. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    description Descrição do catálogo de oferta de produto.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    IDexterno Identificador exclusivo para o catálogo de oferta de produto do sistema externo.

    Tipo de dados: cadeia de caracteres

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

    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 40. 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 41. 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 códigos de status a seguir 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 da REST API.

    Tabela 42. Códigos de status
    Código de status Descrição
    201 Solicitação processada com êxito.
    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
    description Descrição do catálogo de oferta de produto.

    Tipo de dados: cadeia de caracteres
    id Sys_id do catálogo de oferta de produto da tabela Catálogo de oferta de produto [sn_prd_pm_product_offering_catalog].

    Tipo de dados: cadeia de caracteres
    nome Nome do catálogo da oferta de produto.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo cria um catálogo de oferta de produto.

    curl --location --request POST "https://instance.servicenow.com/api/sn_prd_pm_adv/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_prd_pm_adv/catalogmanagement/productoffering

    Cria uma oferta de produto.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/productoffering

    Parâmetros de solicitação compatíveis

    Tabela 43. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 44. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 45. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    categoria Lista de categorias para as quais o produto pertence a.

    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

    Padrão: cadeia de caracteres em branco
    canal Obrigatório. Canais a serem usados para vender a oferta de produto.

    Tipo de dados: matriz

    "channel:" [
  {
    "description": "String",
    "id": "String",
    "name": "String"
  }
]
    channel.description 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
    description Obrigatório. Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    IDexterno Identificador exclusivo para a oferta de produto do sistema externo.

    Tipo de dados: cadeia de caracteres

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

    Tipo de dados: cadeia de caracteres
    internalId Inicial_versão 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

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

    Tipo de dados: cadeia de caracteres
    Característica do produto 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 da oferta de produto.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: objeto

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

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productOfertaPreço.preço.impostoValorIncluído.valor Preço da oferta de produto, incluindo impostos.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ProductOfertaPreço.PriceTipo Obrigatório se estiver usando o parâmetro productOfferingPrice. Tipo de preço da oferta de produto, pagamento único ou recorrente.
    Valores válidos:
    • não recorrente (único)
    • recorrente

    Tipo de dados: cadeia de caracteres
    produtoTermo da oferta Duração de contrato válida para a oferta de 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. Inicial_versão 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 Inicial_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.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

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

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

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    prodSpecCharValueUse.valueType Tipo de valor dacaracterística, como opção ou e-mail.
    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

    Padrão: cadeia de caracteres em branco
    validFor.startDateTime Data de início da oferta do produto.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    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 46. 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 47. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 48. Códigos de status
    Código de status Descrição
    201 Solicitação processada com êxito.
    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
    category.name Nome da categoria.

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

    Tipo de dados: matriz de objetos

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

    Tipo de dados: cadeia de caracteres
    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
    description Descrição da oferta de produto.

    Tipo de dados: cadeia de caracteres
    IDexterno External_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    id Inicial_versão ou external_id da oferta de produto da tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    internalId Inicial_versão 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
    nome Nome da oferta de produto.

    Tipo de dados: cadeia de caracteres
    Característica do produto 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 da oferta de produto.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: objeto

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

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    productOfertaPreço.preço.impostoValorIncluído.valor Preço da oferta de produto, incluindo impostos.

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

    Tipo de dados: cadeia de caracteres
    produtoTermo da oferta Duração de contrato válida 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 Inicial_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.internalId Inicial_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.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.
    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_prd_pm_adv/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_prd_pm_adv/catalogmanagement/productspecification

    Cria uma açãoespecífica do produto.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/productspecification

    Parâmetros de solicitação compatíveis

    Tabela 49. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 50. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 51. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    description Obrigatório. Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    IDexterno Identificador exclusivo para a especificação do produto do sistema externo.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    id Obrigatório. Inicial_versão 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 Inicial_versão 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.

    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
    productSpecCharacteristic.productSpecCharacteristicValue Obrigatório. Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    productSpecCharacteristic.validFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres

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

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

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    productSpecificationRelationship.validFor.startDateTime Data de início do relacionamento.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    resourceSpecification 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. Inicial_versão 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 Inicial_versão da especificação do 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 do 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 do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    Especificação do serviç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 Inicial_versão 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 Inicial_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.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.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    validFor.startDateTime Data de início da especificação.

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

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 54. Códigos de status
    Código de status Descrição
    201 Solicitação processada com êxito.
    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
    description Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    id Inicial_versão 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 Inicial_versão 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.

    Tipo de dados: cadeia de caracteres
    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
    productSpecCharacteristic.productSpecCharacteristicValue Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "productSpecCharacteristicValue": [
   {
      "value": "String"
   }
]
    productSpecCaracterística.productSpecCaracterísticaValor.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 O tipo de valor da característica, como opção ou e-mail.

    Tipo de dados: cadeia de caracteres
    productSpecificationRelationship Os 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
    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
    resourceSpecification Lista de especificações de recursos relacionadas a esta especificação de produto.

    Tipo de dados: matriz de objetos

    "resourceSpecification": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "name": "String",
    "version": "String"
  }
]
    resourceSpecification.id Inicial_versão 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 Inicial_versão da especificação do 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 do 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 do recurso. Localizado na tabela Especificação de recurso [sn_prd_pm_resource_specification].

    Tipo de dados: cadeia de caracteres
    Especificação do serviç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 Inicial_versão 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 Inicial_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.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 cria uma especificação de produto.

    curl --location --request POST "https://instance.service-now.com/api/sn_prd_pm_adv/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"
      }
   ]
}