Abrir API do Catálogo de produtos

. Catálogo de produtos aberto A API fornece endpoints para criar e recuperar catálogos de produtos, ofertas de produtos e especificações de produtos.

Use esta API para gerenciar informações do catálogo de produtos entre sistemas externos e o. Now Platform. . Catálogo de produtos aberto A API é um ServiceNow®Implementação da especificação REST da API de Gestão do catálogo de produtos do Fórum TM. Esta implementação é baseada em Especificação REST da API de gestão de catálogo de produtos TMF620 Versão 4 , Abril de 2021.

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

Esta API é fornecida no sn_tmf_api namespace.

O usuário solicitante 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 - EXCLUA /sn_tmf_api/catalogmanagement/productOffering/

Exclui a oferta de produto especificada.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
id	Sys_id da oferta de produto a ser excluída. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação

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

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 6. Códigos de status

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

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

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

Solicitação de curl

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

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

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

"The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"

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

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

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

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
id	Sys_id da linha da lista de preços a ser excluída. Tabela: Linha da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres

Tabela 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 10. Cabeçalhos da solicitação

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

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 12. Códigos de status

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

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

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

Solicitação de curl

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

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

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

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

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

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

Ao chamar este método DE EXCLUSÃO, uma especificação de produto pode ser excluída ou arquivada, dependendo do estado em que está:

• Uma especificação de produto no estado de rascunho foi excluída com sucesso. A resposta retorna uma mensagem de sucesso.
• Uma especificação de produto no estado arquivado não pode ser excluída. A resposta retorna uma mensagem de que a especificação já está arquivada.
• Uma especificação de produto que não está no estado de rascunho e associada a outras especificações ou ofertas de produto é arquivada, mas não excluída. A resposta retorna uma mensagem de que a especificação foi movida de um estado ativo para um estado arquivado.
• Uma especificação de produto associada a uma especificação ou oferta de produto ativa não pode ser excluída. A resposta retorna uma mensagem de erro.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
id	Sys_id da especificação do produto a ser excluída. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 16. Cabeçalhos da solicitação

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

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 18. Códigos de status

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

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

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

Solicitação de curl

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

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

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

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

API aberta do catálogo de produtos - OBTER /sn_tmf_api/catalogagement/catálogo

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

Formato de URL

URL padrão: /api/sn_tmf_api/catalogmanagement/catálogo

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 20. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos retornados.
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Tipo de dados: Número Padrão: 20 Máximo: 100
deslocamento	Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0

Tabela 21. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se deslocamento igual a 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Count	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

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

Tabela 24. Códigos de status

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

Parâmetros do corpo da resposta (json)

Nome	Descrição
descrição	Descrição do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres
id	Sys_id do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]
nome	Nome do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres

Solicitação de curl

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

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

Corpo da resposta.

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

API aberta do catálogo de produtos - OBTER /sn_tmf_api/catalogagement/catalog/

Recupera um catálogo de ofertas de produtos.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
id	SYS_id do catálogo de ofertas de produtos a ser recuperado. Tipo de dados: Cadeia de caracteres Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]

Tabela 26. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos.

Tabela 27. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Códigos de status

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

Tabela 30. Códigos de status

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

Parâmetros do corpo da resposta (json)

Nome	Descrição
descrição	Descrição do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres
id	Sys_id do catálogo de ofertas de produtos . Tipo de dados: Cadeia de caracteres Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]
nome	Nome do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres

Solicitação de curl

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

curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog/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 - OBTER /sn_tmf_api/catalogmanagement/productOffering

Recupera todas as ofertas de produtos.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 32. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: categoria canal descrição externalId id internalId InternalVersion Atualização mais recente nome ProdutoCaracterística ProductOfferingPrice Term. De oferta de produtoOferta ProductSpecification ProdSpecCharValueUse ValidFor versão Tipo de dados: Cadeia de caracteres Padrão: Todos os campos são retornados.
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Tipo de dados: Número Padrão: 20 Máximo: 100
deslocamento	Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0
especificação	Filtrar ofertas de produto por sys_id de especificação de produto. Somente ofertas de produto com o sys_id de especificação de produto especificado são retornadas na resposta. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
estado	Filtre ofertas de produtos por estado. Somente ofertas de produto no estado especificado são retornadas na resposta. Valores válidos: arquivado rascunho publicado descontinuado Tipo de dados: Cadeia de caracteres

Tabela 33. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se deslocamento igual a 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Count	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

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

Tabela 36. Códigos de status

Código de status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na resposta (com paginação).
400	Solicitação incorreta. Motivos possíveis: 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" } ]
categoria.id	ID da categoria. Tipo de dados: Cadeia de caracteres
category.name	Nome da categoria. Tipo de dados: Cadeia de caracteres
canal	Canais a serem usados para vender a oferta de produto. Tipo de dados: Matriz de objetos "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Descrição do canal. Tipo de dados: Cadeia de caracteres
channel.id	Sys_id do canal. Tipo de dados: Cadeia de caracteres Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]
channel.name	Nome do canal. Tipo de dados: Cadeia de caracteres
descrição	Descrição da oferta de produto. Tipo de dados: Cadeia de caracteres
externalId	ID externo da oferta de produto Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Necessário. Versão inicial ou ID externo da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
internalId	Versão inicial da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
InternalVersion	Versão da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
Atualização mais recente	Data em que a oferta de produto foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
LifeycleStatus	Status do ciclo de vida atual da oferta de produto. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística	Lista de características do produto. Tipo de dados: Matriz de objetos "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdutoCaracterí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" } ]
ProductOfferingPrice.price	Informações de preço da oferta de produto. Tipo de dados: Objeto "price": { "taxIncludedAmount": {Object} }
ProductOfferingPrice.price.taxIncludedAmount	Informações de preço da oferta de produto. Tipo de dados: Objeto "taxIncludedAmount": { "unit": "String", "value": "String" }
ProductOfferingPrice.price.taxIncludedAmount.unit	Código da moeda do preço de oferta do produto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.price.taxIncludedAmount.Value	Preço da oferta de produto, incluindo imposto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.PriceType	Tipo de preço de oferta de produto, pagamento único ou recorrente. Valores válidos: Não recorrente (único) recorrente Tipo de dados: Cadeia de caracteres
Term. De oferta de produtoOferta	Duração válida do prazo do contrato para a oferta de produto. Tipo de dados: Cadeia de caracteres
ProductSpecification	Especificação do produto. Tipo de dados: Objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalId	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProdSpecCharValueUse	Caraterí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 de produto. Tipo de dados: Cadeia de caracteres
StartDateTime	Data de início da oferta de produto. Tipo de dados: Cadeia de caracteres
versão	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

Solicitação de curl

Este exemplo recupera todas as ofertas de produto.

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

Corpo da resposta:

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

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

Recupera uma oferta de produto.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 37. Parâmetros de caminho

Nome	Descrição
id	Versão inicial da oferta de produto a ser recuperada. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].

Tabela 38. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: categoria canal descrição externalId id internalId InternalVersion Atualização mais recente nome ProdutoCaracterística ProductOfferingPrice Term. De oferta de produtoOferta ProductSpecification ProdSpecCharValueUse ValidFor versão Tipo de dados: Cadeia de caracteres Padrão: Todos os campos são retornados.
especificação	Filtrar ofertas de produto por sys_id de especificação de produto. Somente ofertas de produto com o sys_id de especificação de produto especificado são retornadas na resposta. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
estado	Filtre ofertas de produtos por estado. Somente ofertas de produto no estado especificado são retornadas na resposta. Valores válidos: arquivado rascunho publicado descontinuado Tipo de dados: Cadeia de caracteres

Tabela 39. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 40. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 41. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 42. Códigos de status

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

Parâmetros do corpo da resposta (json)

Nome	Descrição
categoria	Lista de categorias às quais o produto pertence. Tipo de dados: Matriz de objetos "category:" [ { "id": "String", "name": "String" } ]
categoria.id	ID da categoria. Tipo de dados: Cadeia de caracteres
category.name	Nome da categoria. Tipo de dados: Cadeia de caracteres
canal	Canais a serem usados para vender a oferta de produto. Tipo de dados: Matriz de objetos "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Descrição do canal. Tipo de dados: Cadeia de caracteres
channel.id	Sys_id do canal. Tipo de dados: Cadeia de caracteres Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]
channel.name	Nome do canal. Tipo de dados: Cadeia de caracteres
descrição	Descrição da oferta de produto. Tipo de dados: Cadeia de caracteres
externalId	ID externo da oferta de produto Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Necessário. Versão inicial ou ID externo da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
internalId	Versão inicial da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
InternalVersion	Versão da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
Atualização mais recente	Data em que a oferta de produto foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
LifeycleStatus	Indica o status do ciclo de vida atual da oferta de produto. Valores aceitos: Ativo Inativo Rascunho Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística	Lista de características do produto. Tipo de dados: Matriz de objetos "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdutoCaracterí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" } ]
ProductOfferingPrice.price	Informações de preço da oferta de produto. Tipo de dados: Objeto "price": { "taxIncludedAmount": {Object} }
ProductOfferingPrice.price.taxIncludedAmount	Informações de preço da oferta de produto. Tipo de dados: Objeto "taxIncludedAmount": { "unit": "String", "value": "String" }
ProductOfferingPrice.price.taxIncludedAmount.unit	Código da moeda do preço de oferta do produto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.price.taxIncludedAmount.Value	Preço da oferta de produto, incluindo imposto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.PriceType	Identifica se o preço da oferta do produto é um pagamento único ou recorrente. Valores válidos: Não recorrente recorrente Tipo de dados: Cadeia de caracteres
Term. De oferta de produtoOferta	Duração válida do prazo do contrato para a oferta de produto. Tipo de dados: Cadeia de caracteres
ProductSpecification	Especificação do produto. Tipo de dados: Objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalId	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProdSpecCharValueUse	Característica de oferta de produto. Tipo de dados: Matriz de objetos "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Lista dos valores possíveis da característica. Tipo de dados: Matriz de objetos "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valor da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProdSpecCharValueUse.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Intervalo de datas para o qual a oferta de produto é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data de término da oferta de produto. Tipo de dados: Cadeia de caracteres
StartDateTime	Data de início da oferta de produto. Tipo de dados: Cadeia de caracteres
versão	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

Solicitação de curl

Este exemplo recupera uma oferta de produto.

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

Corpo da resposta:

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

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

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

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 43. Parâmetros de caminho

Nome	Descrição
nenhum

Tabela 44. Parâmetros de consulta

Nome	Descrição
Atualização mais recente	Filtre os resultados pela data em que a linha de preço foi atualizada pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
nome	Filtrar linhas da lista de preços que pertencem ao nome de uma determinada lista de preços. Tabela: Listas de preços [sn_csm_pricing_price_list] Tipo de dados: Cadeia de caracteres
valor.preço	Filtre os resultados por um valor de preço de lista específico. Tipo de dados: Cadeia de caracteres
priceList.id	Filtre os resultados para retornar somente uma lista de preços com um sys_id fornecido. Tabela: Listas de preços [sn_csm_pricing_price_list] Tipo de dados: Cadeia de caracteres
PriceType	Filtre os resultados pelo método de preço da oferta de produto. Valores válidos: Recorrente: Permite que as empresas cobrem valores de preço recorrentes com uma frequência especificada. One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres
ProductOffering.id	Filtre a linha da lista de preços pelo sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
unitOfMeasure.id	Filtre a linha da lista de preços por sys_id da unidade de medida. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
ValidFor.endDateTime	Filtre a linha da lista de preços por uma determinada data e hora de término. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
StartDateTime	Filtre a linha da lista de preços por uma determinada data e hora de início. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres

Tabela 45. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 46. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.

Tabela 47. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 48. Códigos de status

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

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

Nome	Descrição
.	Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice . Tipo de dados: Cadeia de caracteres
href	URL para o registro de linha da lista de preços na instância. Tipo de dados: Cadeia de caracteres
id	Sys_id da linha da lista de preços. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
IsPacote	Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos. Valores válidos: Verdadeiro: A linha da lista de preços faz parte de um pacote. Falso: A linha da lista de preços não faz parte de um pacote. Tipo de dados: Booliano
Atualização mais recente	Data e hora em que a linha da lista de preços foi atualizada pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
LifeycleStatus	Status do ciclo de vida atual da linha da lista de preços. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres
preço	Detalhes do preço de lista da linha da lista de preços. Tipo de dados: Objeto "price": { "units": "String", "value": "String" }
preço.unidades	Código da moeda do preço. Por exemplo, USD ou EUR . Tabela: Moeda [fx_currency] Tipo de dados: Cadeia de caracteres
valor.preço	Valor do preço. Tipo de dados: Cadeia de caracteres (representada com um número)
priceList	Informações da lista de preços associadas à linha da lista de preços. Tipo de dados: Objeto "priceList": { "id": "String", "name": "String", "@type": "String" }
ID.de lista de preços	Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list]. Tipo de dados: Cadeia de caracteres
priceList.name	Nome da lista de preços. Tipo de dados: Cadeia de caracteres
Lista de preços. No tipo	O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços . Tipo de dados: Cadeia de caracteres
PriceType	O método de preço da oferta de produto associado a esta linha da lista de preços. Valores possíveis: Recorrente: Cobrar valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança. One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres
productOffering	Oferta de produto associada à linha da lista de preços. Tipo de dados: Objeto "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
ProductOffering.id	Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.internalVersion	Número da versão interna da oferta de produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
RecurringChargePeriodType	A periodicidade ou frequência da oferta de produto associada a esta linha da lista de preços. Retorna um tipo de frequência se priceTypefoi definido como recorrente , caso contrário, retorna uma cadeia de caracteres vazia. Valores possíveis: anualmente mensal Tipo de dados: Cadeia de caracteres
UnitDeMedida	Detalhes sobre a unidade de medida associada à linha da lista de preços. Tipo de dados: Objeto "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
Valor.unitDeMeasure	Valor da unidade de medida. Tipo de dados: Número
UnitOfMeasure.id	Sys_id da unidade de medida. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
UnitDeMeasure.Unidades	Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote . Tipo de dados: Cadeia de caracteres
ValidFor	A duração da validade da linha da lista de preços. Tipo de dados: Objeto "validFor": { "endDate": "String", "startDate": "String" }
ValidFor.endDate	Data e hora de término para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
ValidFor.startDate	Data e hora de início para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)

Solicitação de curl

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

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

Corpo da resposta.

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

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

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

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 49. Parâmetros de caminho

Nome	Descrição
id	Necessário. Sys_id da linha da lista de preços a ser recuperada. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres

Tabela 50. Parâmetros de consulta

Nome	Descrição
Atualização mais recente	Filtre os resultados pela data em que a linha de preço foi atualizada pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
nome	Filtrar linhas da lista de preços que pertencem ao nome de uma determinada lista de preços. Tabela: Listas de preços [sn_csm_pricing_price_list] Tipo de dados: Cadeia de caracteres
valor.preço	Filtre os resultados por um valor de preço de lista específico. Tipo de dados: Cadeia de caracteres
priceList.id	Filtre os resultados para retornar somente uma lista de preços com um sys_id fornecido. Tabela: Listas de preços [sn_csm_pricing_price_list] Tipo de dados: Cadeia de caracteres
PriceType	Filtre os resultados pelo método de preço da oferta de produto. Valores válidos: Recorrente: Permite que as empresas cobrem valores de preço recorrentes com uma frequência especificada. One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres
ProductOffering.id	Filtre a linha da lista de preços pelo sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
unitOfMeasure.id	Filtre a linha da lista de preços por sys_id da unidade de medida. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
ValidFor.endDateTime	Filtre a linha da lista de preços por uma determinada data e hora de término. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
StartDateTime	Filtre a linha da lista de preços por uma determinada data e hora de início. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres

Tabela 51. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 52. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.

Tabela 53. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 54. Códigos de status

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

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

Nome	Descrição
.	Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice . Tipo de dados: Cadeia de caracteres
href	URL para o registro de linha da lista de preços na instância. Tipo de dados: Cadeia de caracteres
id	Sys_id da linha da lista de preços. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
IsPacote	Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos. Valores válidos: Verdadeiro: A linha da lista de preços faz parte de um pacote. Falso: A linha da lista de preços não faz parte de um pacote. Tipo de dados: Booliano
Atualização mais recente	Data e hora em que a linha da lista de preços foi atualizada pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
LifeycleStatus	Status do ciclo de vida atual da linha da lista de preços. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres
preço	Detalhes do preço de lista da linha da lista de preços. Tipo de dados: Objeto "price": { "units": "String", "value": "String" }
preço.unidades	Código da moeda do preço. Por exemplo, USD ou EUR . Tabela: Moeda [fx_currency] Tipo de dados: Cadeia de caracteres
valor.preço	Valor do preço. Tipo de dados: Cadeia de caracteres (representada com um número)
priceList	Informações da lista de preços associadas à linha da lista de preços. Tipo de dados: Objeto "priceList": { "id": "String", "name": "String", "@type": "String" }
ID.de lista de preços	Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list]. Tipo de dados: Cadeia de caracteres
priceList.name	Nome da lista de preços. Tipo de dados: Cadeia de caracteres
Lista de preços. No tipo	O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços . Tipo de dados: Cadeia de caracteres
PriceType	O método de preço da oferta de produto associado a esta linha da lista de preços. Valores possíveis: Recorrente: Cobrar valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança. One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres
productOffering	Oferta de produto associada à linha da lista de preços. Tipo de dados: Objeto "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
ProductOffering.id	Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.internalVersion	Número da versão interna da oferta de produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
RecurringChargePeriodType	A periodicidade ou frequência da oferta de produto associada a esta linha da lista de preços. Retorna um tipo de frequência se priceTypefoi definido como recorrente , caso contrário, retorna uma cadeia de caracteres vazia. Valores possíveis: anualmente mensal Tipo de dados: Cadeia de caracteres
UnitDeMedida	Detalhes sobre a unidade de medida associada à linha da lista de preços. Tipo de dados: Objeto "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
Valor.unitDeMeasure	Valor da unidade de medida. Tipo de dados: Número
UnitOfMeasure.id	Sys_id da unidade de medida. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
UnitDeMeasure.Unidades	Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote . Tipo de dados: Cadeia de caracteres
ValidFor	A duração da validade da linha da lista de preços. Tipo de dados: Objeto "validFor": { "endDate": "String", "startDate": "String" }
ValidFor.endDate	Data e hora de término para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
ValidFor.startDate	Data e hora de início para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)

Solicitação de curl

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

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

Resposta.

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

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

Recupera todas as especificações do produto.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 55. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 56. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: descrição externalId id internalId InternalVersion Atualização mais recente nome ProdutoCaracterística específica ProductSpecificationRelationship ResourceSpecification Especificação de serviço ValidFor versão Tipo de dados: Cadeia de caracteres Padrão: Todos os campos são retornados.
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Tipo de dados: Número Padrão: 20 Máximo: 100
deslocamento	Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0
estado	Filtre as especificações do produto por estado. Somente as especificações do produto no estado especificado são retornadas na resposta. Valores aceitos: arquivado rascunho publicado descontinuado Tipo de dados: Cadeia de caracteres

Tabela 57. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 58. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 59. Cabeçalhos de resposta

Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se deslocamento igual a 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Count	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

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

Tabela 60. Códigos de status

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

Parâmetros do corpo da resposta (json)

Nome	Descrição
descrição	Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	Necessário. ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Versão inicial ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
internalId	Necessário. Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].
InternalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação do produto [sn_prd_pm_product_specification].
IsPacote	Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos. Valores válidos: Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos. Falso: A especificação do produto contém um único produto. Tipo de dados: Booliano Padrão: falso
Atualização mais recente	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
LifeycleStatus	Status do ciclo de vida atual da especificação do produto. Valores aceitos: Ativo Inativo Rascunho Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Nome da especificação. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística específica	Característica de especificação. Tipo de dados: Matriz de objetos "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	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" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	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.valorType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship	As relações desta especificação com outras especificações de produto. Tipo de dados: Matriz de objetos "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
productSpecificationRelationship.id	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	Versão inicial ou ID externo da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Versão inicial da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: Especificação de recurso [sn_prd_pm_resource_specification]
ResourceSpecification.version	Versão externa da especificação de recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
Especificação de 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	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Versão da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
ServiceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
ValidFor	Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres
StartDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres
versão	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

Solicitação de curl

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

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

Corpo da resposta:

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

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

Recupera uma especificação de produto especificada.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 61. Parâmetros de caminho

Nome	Descrição
SpecificationId	A initial_version da especificação do produto a ser recuperada. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]

Tabela 62. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: descrição externalId id internalId InternalVersion Atualização mais recente nome ProdutoCaracterística específica ProductSpecificationRelationship ResourceSpecification Especificação de serviço ValidFor versão Tipo de dados: Cadeia de caracteres Padrão: Todos os campos são retornados.
estado	Filtre as especificações do produto por estado. Somente as especificações do produto no estado especificado são retornadas na resposta. Valores aceitos: arquivado rascunho publicado descontinuado Tipo de dados: Cadeia de caracteres

Tabela 63. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 64. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 65. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Códigos de status

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

Tabela 66. Códigos de status

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

Parâmetros do corpo da resposta (json)

Nome	Descrição
descrição	Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	Necessário. ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Versão inicial ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
internalId	Necessário. Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].
InternalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação do produto [sn_prd_pm_product_specification].
IsPacote	Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos. Valores válidos: Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos. Falso: A especificação do produto contém um único produto. Tipo de dados: Booliano Padrão: falso
Atualização mais recente	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
LifeycleStatus	Status do ciclo de vida atual da especificação do produto. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Nome da especificação. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística específica	Caraterísticas da especificação. Tipo de dados: Matriz de objetos "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	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" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	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.valorType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship	As relações desta especificação com outras especificações de produto. Tipo de dados: Matriz de objetos "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
productSpecificationRelationship.id	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	Versão inicial ou ID externo da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Versão inicial da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: Especificação de recurso [sn_prd_pm_resource_specification]
ResourceSpecification.version	Versão externa da especificação de recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
Especificação de 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	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Versão da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
ServiceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
ValidFor	Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres
StartDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres
versão	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

Solicitação de curl

Este exemplo recupera uma especificação de produto.

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

Corpo da resposta:

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

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

Atualiza a oferta de produto especificada.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 67. Parâmetros de caminho

Nome	Descrição
id	Sys_id da oferta de produto a ser atualizada. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]

Tabela 68. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 69. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
categoria	Lista de categorias às quais o produto pertence. Tipo de dados: Matriz de objetos "category:" [ { "id": "String", "name": "String" } ] Tabela: Categoria [sc_category]
categoria.id	Necessário se estiver usando o. categoryparâmetro. ID da categoria. Tipo de dados: Cadeia de caracteres Tabela: Categoria [sc_category]
category.name	Nome da categoria. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
canal	Necessário. Canais a serem usados para vender a oferta de produto. Tipo de dados: Matriz de objetos "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Descrição do canal. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
channel.id	Necessário. Sys_id do canal. Tipo de dados: Cadeia de caracteres Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]
channel.name	Nome do canal. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
descrição	Necessário. Descrição da oferta de produto. Tipo de dados: Cadeia de caracteres
externalId	ID externo da oferta de produto Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
id	Necessário. Versão inicial ou ID externo da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
internalId	Versão inicial da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
InternalVersion	Versão da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
Atualização mais recente	Data em que a oferta de produto foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00 Padrão: Cadeia de caracteres em branco
nome	Necessário. Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística	Lista de características do produto. Tipo de dados: Matriz de objetos "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
ProdutoCaracterí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" } ]
ProductOfferingPrice.price	Informações de preço da oferta de produto. Tipo de dados: Objeto "price": { "taxIncludedAmount": {Object} }
ProductOfferingPrice.price.taxIncludedAmount	Informações de preço da oferta de produto. Tipo de dados: Objeto "taxIncludedAmount": { "unit": "String", "value": "String" }
ProductOfferingPrice.price.taxIncludedAmount.unit	Código da moeda do preço de oferta do produto. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
ProductOfferingPrice.price.taxIncludedAmount.Value	Preço da oferta de produto, incluindo imposto. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
ProductOfferingPrice.PriceType	Tipo de tipo de oferta de produto. Necessário se estiver usando o. productOfferingPriceparâmetro. Valores válidos: Não recorrente (único) recorrente Tipo de dados: Cadeia de caracteres
Term. De oferta de produtoOferta	Duração válida do termo do contrato para a oferta de produto. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
ProductSpecification	Necessário. Especificação do produto. Tipo de dados: Objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Necessário. Initial_version ou external_id da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]
productSpecification.internalId	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProdSpecCharValueUse	Caraterí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 de valores possíveis da característica. Tipo de dados: Matriz de objetos "productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valor da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Data e hora em que a característica é válida. Tipo de dados: Objeto "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Data e hora de início de quando a característica é válida. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
prodSpecCharValueUse.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.name	Necessário. Nome da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProdSpecCharValueUse.validFor.endDateTime	Data e hora de término da característica. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
ProdSpecCharValueUse.validFor.startDateTime	Data e hora de início da característica. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
ProdSpecCharValueUse.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Necessário. Intervalo de datas para o qual a oferta de produto é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Necessário. Data e hora de término da oferta de produto. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
StartDateTime	Necessário. Data e hora de início da oferta de produto. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
versão	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

Parâmetros do corpo da resposta (json)

Cabeçalhos

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

Tabela 70. Cabeçalhos da solicitação

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

Tabela 71. Cabeçalhos de resposta

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

Códigos de status

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

Tabela 72. Códigos de status

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

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

Nome	Descrição
categoria	Lista de categorias às quais o produto pertence. Tipo de dados: Matriz de objetos "category:" [ { "id": "String", "name": "String" } ]
categoria.id	ID da categoria. Tipo de dados: Cadeia de caracteres
category.name	Nome da categoria. Tipo de dados: Cadeia de caracteres
canal	Canais a serem usados para vender a oferta de produto. Tipo de dados: Matriz de objetos "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Descrição do canal. Tipo de dados: Cadeia de caracteres
channel.id	Sys_id do canal. Tipo de dados: Cadeia de caracteres Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]
channel.name	Nome do canal. Tipo de dados: Cadeia de caracteres
descrição	Descrição da oferta de produto. Tipo de dados: Cadeia de caracteres
externalId	ID externo da oferta de produto Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Necessário. Versão inicial ou ID externo da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
internalId	Versão inicial da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
InternalVersion	Versão da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
Atualização mais recente	Data em que a oferta de produto foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
LiftcycleStatus	Status do ciclo de vida atual. Valores aceitos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística	Lista de características do produto. Tipo de dados: Matriz de objetos "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdutoCaracterí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" } ]
ProductOfferingPrice.price	Informações de preço da oferta de produto. Tipo de dados: Objeto "price": { "taxIncludedAmount": {Object} }
ProductOfferingPrice.price.taxIncludedAmount	Informações de preço da oferta de produto. Tipo de dados: Objeto "taxIncludedAmount": { "unit": "String", "value": "String" }
ProductOfferingPrice.price.taxIncludedAmount.unit	Código da moeda do preço de oferta do produto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.price.taxIncludedAmount.Value	Preço da oferta de produto, incluindo imposto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.PriceType	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
Term. De oferta de produtoOferta	Duração válida do prazo do contrato para a oferta de produto. Tipo de dados: Cadeia de caracteres
ProductSpecification	Especificação do produto. Tipo de dados: Objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalId	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProdSpecCharValueUse	Caraterísticas da oferta de produto. Tipo de dados: Matriz de objetos "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Lista de valores possíveis da característica. Tipo de dados: Matriz de objetos "productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valor da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Data e hora em que a característica é válida. Tipo de dados: Objeto "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Data e hora de início de quando a característica é válida. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
prodSpecCharValueUse.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProdSpecCharValueUse.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Intervalo de datas para o qual a oferta de produto é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data de término da oferta de produto. Tipo de dados: Cadeia de caracteres
StartDateTime	Data de início da oferta de produto. Tipo de dados: Cadeia de caracteres
versão	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

Solicitação de curl

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

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

Corpo da resposta:

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

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

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

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 73. Parâmetros de caminho

Nome	Descrição
id	Necessário. Sys_id da linha da lista de preços a ser recuperada. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres

Tabela 74. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 75. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
.	Necessário. Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice . Tipo de dados: Cadeia de caracteres
externalId	O ID externo da linha da lista de preços. Tipo de dados: Cadeia de caracteres
IsPacote	Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos. Valores válidos: Verdadeiro: A linha da lista de preços faz parte de um pacote. Falso: A linha da lista de preços não faz parte de um pacote. Tipo de dados: Booliano Padrão: falso
Atualização mais recente	Necessário. Data em que a linha de preço foi atualizada pela última vez. FORMATO: AAAA-MM-DD Tipo de dados: Cadeia de caracteres
LifeCycleStatus	Necessário. Status do ciclo de vida atual da linha da lista de produtos. Valores válidos: ativo rascunho inativo Tipo de dados: Cadeia de caracteres Padrão: Rascunho
nome	Necessário. Nome para fornecer a linha da lista de preços. Tipo de dados: Cadeia de caracteres
preço	Necessário. Detalhes do preço de lista da linha da lista de preços. Tipo de dados: Objeto "price": { "unit": "String", "value": "String" }
preço.unidade	Necessário. Código da moeda da linha da lista de preços. Por exemplo, USD ou EUR . Tabela: Tabela de moeda [fx_currency]. Tipo de dados: Cadeia de caracteres
valor.preço	Necessário. Valor do preço. Tipo de dados: Cadeia de caracteres (representado por um número. Por exemplo, "800" .)
priceList	Necessário. Informações da lista de preços associadas à linha da lista de preços. Tipo de dados: Objeto "priceList": { "id": "String", "name": "String", "@type": "String" }
ID.de lista de preços	Necessário. Sys_id da linha da lista de preços. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
priceList.name	Nome da linha da lista de preços. Tipo de dados: Cadeia de caracteres
Lista de preços. No tipo	O tipo de linha da lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. O valor é sempre Lista de preços . Tipo de dados: Cadeia de caracteres
PriceType	Necessário. Filtre a linha da lista de preços pelo método de preço da oferta de produto. Valores válidos: Recorrente: Cobrar valores de preço recorrentes com uma frequência especificada. A frequência é definida no recurringChargePeriodTypeparâmetro. One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres Padrão: Recorrente
productOffering	Necessário. Oferta de produto da linha da lista de preços. Tipo de dados: Objeto "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
ProductOffering.id	Necessário. Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
productOffering.internalVersion	Número da versão interna da oferta de produto. Tipo de dados: Cadeia de caracteres (representado por um número. Por exemplo, "1" .)
productOffering.name	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
RecurringChargePeriodType	Necessário se priceTypeé recorrente. Termos de compromisso que são selecionados quando a oferta de produto foi criada. Valores válidos: anualmente mensal Tipo de dados: Cadeia de caracteres
UnitDeMedida	Necessário. Detalhes sobre a unidade de medida associada à linha da lista de preços. Tipo de dados: Objeto "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
Valor.unitDeMeasure	Valor da unidade de medida. Tipo de dados: Número
UnitOfMeasure.id	Necessário. Sys_id da unidade de medida na tabela Lista de linhas de preço. Tabela: Linha da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
UnitDeMeasure.Unidades	Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, cada ou pacote . Tipo de dados: Cadeia de caracteres
ValidFor	Necessário. A duração da validade da linha da lista de preços. Tipo de dados: Objeto "validFor": { "endDate": "String", "startDate": "String" }
ValidFor.endDate	Data de término para a qual a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
ValidFor.endDateTime	Data e hora de término para as quais a linha da lista de preços é válida. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres (glide_date)
ValidFor.startDate	Data de início para a qual a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
StartDateTime	Data e hora de início para as quais a linha da lista de preços é válida. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres (glide_date)

Cabeçalhos

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

Tabela 76. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.

Tabela 77. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 78. Códigos de status

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

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

Nome	Descrição
id	Sys_id da linha da lista de preços. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
href	URL para o registro de linha da lista de preços na instância. Tipo de dados: Cadeia de caracteres
Atualização mais recente	Data e hora em que a linha da lista de preços foi atualizada pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
ValidFor	A duração da validade da linha da lista de preços. Tipo de dados: Objeto "validFor": { "endDate": "String", "startDate": "String" }
ValidFor.endDate	Data e hora de término para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
ValidFor.startDate	Data e hora de início para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
IsPacote	Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos. Valores válidos: Verdadeiro: A linha da lista de preços faz parte de um pacote. Falso: A linha da lista de preços não faz parte de um pacote. Tipo de dados: Booliano
LifeycleStatus	Status do ciclo de vida atual da linha da lista de preços. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres
productOffering	Oferta de produto associada à linha da lista de preços. Tipo de dados: Objeto "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
ProductOffering.id	Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.internalVersion	Número da versão interna da oferta de produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
PriceType	O método de preço da oferta de produto associado a esta linha da lista de preços. Valores possíveis: Recorrente: Cobrar valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança. One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres
RecurringChargePeriodType	A periodicidade ou frequência da oferta de produto associada a esta linha da lista de preços. Retorna um tipo de frequência se priceTypefoi definido como recorrente , caso contrário, retorna uma cadeia de caracteres vazia. Valores possíveis: anualmente mensal Tipo de dados: Cadeia de caracteres
UnitDeMedida	Detalhes sobre a unidade de medida associada à linha da lista de preços. Tipo de dados: Objeto "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
Valor.unitDeMeasure	Valor da unidade de medida. Tipo de dados: Número
UnitOfMeasure.id	Sys_id da unidade de medida. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
UnitDeMeasure.Unidades	Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote . Tipo de dados: Cadeia de caracteres
preço	Detalhes do preço de lista da linha da lista de preços. Tipo de dados: Objeto "price": { "units": "String", "value": "String" }
preço.unidades	Código da moeda do preço. Por exemplo, USD ou EUR . Tabela: Moeda [fx_currency] Tipo de dados: Cadeia de caracteres
valor.preço	Valor do preço. Tipo de dados: Cadeia de caracteres (representada com um número)
priceList	Informações da lista de preços associadas à linha da lista de preços. Tipo de dados: Objeto "priceList": { "id": "String", "name": "String", "@type": "String" }
ID.de lista de preços	Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list]. Tipo de dados: Cadeia de caracteres
priceList.name	Nome da lista de preços. Tipo de dados: Cadeia de caracteres
Lista de preços. No tipo	O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços . Tipo de dados: Cadeia de caracteres
.	Sempre um valor de ProductOfferingPrice . Ao subclassificar, isso define o nome extensível da subclasse. Tipo de dados: Cadeia de caracteres
estado	O estado da lista de preços associada a esta linha da lista de preços. Tipo de dados: Cadeia de caracteres
externalId	O ID externo desta linha da lista de preços. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir atualiza as datas de quando o preço de oferta do produto com ID 3ddd0... é válido para.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request patch\
--user 'username':'password'
--data {
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  }
}

Corpo da resposta:

{
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  },
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "name": "new Price list",
  "lastUpdate": "2025-01-16 00:15:32",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c",
  "lifecycleStatus": "Draft"
}

API aberta do catálogo de produtos - PATCH /sn_tmf_api/catalogmanagement/productSpecification/

Atualiza a especificação do produto especificado.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 79. Parâmetros de caminho

Nome	Descrição
id	Sys_id da oferta de produto a ser atualizada. Tipo de dados: Cadeia de caracteres Tabela: Especificação do produto [sn_prd_pm_product_specification]

Tabela 80. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 81. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
descrição	Necessário. Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	Necessário. ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
id	Versão inicial ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
internalId	Necessário. Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].
InternalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação do produto [sn_prd_pm_product_specification].
IsPacote	Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos. Valores válidos: Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos. Falso: A especificação do produto contém um único produto. Tipo de dados: Booliano Padrão: falso
Atualização mais recente	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	Necessário. Nome da especificação. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística específica	Característica de especificação. Tipo de dados: Matriz de objetos "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
productSpecCharacteristic.name	Necessário. Nome da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.productSpecCharacteristicValue	Lista de valores possíveis da característica. Tipo de dados: Matriz de objetos "productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valor da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Data e hora em que a característica é válida. Tipo de dados: Objeto "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Data e hora de início de quando a característica é válida. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
ProductSpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProductSpecCharacteristic.validFor.endDateTime	Data e hora de término da característica. FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Tipo de dados: Cadeia de caracteres
ProductSpecCharacteristic.validFor.startDateTime	Data e hora de início da característica. FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Tipo de dados: Cadeia de caracteres
ProductSpecCharacteristic.valorType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship	Detalhes das relações da especificação com outras especificações do produto. Tipo de dados: Matriz de objetos "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
productSpecificationRelationship.id	ID da especificação relacionada. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.type	Necessário se estiver usando o. productSpecificationRelationshipparâmetro. Tipo de relacionamento. Valores válidos: pacotes composto_de Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.validFor	Intervalo de datas para o qual o relacionamento é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProductSpecificationRelationship.validFor.endDateTime	Data de término do relacionamento. FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.validFor.startDateTime	Data de início do relacionamento. FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Tipo de dados: Cadeia de caracteres
ResourceSpecification	Necessário. Detalhes das especificações de recursos relacionadas a esta especificação de produto. Tipo de dados: Matriz de objetos "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Necessário. Versão inicial ou ID externo da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Versão inicial da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: Especificação de recurso [sn_prd_pm_resource_specification]
ResourceSpecification.version	Versão externa da especificação de recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
Especificação de 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	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Versão da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
ServiceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
ValidFor	Necessário. Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data e hora de término da especificação. FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Tipo de dados: Cadeia de caracteres
StartDateTime	Data e hora de início da especificação. FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Tipo de dados: Cadeia de caracteres
versão	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

Cabeçalhos

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

Tabela 82. Cabeçalhos da solicitação

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

Tabela 83. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 84. Códigos de status

Código de status	Descrição
200	Solicitação processada com sucesso.
400	Solicitação incorreta. Motivos possíveis: Carga vazia. Carga inválida. Campo obrigatório ausente: <field name>
404	Não encontrado. O item solicitado não foi encontrado.

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

Nome	Descrição
descrição	Descrição da especificação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres
id	Versão inicial ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
internalId	Necessário. Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].
InternalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação do produto [sn_prd_pm_product_specification].
Atualização mais recente	Data em que a especificação foi atualizada pela última vez. FORMATO: AAAA-MM-DD 00:00:00. Tipo de dados: Cadeia de caracteres
nome	Nome da especificação. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística específica	Caraterísticas da especificação. Tipo de dados: Matriz de objetos "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
productSpecCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.productSpecCharacteristicValue	Lista de valores possíveis da característica. Tipo de dados: Matriz de objetos "productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valor da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Data e hora em que a característica é válida. Tipo de dados: Objeto "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Data e hora de início de quando a característica é válida. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00
ProductSpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProductSpecCharacteristic.validFor.endDateTime	Data e hora de término da característica. FORMATO: AAAA-MM-DD 00:00:00. Tipo de dados: Cadeia de caracteres
ProductSpecCharacteristic.validFor.startDateTime	Data e hora de início da característica. FORMATO: AAAA-MM-DD 00:00:00. Tipo de dados: Cadeia de caracteres
ProductSpecCharacteristic.valorType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship	As relações desta especificação com outras especificações de produto. Tipo de dados: Matriz de objetos "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
ProductSpecificationRelationship.id	Sys_id da especificação relacionada. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.type	Tipo de relacionamento. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.validFor	Intervalo de datas para o qual o relacionamento é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProductSpecificationRelationship.validFor.endDateTime	Data de término e tipo do relacionamento. FORMATO: AAAA-MM-DD 00:00:00. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.validFor.startDateTime	Data de início e tipo do relacionamento. FORMATO: AAAA-MM-DD 00:00:00. 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	Versão inicial ou ID externo da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Versão inicial da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: Especificação de recurso [sn_prd_pm_resource_specification]
ResourceSpecification.version	Versão externa da especificação de recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
Especificação de 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	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Versão da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
ServiceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
ValidFor	Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data e hora de término da especificação. FORMATO: AAAA-MM-DD 00:00:00. Tipo de dados: Cadeia de caracteres
StartDateTime	Data e hora de início da especificação. FORMATO: AAAA-MM-DD 00:00:00. Tipo de dados: Cadeia de caracteres
versão	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

Solicitação de curl

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

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "id": "1001",
  "name": "SD-WAN 0322 test",
  "description": "This is my product specification ...",
  "validFor": {
    "startDateTime": "2017-06-19T00:00",
    "endDateTime": "2018-01-13T00:00"
  },
  "productSpecCharacteristic": [
    {
      "name": "New characteristic",
      "description": "This product has new spec characteristic.",
      "valueType": "label",
      "validFor": {
        "startDateTime": "2017-06-20T00:00"
      }
    }
  ],
  "serviceSpecification": [
    {
      "id": "e23ae2d01bb420106ba59acf034bcb56",
      "name": "IP Sec Tunnel",
      "internalVersion": "2"
    }
  ],
  "productSpecificationRelationship": [
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "internalVersion": "2",
      "type": "bundles",
      "validFor": {
        "startDateTime": "2017-06-16T00:00"
      }
    }
  ],
  "resourceSpecification": [
    {
      "id": "493fa60b536520103b6bddeeff7b12b6",
      "name": "Customer Premise SD-WAN Router"
    }
  ],
  "@type": "ProductSpecification"
}

Corpo da resposta:

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

API aberta do catálogo de produtos - POST /sn_tmf_api/catalogagement/catalog

Cria um catálogo de ofertas de produtos.

Formato de URL

URL padrão: /api/sn_tmf_api/catalogmanagement/catálogo

Parâmetros de solicitação compatíveis

Tabela 85. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 86. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 87. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
descrição	Descrição do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
externalId	Identificador exclusivo do catálogo de ofertas de produtos do sistema externo. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Necessário. Nome do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres

Cabeçalhos

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

Tabela 88. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 89. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 90. Códigos de status

Código de status	Descrição
201	Solicitação processada com sucesso.
400	Solicitação Incorreta. Pode ser um dos seguintes motivos: Carga vazia. Carga inválida. Campo obrigatório ausente: <field name>

Parâmetros do corpo da resposta (json)

Nome	Descrição
descrição	Descrição do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres
id	Sys_id do catálogo de ofertas de produtos Tipo de dados: Cadeia de caracteres Tabela: Catálogo de ofertas de produtos [sn_prd_pm_product_offering_catalog]
nome	Nome do catálogo de ofertas de produtos. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo cria um catálogo de ofertas de produtos.

curl --location --request POST "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--header "Content-Type: application/json" \
--data-raw '{
    "id": "testId",
    "name": "Catalog",
    "description": "Description"
}'
--user 'username':'password'

Corpo da resposta:

{
   "id": "45715d02c3510110bc0526083c40dd6b",
   "description": "Description",
   "name": "Catalog1"
}

API aberta do catálogo de produtos - POST /sn_tmf_api/catalogmanagement/productOffering

Cria uma oferta de produto.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 91. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 92. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 93. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
categoria	Lista de categorias às quais o produto pertence. Tipo de dados: Matriz de objetos "category:" [ { "id": "String", "name": "String" } ] Tabela: Categoria [sc_category]
categoria.id	Necessário se estiver usando o. categoryparâmetro. ID da categoria. Tipo de dados: Cadeia de caracteres
category.name	Nome da categoria. Tipo de dados: Cadeia de caracteres
canal	Necessário. Canais a serem usados para vender a oferta de produto. Tipo de dados: Matriz de objetos "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Descrição do canal. Tipo de dados: Cadeia de caracteres
channel.id	Necessário. Sys_id do canal. Tipo de dados: Cadeia de caracteres Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]
channel.name	Nome do canal. Tipo de dados: Cadeia de caracteres
descrição	Necessário. Descrição da oferta de produto. Tipo de dados: Cadeia de caracteres
externalId	Identificador exclusivo da oferta de produto do sistema externo. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres
id	Necessário. Versão inicial ou ID externo da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: Nos campos initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
internalId	Versão inicial da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
InternalVersion	Versão da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
Atualização mais recente	Data em que a oferta de produto foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
LifeycleStatus	Status do ciclo de vida atual. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres
nome	Necessário. Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística	Lista de características do produto. Tipo de dados: Matriz de objetos "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdutoCaracterí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" } ]
ProductOfferingPrice.price	Informações de preço da oferta de produto. Tipo de dados: Objeto "price": { "taxIncludedAmount": {Object} }
ProductOfferingPrice.price.taxIncludedAmount	Informações de preço da oferta de produto. Tipo de dados: Objeto "taxIncludedAmount": { "unit": "String", "value": "String" }
ProductOfferingPrice.price.taxIncludedAmount.unit	Código da moeda para o preço de oferta do produto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.price.taxIncludedAmount.Value	Preço da oferta de produto, incluindo imposto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.PriceType	Necessário se estiver usando o. productOfferingPriceparâmetro. 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
Term. De oferta de produtoOferta	Duração válida do prazo do contrato para a oferta de produto. Tipo de dados: Cadeia de caracteres
ProductSpecification	Necessário. Especificação do produto. Tipo de dados: Objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Necessário. Versão inicial ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou externa_id da tabela Especificação do produto [sn_prd_pm_product_specification].
productSpecification.internalId	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProdSpecCharValueUse	Caraterísticas da oferta de produto. Tipo de dados: Matriz de objetos "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Necessário. Lista dos valores possíveis da característica. Tipo de dados: Matriz de objetos "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Necessário. Valor da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.name	Necessário. Nome da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProdSpecCharValueUse.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Necessá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 de produto. Tipo de dados: Cadeia de caracteres
StartDateTime	Data de início da oferta de produto. Tipo de dados: Cadeia de caracteres
versão	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

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 da REST API compatíveis .

Tabela 94. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 95. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 96. Códigos de status

Código de status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação incorreta. Motivos possíveis: 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 de objetos "category:" [ { "id": "String", "name": "String" } ]
categoria.id	ID da categoria. Tipo de dados: Cadeia de caracteres
category.name	Nome da categoria. Tipo de dados: Cadeia de caracteres
canal	Canais a serem usados para vender a oferta de produto. Tipo de dados: Matriz de objetos "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Descrição do canal. Tipo de dados: Cadeia de caracteres
channel.id	Sys_id do canal. Tipo de dados: Cadeia de caracteres Tabela: Canal de distribuição [sn_prd_pm_distribution_channel]
channel.name	Nome do canal. Tipo de dados: Cadeia de caracteres
descrição	Descrição da oferta de produto. Tipo de dados: Cadeia de caracteres
externalId	ID externo da oferta de produto Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Necessário. Versão inicial ou ID externo da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Oferta de produto [sn_prd_pm_product_offering].
internalId	Versão inicial da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
InternalVersion	Versão da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
Atualização mais recente	Data em que a oferta de produto foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
LifeycleStatus	Status do ciclo de vida atual da oferta de produto. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística	Lista de características do produto. Tipo de dados: Matriz de objetos "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdutoCaracterí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" } ]
ProductOfferingPrice.price	Informações de preço da oferta de produto. Tipo de dados: Objeto "price": { "taxIncludedAmount": {Object} }
ProductOfferingPrice.price.taxIncludedAmount	Informações de preço da oferta de produto. Tipo de dados: Objeto "taxIncludedAmount": { "unit": "String", "value": "String" }
ProductOfferingPrice.price.taxIncludedAmount.unit	Código da moeda do preço de oferta do produto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.price.taxIncludedAmount.Value	Preço da oferta de produto, incluindo imposto. Tipo de dados: Cadeia de caracteres
ProductOfferingPrice.PriceType	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
Term. De oferta de produtoOferta	Duração válida do prazo do contrato para a oferta de produto. Tipo de dados: Cadeia de caracteres
ProductSpecification	Especificação do produto. Tipo de dados: Objeto "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalId	Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Oferta de produto [sn_prd_pm_product_offering].
productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Oferta de produto [sn_prd_pm_product_offering].
ProductSpecification.version	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].
ProdSpecCharValueUse	Caraterísticas da oferta de produto. Tipo de dados: Matriz de objetos "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Lista dos valores possíveis da característica. Tipo de dados: Matriz de objetos "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valor da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
prodSpecCharValueUse.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProdSpecCharValueUse.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres
ProdSpecCharValueUse.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Intervalo de datas para o qual a oferta de produto é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data de término da oferta de produto. Tipo de dados: Cadeia de caracteres
StartDateTime	Data de início da oferta de produto. Tipo de dados: Cadeia de caracteres
versão	Versão externa da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Oferta de produto [sn_prd_pm_product_offering].

Solicitação de curl

Este exemplo cria uma oferta de produto.

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

Corpo da resposta:

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

API aberta do catálogo de produtos - POST /sn_tmf_api/catalogmanagement/productOfferingPrice

Cria um novo registro de linha de lista de preços na tabela Linha de lista de preços [sn_csm_pricing_price_list_line].

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 97. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 98. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 99. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
.	Necessário. Tipo de linha da lista de preços. Sempre um valor de ProductOfferingPrice . Tipo de dados: Cadeia de caracteres
externalId	O ID externo da linha da lista de preços. Tipo de dados: Cadeia de caracteres
IsPacote	Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos. Valores válidos: Verdadeiro: A linha da lista de preços faz parte de um pacote. Falso: A linha da lista de preços não faz parte de um pacote. Tipo de dados: Booliano Padrão: falso
Atualização mais recente	Necessário. Data em que a linha de preço foi atualizada pela última vez. FORMATO: AAAA-MM-DD Tipo de dados: Cadeia de caracteres
LifeCycleStatus	Necessário. Status do ciclo de vida atual da linha da lista de produtos. Valores válidos: ativo rascunho inativo Tipo de dados: Cadeia de caracteres Padrão: Rascunho
nome	Necessário. Nome para fornecer a linha da lista de preços. Tipo de dados: Cadeia de caracteres
preço	Necessário. Detalhes do preço de lista da linha da lista de preços. Tipo de dados: Objeto "price": { "unit": "String", "value": "String" }
preço.unidade	Necessário. Código da moeda da linha da lista de preços. Por exemplo, USD ou EUR . Tabela: Tabela de moeda [fx_currency]. Tipo de dados: Cadeia de caracteres
valor.preço	Necessário. Valor do preço. Tipo de dados: Cadeia de caracteres (representado por um número. Por exemplo, "800" .)
priceList	Necessário. Informações da lista de preços associadas à linha da lista de preços. Tipo de dados: Objeto "priceList": { "id": "String", "name": "String", "@type": "String" }
ID.de lista de preços	Necessário. Sys_id da linha da lista de preços. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
priceList.name	Nome da linha da lista de preços. Tipo de dados: Cadeia de caracteres
Lista de preços. No tipo	O tipo de linha da lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. O valor é sempre Lista de preços . Tipo de dados: Cadeia de caracteres
PriceType	Necessário. Filtre a linha da lista de preços pelo método de preço da oferta de produto. Valores válidos: Recorrente: Cobrar valores de preço recorrentes com uma frequência especificada. A frequência é definida no recurringChargePeriodTypeparâmetro. One_time: Oferece suporte a cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres Padrão: Recorrente
productOffering	Necessário. Oferta de produto da linha da lista de preços. Tipo de dados: Objeto "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
ProductOffering.id	Necessário. Sys_id da oferta de produto. Tabela: Oferta de produto [sn_prd_pm_product_offering] Tipo de dados: Cadeia de caracteres
productOffering.internalVersion	Número da versão interna da oferta de produto. Tipo de dados: Cadeia de caracteres (representado por um número. Por exemplo, "1" .)
productOffering.name	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres
RecurringChargePeriodType	Necessário se priceTypeé recorrente. Termos de compromisso que são selecionados quando a oferta de produto foi criada. Valores válidos: anualmente mensal Tipo de dados: Cadeia de caracteres
UnitDeMedida	Necessário. Detalhes sobre a unidade de medida associada à linha da lista de preços. Tipo de dados: Objeto "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
Valor.unitDeMeasure	Valor da unidade de medida. Tipo de dados: Número
UnitOfMeasure.id	Necessário. Sys_id da unidade de medida na tabela Lista de linhas de preço. Tabela: Linha da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
UnitDeMeasure.Unidades	Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, cada ou pacote . Tipo de dados: Cadeia de caracteres
ValidFor	Necessário. A duração da validade da linha da lista de preços. Tipo de dados: Objeto "validFor": { "endDate": "String", "startDate": "String" }
ValidFor.endDate	Data de término para a qual a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
ValidFor.endDateTime	Data e hora de término para as quais a linha da lista de preços é válida. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres (glide_date)
ValidFor.startDate	Data de início para a qual a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
StartDateTime	Data e hora de início para as quais a linha da lista de preços é válida. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres (glide_date)

Cabeçalhos

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

Tabela 100. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.

Tabela 101. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 102. Códigos de status

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

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

Nome	Descrição
id	Sys_id da linha da lista de preços. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
href	URL para o registro de linha da lista de preços na instância. Tipo de dados: Cadeia de caracteres
Atualização mais recente	Data e hora em que a linha da lista de preços foi atualizada pela última vez. Formato: AAAA-MM-DD HH:mm:ss Tipo de dados: Cadeia de caracteres
ValidFor	A duração da validade da linha da lista de preços. Tipo de dados: Objeto "validFor": { "endDate": "String", "startDate": "String" }
ValidFor.endDate	Data e hora de término para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
ValidFor.startDate	Data e hora de início para as quais a linha da lista de preços é válida. Tipo de dados: Cadeia de caracteres (glide_date_time)
IsPacote	Sinalizador que indica se a linha da lista de preços faz parte de um único produto ou de um pacote de produtos. Valores válidos: Verdadeiro: A linha da lista de preços faz parte de um pacote. Falso: A linha da lista de preços não faz parte de um pacote. Tipo de dados: Booliano
LifeycleStatus	Status do ciclo de vida atual da linha da lista de preços. Valores válidos: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres
productOffering	Oferta de produto associada à linha da lista de preços. Tipo de dados: Objeto "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
ProductOffering.id	Sys_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.internalVersion	Número da versão interna da oferta de produto. Por exemplo, PRDOF01024 . Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
productOffering.name	Nome da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: Cadeia de caracteres
PriceType	O método de preço da oferta de produto associado a esta linha da lista de preços. Valores possíveis: Recorrente: Cobrar valores de preço recorrentes com uma frequência especificada. O valor de recurringChargePeriodTypeindica a frequência da cobrança. One_time: Cobranças e taxas de complemento únicas ou recorrentes para uma oferta de produto. Tipo de dados: Cadeia de caracteres
RecurringChargePeriodType	A periodicidade ou frequência da oferta de produto associada a esta linha da lista de preços. Retorna um tipo de frequência se priceTypefoi definido como recorrente , caso contrário, retorna uma cadeia de caracteres vazia. Valores possíveis: anualmente mensal Tipo de dados: Cadeia de caracteres
UnitDeMedida	Detalhes sobre a unidade de medida associada à linha da lista de preços. Tipo de dados: Objeto "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
Valor.unitDeMeasure	Valor da unidade de medida. Tipo de dados: Número
UnitOfMeasure.id	Sys_id da unidade de medida. Tabela: Linhas da lista de preços [sn_csm_pricing_price_list_line] Tipo de dados: Cadeia de caracteres
UnitDeMeasure.Unidades	Tipo da unidade de medida associada à linha da lista de preços. Por exemplo, ano ou pacote . Tipo de dados: Cadeia de caracteres
preço	Detalhes do preço de lista da linha da lista de preços. Tipo de dados: Objeto "price": { "units": "String", "value": "String" }
preço.unidades	Código da moeda do preço. Por exemplo, USD ou EUR . Tabela: Moeda [fx_currency] Tipo de dados: Cadeia de caracteres
valor.preço	Valor do preço. Tipo de dados: Cadeia de caracteres (representada com um número)
priceList	Informações da lista de preços associadas à linha da lista de preços. Tipo de dados: Objeto "priceList": { "id": "String", "name": "String", "@type": "String" }
ID.de lista de preços	Sys_id da lista de preços na tabela Lista de preços [sn_csm_pricing_price_list]. Tipo de dados: Cadeia de caracteres
priceList.name	Nome da lista de preços. Tipo de dados: Cadeia de caracteres
Lista de preços. No tipo	O tipo de lista de preços. Ao subclassificar, isso define o nome extensível da subclasse. Sempre tem um valor de Lista de preços . Tipo de dados: Cadeia de caracteres
.	Sempre um valor de ProductOfferingPrice . Ao subclassificar, isso define o nome extensível da subclasse. Tipo de dados: Cadeia de caracteres
estado	O estado da lista de preços associada a esta linha da lista de preços. Tipo de dados: Cadeia de caracteres
externalId	O ID externo desta linha da lista de preços. Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir cria um novo registro de linha de lista de preços de acordo com os dados especificados no corpo da solicitação e o insere na tabela Linha da lista de preços [sn_csm_pricing_price_list_line].

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice " \
--request POST\
--user 'username':'password'
--data {
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "name": "new price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice"
}

Corpo da resposta. Este novo registro de linha de lista de preços recebe um ID exclusivo; o corpo da resposta retorna essas informações junto com um URL para o novo registro usando o. hrefparâmetro de resposta.

{
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "id": "194d5d364f8b5210f899f61d20ce0b7a",
    "name": "new Price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice",
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "state": "draft",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c"
}

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

Cria uma especificação de produto.

Formato de URL

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

Parâmetros de solicitação compatíveis

Tabela 103. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 104. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 105. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
descrição	Necessário. Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	Identificador exclusivo para a especificação do produto do sistema externo. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Necessário. Versão inicial ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: Na initial_version ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
internalId	Necessário. Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].
InternalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação do produto [sn_prd_pm_product_specification].
Atualização mais recente	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Padrão: Cadeia de caracteres em branco
nome	Necessário. Nome da especificação. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística específica	Característica de especificação. Tipo de dados: Matriz de objetos "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	Descrição da característica. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
productSpecCharacteristic.name	Necessário. Nome da característica. Tipo de dados: Cadeia de caracteres
productSpecCharacteristic.productSpecCharacteristicValue	Necessário. Valores possíveis da característica. Tipo de dados: Matriz "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	Necessário. Valor da característica. Tipo de dados: Cadeia de caracteres
ProductSpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProductSpecCharacteristic.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Padrão: Cadeia de caracteres em branco
ProductSpecCharacteristic.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Padrão: Cadeia de caracteres em branco
ProductSpecCharacteristic.valorType	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	As relações desta especificação com outras especificações de produto. Tipo de dados: Matriz "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	ID da especificação relacionada. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
ProductSpecificationRelationship.type	Necessário se estiver usando o. productSpecificationRelationshipparâmetro. Tipo de relacionamento. Valores válidos: pacotes composto_de Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.validFor	Intervalo de datas para o qual o relacionamento é válido. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProductSpecificationRelationship.validFor.endDateTime	Data de término do relacionamento. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Padrão: Cadeia de caracteres em branco
ProductSpecificationRelationship.validFor.startDateTime	Data de início do relacionamento. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Padrão: Cadeia de caracteres em branco
ResourceSpecification	Necessário. Especificações de recursos relacionadas a esta especificação de produto. Tipo de dados: Matriz de objetos "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Necessário. Versão inicial ou ID externo da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Versão inicial da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: Especificação de recurso [sn_prd_pm_resource_specification]
ResourceSpecification.version	Versão externa da especificação de recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
Especificação de 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	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Versão da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
ServiceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
ValidFor	Necessário. Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Padrão: Cadeia de caracteres em branco
StartDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00. Por exemplo, 2025-01-31 09:35:43 . Padrão: Cadeia de caracteres em branco
versão	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

Cabeçalhos

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

Tabela 106. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Suporta somente application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Suporta somente application/json.

Tabela 107. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Suporta somente application/json.

Códigos de status

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

Tabela 108. Códigos de status

Código de status	Descrição
201	Solicitação processada com sucesso.
400	Solicitação incorreta. Motivos possíveis: Carga vazia. Carga inválida. Campo obrigatório ausente: <field name>

Parâmetros do corpo da resposta (json)

Nome	Descrição
descrição	Descrição da especificação. Tipo de dados: Cadeia de caracteres
href	Link relativo para o registro de recurso. Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
id	Versão inicial ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação do produto [sn_prd_pm_product_specification].
internalId	Necessário. Versão inicial da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação do produto [sn_prd_pm_product_specification].
InternalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação do produto [sn_prd_pm_product_specification].
IsPacote	Sinalizador que indica se productSpecificationrepresenta um único produto ou um pacote de produtos. Valores válidos: Verdadeiro: A especificação do produto é um pacote de produtos e contém vários produtos. Falso: A especificação do produto contém um único produto. Tipo de dados: Booliano Padrão: falso
Atualização mais recente	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00.
LifeycleStatus	Status do ciclo de vida atual da especificação do produto. Valores possíveis: Ativo Rascunho Inativo Tipo de dados: Cadeia de caracteres Padrão: Cadeia de caracteres em branco
nome	Nome da especificação. Tipo de dados: Cadeia de caracteres
ProdutoCaracterística específica	Característica de especificação. Tipo de dados: Matriz de objetos "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	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" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	Valor da característica. Tipo de dados: Cadeia de caracteres
ProductSpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ProductSpecCharacteristic.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00.
ProductSpecCharacteristic.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00.
ProductSpecCharacteristic.valorType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship	As relações desta especificação com outras especificações de produto. Tipo de dados: Matriz de objetos "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
ProductSpecificationRelationship.id	Sys_id da especificação relacionada. Tipo de dados: Cadeia de caracteres
ProductSpecificationRelationship.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 FORMATO: AAAA-MM-DD 00:00:00.
ProductSpecificationRelationship.validFor.startDateTime	Data de início do relacionamento. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00.
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	Versão inicial ou ID externo da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Versão inicial da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de recurso [sn_prd_pm_resource_specification].
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres Tabela: Especificação de recurso [sn_prd_pm_resource_specification]
ResourceSpecification.version	Versão externa da especificação de recurso. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de recurso [sn_prd_pm_resource_specification].
Especificação de 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	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo sys_id ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalId	Versão inicial da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Versão da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo de versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
serviceSpecification.name	Nome da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]
ServiceSpecification.version	Versão externa da especificação de serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
ValidFor	Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto "validFor": { "endDateTime": "String", "startDateTime": "String" }
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00.
StartDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres FORMATO: AAAA-MM-DD 00:00:00.
versão	Versão externa da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação do produto [sn_prd_pm_product_specification].

Solicitação de curl

Este exemplo cria uma especificação de produto.

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

Corpo da resposta.

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