API de inventário de produtos em aberto

API de inventário de produto em aberto - OBTER /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(a)

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 Padrão: Não filtrar por cliente.
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Tipo de dados: Cadeia de caracteres Padrão: Retornar todos os campos.
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Tipo de dados: Número Padrão: 20 Máximo: 100
deslocamento	Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0
lugar	Filtrar inventários de produtos por local. Tipo de dados: Objeto `"place": { "id": "String" }`
place.id	Sys_id ou external_id do local associado ao registro de inventário do produto. Tabela: Local [cmn_location] Tipo de dados: Cadeia de caracteres
status	Filtrar inventários de produtos por 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 Padrão: Não filtrar por status.

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

Cabeçalhos

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

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

Tabela 5. Cabeçalhos de resposta
Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se `deslocamento: 2` e. `limite: 3` , o valor de Content-Rangeo cabeçalho é `itens 3-5` .
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
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 Códigos de resposta HTTP da REST API .

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

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
href	Link relativo para o registro de inventário do produto. Tipo de dados: Cadeia de caracteres
id	Sys_id do inventário do produto. Tipo de dados: Cadeia de caracteres Tabela: Inventário de produto [sn_prd_invt_product_inventory]
nome	Nome do inventário do produto. Tipo de dados: Cadeia de caracteres
lugar	Local associado ao produto. Tipo de dados: Objeto `"place": { "id": "String", "name": "String" }`
place.id	Sys_id ou external_id do local do inventário do produto. Tabela: Local [cmn_location] Dados: Cadeia de caracteres
place.name	Nome do local associado ao inventário de produtos. Tabela: Local [cmn_location] Dados: Cadeia de caracteres
ProdutorCaracterística	Lista de características do produto. Para obter informações adicionais sobre as características do produto, consulte Create a product offering category. Tipo de dados: Matriz de objetos `"productCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
productCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
ProdutoCaracteristic.value	Valor da característica. Tipo de dados: Cadeia de caracteres
ProductCharacteristic.valueType	Tipo de valor de característica. Valores aceitos: endereço matriz.data array.datetime array.decimal array.integer array.object teste de linha única.array caixa de seleção escolha data data/hora e-mail inteiro inteiro, data/hora objeto texto de linha única sim/não 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	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].
productOffering.internalId	Versão inicial da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: No campo internal_version da Oferta de produto [sn_prd_pm_product_offering]
productOffering.internalVersion	Versão da oferta do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Oferta de produto [sn_prd_pm_product_offering].
productOffering.name	Nome da oferta de produto. Tipo de dados: Cadeia de caracteres Tabela: Oferta de produto [sn_prd_pm_product_offering]
ProductOffering.version	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].
ProductPrice	Retorna uma matriz vazia. Tipo de dados: Matriz
ProductRelationship	Lista de produtos relacionados. Tipo de dados: Matriz de objetos `"productRelationship": [ { "productId": "String", "relationshipType": "String" } ]`
productRelationship.productId	Sys_id do produto relacionado. Tipo de dados: Cadeia de caracteres Tabela: Inventário de produto [sn_prd_invt_product_inventory]
ProductRelationship.Relationship Type	Tipo de relacionamento . 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 ou ID externo da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo internal_version ou external_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 Especificação do produto [sn_prd_pm_product_specification].
productSpecification.internalVersion	Versão da especificação do produto. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação do produto [sn_prd_pm_product_specification].
ProductSpecification.version	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].
RealizingResource	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. Tipo de dados: Cadeia de caracteres Tabela: Inventário de produto [sn_prd_invt_product_inventory]
RealizingResource.type	Tipo do recurso de realização. Valor válido: Secundário Tipo de dados: Cadeia de caracteres
RealizingService	Serviço que realiza o produto. O serviço 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. Tipo de dados: Cadeia de caracteres Tabela: Inventário de produto [sn_prd_invt_product_inventory]
RealizingService.type	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 de objetos `"relatedParty": [ { "id": "String", "@referredType": "String" } ]`
relatedParty.id	Sys_id da conta ou contato do cliente associado ao tíquete. Tipo de dados: Cadeia de caracteres Tabela: Conta [customer_account], Contato [customer_contact] ou Consumidor [csm_consumer]
RelatedParty. Em referredType	Tipo de cliente. Valores possíveis: Cliente Cliente Contato do cliente Tipo de dados: Cadeia de caracteres
estado	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 de inventário de produto em aberto - OBTER /sn_prd_invt/product/

Recupera um registro de inventário de produto especificado.