API em aberto do inventário de produtos

API em aberto do inventário de produtos - GET /sn_prd_invt/product

Recupera uma lista de todos os inventários de produtos.

Formato de URL

URL padrão: api/sn_prd_invt/product

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
Nenhum

Tabela 2. Parâmetros de consulta
Nome	Descrição
cliente	Filtrar inventários de produtos por cliente. Somente ofertas de produto com um sys_id do cliente ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: cadeia de caracteres
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro. Padrão: 20 Máximo: 100 Tipo de dados: número
deslocamento	Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número
lugar	Filtrar inventários de produtos por local. Somente ofertas de produto com um sys_id de local ou ID externo correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: cadeia de caracteres
status	Filtrar inventários de produtospor status. Somente inventários de produtos com um status correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres

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

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum

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

Códigos de status

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

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

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
href	Link relativo para o registro de inventário do produto. Tipo de dados: cadeia de caracteres
id	Sys_id do inventário de produtos da tabela Inventário de produtos [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
nome	Nome do inventário de produtos. Tipo de dados: cadeia de caracteres
lugar	Local associado ao produto. Tipo de dados: cadeia de caracteres
Característica do produto	Lista de características do produto. Tipo de dados: matriz `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
productCharacteristic.name	Nome da característica. Tipo de dados: cadeia de caracteres
productCaracterística.valor	Valor da característica. Tipo de dados: cadeia de caracteres
productOffering	Oferta de produto à qual o inventário de produtos está associado. Tipo de dados: objeto `"productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOffering.id	Inicial_versão ou external_id da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
OfertaDeProduto.IDinterno	Inicial_versão da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productOffering.internalVersion	Versão da oferta de produto. 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
productOferta.versão	External_version da oferta de produto. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering]. Tipo de dados: cadeia de caracteres
productPrice	Retorna uma matriz vazia. Tipo de dados: matriz
productRelationship	Lista de produtos relacionados. Tipo de dados: matriz `"productRelationship": [ { "productId": "String", "relationshipType": "String" } ]`
RelacionamentoProduto.IDDoProduto	Sys_id do produto relacionado da tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
ProductRelationship.relationshipType	Tipo de relacionamento. Tipo de dados: cadeia de caracteres
productSpecification	Especificação do produto para o produto. Tipo de dados: objeto `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Inicial_versão ou external_id da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalId	Inicial_versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.internalVersion	Versão da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
productSpecification.version	External_version da especificação do produto. Localizado na tabela Especificação do produto [sn_prd_pm_product_specification]. Tipo de dados: cadeia de caracteres
realizandoRecurso	Recurso que realiza o produto. O recurso de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto `"realizingResource": { "id": "String", "type": "String" }`
realizingResource.id	Sys_id do recurso de realização. Localizado na tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoResource.type	Tipo de recurso de realização. Valor válido: secundário Tipo de dados: cadeia de caracteres
realizandoServiço	Serviço que realiza o produto. O serviço de realização é um inventário de produto secundário deste inventário de produto. Tipo de dados: objeto `"realizingService": { "id": "String", "type": "String" }`
realizingService.id	Sys_id do serviço de realização. Localizado na tabela Product Inventory [sn_prd_invt_product_inventory]. Tipo de dados: cadeia de caracteres
realizandoService.type	Tipo de serviço de realização. Valor válido: secundário Tipo de dados: cadeia de caracteres
relatedParty	Lista de partes associadas ao tíquete. Tipo de dados: matriz `"relatedParty": [ { "id": "String", "@referredType": "String" } ]`
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Localizado na tabela Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]. Tipo de dados: cadeia de caracteres
relatedParty.@referredType	Tipo de cliente. Valores possíveis: Cliente CustomerContact Consumidor Tipo de dados: cadeia de caracteres
state	Estado atual do produto. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera todos os inventários de produtos.

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

Corpo da resposta.

[
   {
      "id": "037fd87ec3603010abc8b5183c40ddf2",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Example Company",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "Routing and Configuration PI0000318",
      "productSpecification": {
         "id": "aec57e981bb420106ba59acf034bcb08",
         "name": "Routing and Configuration",
         "version": "",
         "internalVersion": "1",
         "internalId": "aec57e981bb420106ba59acf034bcb08"
      },
      "status": "Active",
      "productOffering": {
         "id": "69017a0f536520103b6bddeeff7b127d",
         "name": "Premium SD-WAN Offering",
         "version": "",
         "internalVersion": "1",
         "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "product": "ce0b52c7532520103b6bddeeff7b12f5",
      "place": {
         "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
         "name": "100 South Charles Street, Baltimore,MD"
      },
      "productCharacteristic": [],
      "productRelationship": [],
      "realizingService": [],
      "realizingResource": [
         {
            "id": "9b2fa60b536520103b6bddeeff7b1233",
            "name": "Route Target"
         }
      ],
      "productPrice": [],
      "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
      "billingAccount": "Not Specified."
   }
]

API aberta do inventário de produtos - GET /sn_prd_invt/product/{id}

Recupera um registro de inventário de produto especificado.