API aberta do inventário de recursos

A API do Resource Inventory Open fornece endpoints para criar, recuperar e excluir recursos.

Use esta API para gerenciar recursos nas tabelas a seguir.

• Cabo [cmdb_ci_cable]
• Suporte do equipamento [cmdb_ci_ni_equipment_holder]
• Cartão de interface [cmdb_ci_interface_card]
• Endereço IP [cmdb_ci_ip_address]
• Conexão lógica [cmdb_ci_ni_logical_path]
• Interface de rede [cmdb_ci_ni_interface]
• Local da rede [cmdb_ci_ni_site]
• Conexão física [cmdb_ci_ni_physical_link]
• Cadeia [cmdb_ci_strand]
• Topologia [cmdb_ci_topology]
• Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas.
• Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder].
• Tabelas secundárias que estendem qualquer uma das seguintes tabelas:
  • Cabo [cmdb_ci_cable]
  • Suporte do equipamento [cmdb_ci_ni_equipment_holder]
  • Cadeia [cmdb_ci_strand]

Esta API está incluída na aplicação Network Inventory Core, que está disponível no ServiceNow Store.

Esta API é fornecida no namespace sn_ni_core.

O usuário de chamada deve ter a função sn_ni_core.inventory_integrator.

Esta API pode ser estendida para fazer personalizações em torno de parâmetros necessários, solicitar validação de corpo e mapeamentos de campo. Para obter mais informações, consulte o Guia do desenvolvedor da Open API do inventário de recursos.

A API aberta de inventário de recursos é uma implementação ServiceNow® da especificação REST da API de inventário de recursos de fórum do TM. Esta implementação se baseia no Guia do usuário da API Resource Inventory TMF639 v4.0.1, julho de 2020.

API aberta do inventário de recursos - DELETE /sn_ni_core/resource/{id}

Exclui um registro de recurso especificado.

Formato da URL

URL padrão: /api/sn_ni_core/resource/{id}

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome

Descrição

id

Sys_id do recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de recurso. Cartão de interface [cmdb_ci_interface_card] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Nota: Os recursos na tabela Endereço IP [cmdb_ci_ip_address] não podem ser excluídos usando esta API. Tipo de dados: cadeia de caracteres

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 4. Cabeçalhos da solicitação

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

Tabela 5. Cabeçalhos de resposta

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

Códigos de status

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

Tabela 6. Códigos de status

Código do status	Descrição
215	Solicitação recebida com sucesso para processamento. A solicitação será concluída de forma assíncrona.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
403	Proibido. Falha na exclusão de recurso. O recurso pode ser necessário para seus recursos relacionados.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
Nenhum(a)

Solicitação de cURL

Este exemplo exclui um recurso.

curl "https://instance.service-now.com/api/sn_ni_core/resource/54ada05e875c15109a9c0f65dabb3586" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

Corpo da resposta.

""

API aberta do inventário de recursos - GET /sn_ni_core/resource

Recupera uma lista de todos os registros de recursos.

Formato da URL

URL padrão: /api/sn_ni_core/resource

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 8. Parâmetros de consulta

Nome	Descrição
@tipo	Obrigatório. Nome da tabela do tipo de recurso a ser recuperado. Você só pode recuperar um tipo de recurso por chamada de API. Valores válidos: cmdb_ci_cable (cabo) cmdb_ci_interface_card (Cartão de interface) cmdb_ci_ip_address (Endereço IP) cmdb_ci_ni_logical_path (Conexão lógica) cmdb_ci_ni_interface (Interface de rede) cmdb_ci_ni_site (local da rede) cmdb_ci_ni_ Physical_link (Conexão física) cmdb_ci_strand (cadeia) cmdb_ci_topology (Topologia) Nome de uma tabela especificada pelo sn_ni_core.equipment_tables sys_property ou nome de uma tabela que estende as tabelas especificadas. Nome de uma tabela que estende o Suporte de equipamento [cmdb_ci_equipment_holder]. Tipo de dados: cadeia de caracteres
descrição	Descrição a ser usada para filtrar recursos. Somente recursos com a descrição especificada são retornados na resposta. Tipo de dados: cadeia de caracteres
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Valores válidos: descrição href id nome anotação local relatedParty recursoCaracterística relacionamento de recurso especificação de recurso startOperatingDate Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos.
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 Tipo de dados: número
nome	Nome a ser usado para filtrar recursos. Somente recursos com o nome especificado são retornados na resposta. Tipo de dados: cadeia de caracteres
deslocamento	Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número
resourceSpecification.id	sys_id de especificação de recurso a ser usado para filtrar recursos. O sys_id deve ser de um modelo em uma das tabelas a seguir. Modelos de suporte de equipamento [sn_ni_core_equipment_holder_product_model] Modelos de equipamento [sn_ni_core_equipment_product_model] Modelos de cartão de interface [sn_ni_core_interface_card_product_model] Modelos de conexão lógica [sn_ni_core_logical_connection_product_model] Modelos de interface de rede [sn_ni_core_network_interface_product_model] Modelos de conexão física [sn_ni_core_ Physical_connection_product_model] Somente recursos com um modelo correspondente ao sys_id especificado são retornados na resposta. Tipo de dados: cadeia de caracteres

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 10. Cabeçalhos da solicitação

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

Tabela 11. 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 do cabeçalho Content-Range será itens 3-5.
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os links a seguir para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Contagem	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor. Nota: Se o número total de registros for maior que 100.000, este cabeçalho sempre retornará 100.000.

Códigos de status

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

Tabela 12. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
206	Conteúdo parcial. A solicitação foi processada com sucesso e retornou um intervalo parcial de conteúdo especificado por uma chamada paginada.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
@tipo	Tipo de recurso. Valores válidos: cmdb_ci_cable (cabo) cmdb_ci_interface_card (Cartão de interface) cmdb_ci_ip_address (Endereço IP) cmdb_ci_ni_logical_path (Conexão lógica) cmdb_ci_ni_interface (Interface de rede) cmdb_ci_ni_site (local da rede) cmdb_ci_ni_ Physical_link (Conexão física) cmdb_ci_strand (cadeia) cmdb_ci_topology (Topologia) Nome de uma tabela especificada pelo sn_ni_core.equipment_tables sys_property ou nome de uma tabela que estende as tabelas especificadas. Nome de uma tabela que estende o Suporte de equipamento [cmdb_ci_equipment_holder]. Tipo de dados: cadeia de caracteres
descrição	Descrição do recurso. Tipo de dados: cadeia de caracteres
href	Link relativo para o registro do recurso. Tipo de dados: cadeia de caracteres
id	Sys_id do recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de recurso. Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cartão de interface [cmdb_ci_interface_card] Endereço IP [cmdb_ci_ip_address] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Cadeia [cmdb_ci_strand] Topologia [cmdb_ci_topology] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Tabelas secundárias que estendem qualquer uma das seguintes tabelas: Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cadeia [cmdb_ci_strand] Tipo de dados: cadeia de caracteres
nome	Nome do recurso. Tipo de dados: cadeia de caracteres
anotação	Lista de anotações sobre o recurso. Tipo de dados: matriz de objetos "note": [ { "text": "String" } ]
anotação.texto	O texto da nota. Tipo de dados: cadeia de caracteres
local	Site de rede para o recurso. Este parâmetro não é compatível com recursos de Site de rede, Conexão física ou Conexão lógica. Tipo de dados: objeto "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Tipo de local. Este valor é sempre GeographicAddress. Tipo de dados: cadeia de caracteres
local.href	Link relativo para o registro do local. Tipo de dados: cadeia de caracteres
place.id	Sys_id do registro do local. Tipo de dados: cadeia de caracteres Tabela: site de rede [cmdb_ci_ni_site]
relatedParty	Detalhes sobre contatos do recurso. Tipo de dados: matriz de objetos "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Tipo de parte relacionada. Localizado no campo Tipo. Tipo de dados: cadeia de caracteres Tabela: no campo de tipo da tabela Grupo [sys_user_group].
relatedParty.href	Link relativo ao registro de parte relacionada. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id do registro de parte relacionada. Tipo de dados: cadeia de caracteres Tabela: Grupo [sys_user_group]
relatedParty.role	Função da parte relacionada. Tipo de dados: cadeia de caracteres Tabela: no campo Tipo de grupo da tabela Equipes [cmdb_rel_team].
recursoCaracterística	Lista de características do recurso. Os tipos de recursos a seguir exigem características de recursos específicas. Para recursos de Conexão física e Conexão lógica, uma característica de Porta A ou Porta Z é necessária. Se o Status da fase do ciclo de vida do recurso for Em uso, a Porta A e a Porta Z serão necessárias. Para recursos de suporte de equipamento, uma característica de tipo de contêiner é necessária. Tipo de dados: matriz de objetos "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nome do campo da tabela de recursos especificada pelo parâmetro @type. Você não pode usar os campos model_id, name, network_site,operation_notes, operating_status, short_description, start_date ou quaisquer campos com prefixo sys_, como sys_id. Tipo de dados: cadeia de caracteres
recursoCaracterística.valor	O valor da característica. Tipo de dados: cadeia de caracteres
resourceCharacteristic.valueType	Tipo de valor. Valores válidos: booliano data/hora float inteiro ph_number referência Cadeia de caracteres Tipo de dados: cadeia de caracteres
relacionamento de recurso	Lista de recursos relacionados. Os seguintes tipos de recursos exigem recursos relacionados específicos. Para recursos de Cartão de interface, é necessário um relacionamento com um recurso de Suporte de equipamento em que o Tipo de contêiner é Slot ou Sub-slot. Para recursos de interface de rede, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Para recursos de suporte de equipamento em que o tipo de contêiner é Slot ou Sub-slot, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Tipo de dados: matriz "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Tipo de relacionamento entre os dois recursos no formato [este descritor de recurso]::[descritor de recurso relacionado]. Por exemplo, Contains::Contained by indica que o recurso relacionado é o secundário deste recurso. Os valores válidos para os descritores estão localizados na tabela Tipo de relacionamento de IC [cmdb_rel_type] nas colunas Descritor primário e Descritor secundário. Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso	Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso. Cabo Equipamento Suporte de equipamentos Cartão de interface Conexão lógica Interface de rede Local da Rede Conexão física Cadeia Topologia Tipo de dados: objeto "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id do recurso relacionado. Localizado em uma das tabelas a seguir, dependendo do tipo de recurso relacionado. Cartão de interface [cmdb_ci_interface_card] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o suporte de equipamento [cmdb_ci_equipment_holder] Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso.href	Link relativo ao registro de recurso relacionado. Tipo de dados: cadeia de caracteres
especificação de recurso	Especificação de recurso. Tipo de dados: objeto "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id do modelo associado ao recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de modelo. Modelos de cabo [sn_ent_cable_model] Modelos de suporte de equipamento [sn_ent_nw_holder_model] Modelos de equipamento [sn_ent_nw_equipment_model] Modelos de cartão de interface [sn_ent_nw_interface_model] Modelos de conexão lógica [sn_ent_logical_nw_connection_model] Modelos de interface de rede [sn_ent_nw_interface_model] Modelos de conexão física [sn_ent_ Physical_nw_connection_model] Modelos de perna [sn_ent_strand_model] Modelos de topologia [sn_ent_network_topology_model] Tipo de dados: cadeia de caracteres
startOperatingDate	Data e hora em que o recurso começou a operar pela primeira vez. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera os campos name, ide href para os primeiros cinco registros de recurso do site de rede.

curl "https://instance.service-now.com/api/sn_ni_core/resource?@type=cmdb_ci_ni_site&fields=name%2Cid%2Chref&limit=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corpo da resposta.

[
   {
      "name": "DALLAS TX CO/HUB",
      "id": "c23683c54051c910f8772175cacd725c",
      "href": "/api/sn_ni_core/resource/c23683c54051c910f8772175cacd725c"
   },
   {
      "name": "PFP LOC F-800",
      "id": "0ac19bc54051c910f8772175cacd724b",
      "href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
   },
   {
      "name": "FIBER SERVICE TERMINAL 003",
      "id": "d0541fcd4051c910f8772175cacd72c8",
      "href": "/api/sn_ni_core/resource/d0541fcd4051c910f8772175cacd72c8"
   },
   {
      "name": "270 RUMWOOD MAIN",
      "id": "e6f6df8d4051c910f8772175cacd72b2",
      "href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
   },
   {
      "name": "3620 CHESTER ROMI48073",
      "id": "917dd8f6870e851079c40f2d0ebb353d",
      "href": "/api/sn_ni_core/resource/917dd8f6870e851079c40f2d0ebb353d"
   }
]

API aberta do inventário de recursos - GET /sn_ni_core/resource/{id}

Recupera um registro de recurso especificado.

Formato da URL

URL padrão: /api/sn_ni_core/resource/{id}

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome

Descrição

id

Sys_id do recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de recurso. Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cartão de interface [cmdb_ci_interface_card] Endereço IP [cmdb_ci_ip_address] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Cadeia [cmdb_ci_strand] Topologia [cmdb_ci_topology] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Tabelas secundárias que estendem qualquer uma das seguintes tabelas: Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cadeia [cmdb_ci_strand] Tipo de dados: cadeia de caracteres

Tabela 14. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Valores válidos: descrição href id nome anotação local relatedParty recursoCaracterística relacionamento de recurso especificação de recurso startOperatingDate Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos.

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

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

Tabela 16. Cabeçalhos da solicitação

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

Tabela 17. Cabeçalhos de resposta

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

Códigos de status

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

Tabela 18. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
@tipo	Tipo de recurso. Valores válidos: cmdb_ci_cable (cabo) cmdb_ci_interface_card (Cartão de interface) cmdb_ci_ip_address (Endereço IP) cmdb_ci_ni_logical_path (Conexão lógica) cmdb_ci_ni_interface (Interface de rede) cmdb_ci_ni_site (local da rede) cmdb_ci_ni_ Physical_link (Conexão física) cmdb_ci_strand (cadeia) cmdb_ci_topology (Topologia) Nome de uma tabela especificada pelo sn_ni_core.equipment_tables sys_property ou nome de uma tabela que estende as tabelas especificadas. Nome de uma tabela que estende o Suporte de equipamento [cmdb_ci_equipment_holder]. Tipo de dados: cadeia de caracteres
descrição	Descrição do recurso. Tipo de dados: cadeia de caracteres
href	Link relativo para o registro do recurso. Tipo de dados: cadeia de caracteres
id	Sys_id do recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de recurso. Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cartão de interface [cmdb_ci_interface_card] Endereço IP [cmdb_ci_ip_address] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Cadeia [cmdb_ci_strand] Topologia [cmdb_ci_topology] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Tabelas secundárias que estendem qualquer uma das seguintes tabelas: Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cadeia [cmdb_ci_strand] Tipo de dados: cadeia de caracteres
nome	Nome do recurso. Tipo de dados: cadeia de caracteres
anotação	Lista de anotações sobre o recurso. Tipo de dados: matriz de objetos "note": [ { "text": "String" } ]
anotação.texto	O texto da nota. Tipo de dados: cadeia de caracteres
local	Site de rede para o recurso. Este parâmetro não é compatível com recursos de Site de rede, Conexão física ou Conexão lógica. Tipo de dados: objeto "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Tipo de local. Este valor é sempre GeographicAddress. Tipo de dados: cadeia de caracteres
local.href	Link relativo para o registro do local. Tipo de dados: cadeia de caracteres
place.id	Sys_id do registro do local. Tipo de dados: cadeia de caracteres Tabela: site de rede [cmdb_ci_ni_site]
relatedParty	Detalhes sobre contatos do recurso. Tipo de dados: matriz de objetos "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Tipo de parte relacionada. Localizado no campo Tipo. Tipo de dados: cadeia de caracteres Tabela: no campo de tipo da tabela Grupo [sys_user_group].
relatedParty.href	Link relativo ao registro de parte relacionada. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id do registro de parte relacionada. Tipo de dados: cadeia de caracteres Tabela: Grupo [sys_user_group]
recursoCaracterística	Lista de características do recurso. Os tipos de recursos a seguir exigem características de recursos específicas. Para recursos de Conexão física e Conexão lógica, uma característica de Porta A ou Porta Z é necessária. Se o Status da fase do ciclo de vida do recurso for Em uso, a Porta A e a Porta Z serão necessárias. Para recursos de suporte de equipamento, uma característica de tipo de contêiner é necessária. Tipo de dados: matriz de objetos "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nome do campo da tabela de recursos especificada pelo parâmetro @type. Você não pode usar os campos model_id, name, network_site,operation_notes, operating_status, short_description, start_date ou quaisquer campos com prefixo sys_, como sys_id. Tipo de dados: cadeia de caracteres
recursoCaracterística.valor	O valor da característica. Tipo de dados: cadeia de caracteres
resourceCharacteristic.valueType	Tipo de valor. Valores válidos: booliano data/hora float inteiro ph_number referência Cadeia de caracteres Tipo de dados: cadeia de caracteres
relacionamento de recurso	Lista de recursos relacionados. Os seguintes tipos de recursos exigem recursos relacionados específicos. Para recursos de Cartão de interface, é necessário um relacionamento com um recurso de Suporte de equipamento em que o Tipo de contêiner é Slot ou Sub-slot. Para recursos de interface de rede, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Para recursos de suporte de equipamento em que o tipo de contêiner é Slot ou Sub-slot, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Tipo de dados: matriz "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Tipo de relacionamento entre os dois recursos no formato [este descritor de recurso]::[descritor de recurso relacionado]. Por exemplo, Contains::Contained by indica que o recurso relacionado é o secundário deste recurso. Os valores válidos para os descritores estão localizados na tabela Tipo de relacionamento de IC [cmdb_rel_type] nas colunas Descritor primário e Descritor secundário. Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso	Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso. Cabo Equipamento Suporte de equipamentos Cartão de interface Conexão lógica Interface de rede Local da Rede Conexão física Cadeia Topologia Tipo de dados: objeto "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id do recurso relacionado. Localizado em uma das tabelas a seguir, dependendo do tipo de recurso relacionado. Cartão de interface [cmdb_ci_interface_card] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o suporte de equipamento [cmdb_ci_equipment_holder] Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso.href	Link relativo ao registro de recurso relacionado. Tipo de dados: cadeia de caracteres
especificação de recurso	Especificação de recurso. Tipo de dados: objeto "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id do modelo associado ao recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de modelo. Modelos de cabo [sn_ent_cable_model] Modelos de suporte de equipamento [sn_ent_nw_holder_model] Modelos de equipamento [sn_ent_nw_equipment_model] Modelos de cartão de interface [sn_ent_nw_interface_model] Modelos de conexão lógica [sn_ent_logical_nw_connection_model] Modelos de interface de rede [sn_ent_nw_interface_model] Modelos de conexão física [sn_ent_ Physical_nw_connection_model] Modelos de perna [sn_ent_strand_model] Modelos de topologia [sn_ent_network_topology_model] Tipo de dados: cadeia de caracteres
startOperatingDate	Data e hora em que o recurso começou a operar pela primeira vez. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo recupera um registro de recurso especificado.

curl "https://instance.service-now.com/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corpo da resposta.

{
   "href": "/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de",
   "id": "915da8e140ddc910f8772175cacd72de",
   "name": "DLLSTXMR/ESS7450/IOM-01/MDA-01/NI-01",
   "place": {
      "id": "c23683c54051c910f8772175cacd725c",
      "href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
      "@referredType": "GeographicAddress"
   },
   "resourceCharacteristic": [
      {
         "name": "attested",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "availability",
         "valueType": "string",
         "value": "used"
      },
      {
         "name": "cabled",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "can_print",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "connector_type",
         "valueType": "string",
         "value": "sc"
      },
      {
         "name": "cost_cc",
         "valueType": "string",
         "value": "USD"
      },
      {
         "name": "equipment_clli",
         "valueType": "string",
         "value": "DLLSTXESS01"
      },
      {
         "name": "fault_count",
         "valueType": "integer",
         "value": "0"
      },
      {
         "name": "install_status",
         "valueType": "integer",
         "value": "1"
      },
      {
         "name": "life_cycle_stage",
         "valueType": "reference",
         "value": "Operational"
      },
      {
         "name": "life_cycle_stage_status",
         "valueType": "reference",
         "value": "In Use"
      },
      {
         "name": "manufacturer",
         "valueType": "reference",
         "value": "a2f6a4914055c910f8772175cacd723a"
      },
      {
         "name": "monitor",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "network_domain",
         "valueType": "string",
         "value": "core"
      },
      {
         "name": "ni_type",
         "valueType": "reference",
         "value": "646cf25fe42e0510f877e70ec9bcaca8"
      },
      {
         "name": "port_bandwidth",
         "valueType": "reference",
         "value": "ff39ae92eb900110700ca73bc152286d"
      },
      {
         "name": "replaceable",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "skip_sync",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "telco_equipment",
         "valueType": "reference",
         "value": "583e7b95405dc910f8772175cacd7292"
      },
      {
         "name": "unverified",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "virtual",
         "valueType": "boolean",
         "value": "false"
      }
   ],
   "resourceRelationship": [
      {
         "relationshipType": "Contained by::Contains",
         "resource": {
            "id": "81baac6140ddc910f8772175cacd728e",
            "href": "/api/sn_ni_core/resource/81baac6140ddc910f8772175cacd728e"
         }
      },
      {
         "relationshipType": "Contained by::Contains",
         "resource": {
            "id": "bf624bc640194d10f8772175cacd7225",
            "href": "/api/sn_ni_core/resource/bf624bc640194d10f8772175cacd7225"
         }
      }
   ],
   "resourceSpecification": {
      "id": "980416b0874e8110d28eb259dabb356b",
      "href": "/api/now/table/sn_ni_core_network_inventory_product_model/980416b0874e8110d28eb259dabb356b",
      "@referredType": "NetworkInterfaceModel"
   },
   "@type": "cmdb_ci_ni_interface"
}

API aberta do inventário de recursos - PATCH /sn_ni_core/resource/{id}

Atualiza um registro de recurso especificado.

Formato da URL

URL padrão: /api/sn_ni_core/resource/{id}

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome

Descrição

id

Sys_id do recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de recurso. Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cartão de interface [cmdb_ci_interface_card] Endereço IP [cmdb_ci_ip_address] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Cadeia [cmdb_ci_strand] Topologia [cmdb_ci_topology] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Tabelas secundárias que estendem qualquer uma das seguintes tabelas: Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cadeia [cmdb_ci_strand] Tipo de dados: cadeia de caracteres

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
@tipo	Tipo de recurso. Valores válidos: cmdb_ci_cable (cabo) cmdb_ci_interface_card (Cartão de interface) cmdb_ci_ip_address (Endereço IP) cmdb_ci_ni_logical_path (Conexão lógica) cmdb_ci_ni_interface (Interface de rede) cmdb_ci_ni_site (local da rede) cmdb_ci_ni_ Physical_link (Conexão física) cmdb_ci_strand (cadeia) cmdb_ci_topology (Topologia) Nome de uma tabela especificada pelo sn_ni_core.equipment_tables sys_property ou nome de uma tabela que estende as tabelas especificadas. Nome de uma tabela que estende o Suporte de equipamento [cmdb_ci_equipment_holder]. Tipo de dados: cadeia de caracteres
descrição	Descrição do recurso. Tipo de dados: cadeia de caracteres
href	Link relativo para o registro do recurso. Tipo de dados: cadeia de caracteres
nome	Nome do recurso. Tipo de dados: cadeia de caracteres
anotação	Lista de anotações sobre o recurso. Tipo de dados: matriz de objetos "note": [ { "text": "String" } ]
anotação.texto	Obrigatório se o parâmetro note for usado. O texto da nota. Tipo de dados: cadeia de caracteres
local	Site de rede para o recurso. Este parâmetro não é compatível com recursos de Site de rede, Conexão física ou Conexão lógica. Tipo de dados: objeto "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Tipo de local. Este valor é sempre GeographicAddress. Tipo de dados: cadeia de caracteres
local.href	Link relativo para o registro do local. Tipo de dados: cadeia de caracteres
place.id	Obrigatório se o parâmetro place for usado. Sys_id do registro do local. Tipo de dados: cadeia de caracteres Tabela: site de rede [cmdb_ci_ni_site]
relatedParty	Detalhes sobre contatos do recurso. Tipo de dados: matriz de objetos "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ] Nota: A remoção de registros relatedParty de um recurso não é compatível com este endpoint. Os registros podem ser excluídos manualmente da tabela Equipes [cmdb_rel_team].
relatedParty.@referredType	Tipo de parte relacionada. Localizado no campo Tipo. Tipo de dados: cadeia de caracteres Tabela: no campo de tipo da tabela Grupo [sys_user_group].
relatedParty.href	Link relativo ao registro de parte relacionada. Tipo de dados: cadeia de caracteres
relatedParty.id	Obrigatório se o parâmetro relatedParty for usado. Sys_id do registro de parte relacionada. Tipo de dados: cadeia de caracteres Tabela: Grupo [sys_user_group]
relatedParty.role	Função da parte relacionada. Tipo de dados: cadeia de caracteres Tabela: no campo Tipo de grupo da tabela Equipes [cmdb_rel_team].
recursoCaracterística	Lista de características do recurso. Os tipos de recursos a seguir exigem características de recursos específicas. Para recursos de Conexão física e Conexão lógica, uma característica de Porta A ou Porta Z é necessária. Se o Status da fase do ciclo de vida do recurso for Em uso, a Porta A e a Porta Z serão necessárias. Para recursos de suporte de equipamento, uma característica de tipo de contêiner é necessária. Tipo de dados: matriz de objetos "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Obrigatório se o parâmetro resourceCharacteristic for usado. Nome do campo da tabela de recursos especificada pelo parâmetro @type. Você não pode usar os campos model_id, name, network_site,operation_notes, operating_status, short_description, start_date ou quaisquer campos com prefixo sys_, como sys_id. Tipo de dados: cadeia de caracteres
recursoCaracterística.valor	Obrigatório se o parâmetro resourceCharacteristic for usado. O valor da característica. Tipo de dados: cadeia de caracteres
resourceCharacteristic.valueType	Tipo de valor. Valores válidos: booliano data/hora float inteiro ph_number referência Cadeia de caracteres Tipo de dados: cadeia de caracteres
relacionamento de recurso	Lista de recursos relacionados. Os seguintes tipos de recursos exigem recursos relacionados específicos. Para recursos de Cartão de interface, é necessário um relacionamento com um recurso de Suporte de equipamento em que o Tipo de contêiner é Slot ou Sub-slot. Para recursos de interface de rede, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Para recursos de suporte de equipamento em que o tipo de contêiner é Slot ou Sub-slot, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Tipo de dados: matriz "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Obrigatório se o parâmetro resourceRelationship for usado. Tipo de relacionamento entre os dois recursos no formato [este descritor de recurso]::[descritor de recurso relacionado]. Por exemplo, Contains::Contained by indica que o recurso relacionado é o secundário deste recurso. Os valores válidos para os descritores estão localizados na tabela Tipo de relacionamento de IC [cmdb_rel_type] nas colunas Descritor primário e Descritor secundário. Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso	Obrigatório se o parâmetro resourceRelationship for usado. Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso. Cabo Equipamento Suporte de equipamentos Cartão de interface Conexão lógica Interface de rede Local da Rede Conexão física Cadeia Topologia Tipo de dados: objeto "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Obrigatório se o parâmetro resourceRelationship for usado. Sys_id do recurso relacionado. Localizado em uma das tabelas a seguir, dependendo do tipo de recurso relacionado. Cartão de interface [cmdb_ci_interface_card] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o suporte de equipamento [cmdb_ci_equipment_holder] Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso.href	Link relativo ao registro de recurso relacionado. Tipo de dados: cadeia de caracteres
especificação de recurso	Especificação de recurso. Tipo de dados: objeto "resourceSpecification": { "id": "String" }
resourceSpecification.id	Obrigatório se o parâmetro resourceSpecification for usado. Sys_id do modelo associado ao recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de modelo. Modelos de cabo [sn_ent_cable_model] Modelos de suporte de equipamento [sn_ent_nw_holder_model] Modelos de equipamento [sn_ent_nw_equipment_model] Modelos de cartão de interface [sn_ent_nw_interface_model] Modelos de conexão lógica [sn_ent_logical_nw_connection_model] Modelos de interface de rede [sn_ent_nw_interface_model] Modelos de conexão física [sn_ent_ Physical_nw_connection_model] Modelos de perna [sn_ent_strand_model] Modelos de topologia [sn_ent_network_topology_model] Tipo de dados: cadeia de caracteres
startOperatingDate	Data e hora em que o recurso começou a operar pela primeira vez. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/merge-patch+json.

Tabela 23. Cabeçalhos de resposta

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

Códigos de status

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

Tabela 24. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
415	O corpo da solicitação está em um formato incompatível ou o cabeçalho da solicitação Content-Type está definido incorretamente.

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

Nome	Descrição
@tipo	Tipo de recurso. Valores válidos: cmdb_ci_cable (cabo) cmdb_ci_interface_card (Cartão de interface) cmdb_ci_ip_address (Endereço IP) cmdb_ci_ni_logical_path (Conexão lógica) cmdb_ci_ni_interface (Interface de rede) cmdb_ci_ni_site (local da rede) cmdb_ci_ni_ Physical_link (Conexão física) cmdb_ci_strand (cadeia) cmdb_ci_topology (Topologia) Nome de uma tabela especificada pelo sn_ni_core.equipment_tables sys_property ou nome de uma tabela que estende as tabelas especificadas. Nome de uma tabela que estende o Suporte de equipamento [cmdb_ci_equipment_holder]. Tipo de dados: cadeia de caracteres
descrição	Descrição do recurso. Tipo de dados: cadeia de caracteres
href	Link relativo para o registro do recurso. Tipo de dados: cadeia de caracteres
id	Sys_id do recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de recurso. Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cartão de interface [cmdb_ci_interface_card] Endereço IP [cmdb_ci_ip_address] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Cadeia [cmdb_ci_strand] Topologia [cmdb_ci_topology] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Tabelas secundárias que estendem qualquer uma das seguintes tabelas: Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cadeia [cmdb_ci_strand] Tipo de dados: cadeia de caracteres
nome	Nome do recurso. Tipo de dados: cadeia de caracteres
anotação	Lista de anotações sobre o recurso. Tipo de dados: matriz de objetos "note": [ { "text": "String" } ]
anotação.texto	O texto da nota. Tipo de dados: cadeia de caracteres
local	Site de rede para o recurso. Este parâmetro não é compatível com recursos de Site de rede, Conexão física ou Conexão lógica. Tipo de dados: objeto "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Tipo de local. Este valor é sempre GeographicAddress. Tipo de dados: cadeia de caracteres
local.href	Link relativo para o registro do local. Tipo de dados: cadeia de caracteres
place.id	Sys_id do registro do local. Tipo de dados: cadeia de caracteres Tabela: site de rede [cmdb_ci_ni_site]
relatedParty	Detalhes sobre contatos do recurso. Tipo de dados: matriz de objetos "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Tipo de parte relacionada. Localizado no campo Tipo. Tipo de dados: cadeia de caracteres Tabela: no campo de tipo da tabela Grupo [sys_user_group].
relatedParty.href	Link relativo ao registro de parte relacionada. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id do registro de parte relacionada. Tipo de dados: cadeia de caracteres Tabela: Grupo [sys_user_group]
relatedParty.role	Função da parte relacionada. Tipo de dados: cadeia de caracteres Tabela: no campo Tipo de grupo da tabela Equipes [cmdb_rel_team].
recursoCaracterística	Lista de características do recurso. Os tipos de recursos a seguir exigem características de recursos específicas. Para recursos de Conexão física e Conexão lógica, uma característica de Porta A ou Porta Z é necessária. Se o Status da fase do ciclo de vida do recurso for Em uso, a Porta A e a Porta Z serão necessárias. Para recursos de suporte de equipamento, uma característica de tipo de contêiner é necessária. Tipo de dados: matriz de objetos "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nome do campo da tabela de recursos especificada pelo parâmetro @type. Você não pode usar os campos model_id, name, network_site,operation_notes, operating_status, short_description, start_date ou quaisquer campos com prefixo sys_, como sys_id. Tipo de dados: cadeia de caracteres
recursoCaracterística.valor	O valor da característica. Tipo de dados: cadeia de caracteres
resourceCharacteristic.valueType	Tipo de valor. Valores válidos: booliano data/hora float inteiro ph_number referência Cadeia de caracteres Tipo de dados: cadeia de caracteres
relacionamento de recurso	Lista de recursos relacionados. Os seguintes tipos de recursos exigem recursos relacionados específicos. Para recursos de Cartão de interface, é necessário um relacionamento com um recurso de Suporte de equipamento em que o Tipo de contêiner é Slot ou Sub-slot. Para recursos de interface de rede, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Para recursos de suporte de equipamento em que o tipo de contêiner é Slot ou Sub-slot, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Tipo de dados: matriz "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Tipo de relacionamento entre os dois recursos no formato [este descritor de recurso]::[descritor de recurso relacionado]. Por exemplo, Contains::Contained by indica que o recurso relacionado é o secundário deste recurso. Os valores válidos para os descritores estão localizados na tabela Tipo de relacionamento de IC [cmdb_rel_type] nas colunas Descritor primário e Descritor secundário. Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso	Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso. Cabo Equipamento Suporte de equipamentos Cartão de interface Conexão lógica Interface de rede Local da Rede Conexão física Cadeia Topologia Tipo de dados: objeto "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id do recurso relacionado. Localizado em uma das tabelas a seguir, dependendo do tipo de recurso relacionado. Cartão de interface [cmdb_ci_interface_card] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o suporte de equipamento [cmdb_ci_equipment_holder] Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso.href	Link relativo ao registro de recurso relacionado. Tipo de dados: cadeia de caracteres
especificação de recurso	Especificação de recurso. Tipo de dados: objeto "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id do modelo associado ao recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de modelo. Modelos de cabo [sn_ent_cable_model] Modelos de suporte de equipamento [sn_ent_nw_holder_model] Modelos de equipamento [sn_ent_nw_equipment_model] Modelos de cartão de interface [sn_ent_nw_interface_model] Modelos de conexão lógica [sn_ent_logical_nw_connection_model] Modelos de interface de rede [sn_ent_nw_interface_model] Modelos de conexão física [sn_ent_ Physical_nw_connection_model] Modelos de perna [sn_ent_strand_model] Modelos de topologia [sn_ent_network_topology_model] Tipo de dados: cadeia de caracteres
startOperatingDate	Data e hora em que o recurso começou a operar pela primeira vez. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo atualiza o nome de um recurso.

curl "http://instance.servicenow.com/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/merge-patch+json" \
--user 'username':'password' \
--data '{"name": "new name"}'

Corpo da resposta.

{
  "href": "/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292",
  "id": "583e7b95405dc910f8772175cacd7292",
  "name": "new name",
  "note": [
    {
      "text": "TECHNICIAN SCHECULED TO BE ONSITE THE WEEK OF APRIL 4, 2022."
    }
  ],
  "place": {
    "id": "c23683c54051c910f8772175cacd725c",
    "href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
    "@referredType": "GeographicAddress"
  },
  "resourceCharacteristic": [
    {
      "name": "alarmable",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "attested",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_hub",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_partitionvlans",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_print",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_route",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_switch",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "comments",
      "valueType": "string",
      "value": "ETHERNET SWITCH"
    },
    {
      "name": "cost_cc",
      "valueType": "string",
      "value": "USD"
    },
    {
      "name": "cpu_count",
      "valueType": "integer",
      "value": "1"
    },
    {
      "name": "equipment_clli",
      "valueType": "string",
      "value": "DLLSTXESS01"
    },
    {
      "name": "fault_count",
      "valueType": "integer",
      "value": "0"
    },
    {
      "name": "firmware_manufacturer",
      "valueType": "reference",
      "value": "0c441abbc6112275000025157c651c89"
    },
    {
      "name": "firmware_version",
      "valueType": "string",
      "value": "A09DX887"
    },
    {
      "name": "hardware_status",
      "valueType": "string",
      "value": "installed"
    },
    {
      "name": "install_status",
      "valueType": "integer",
      "value": "1"
    },
    {
      "name": "internet_facing",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "inventory_category",
      "valueType": "string",
      "value": "equipment"
    },
    {
      "name": "last_service_date",
      "valueType": "datetime",
      "value": "2022-02-18T16:36:54.000Z"
    },
    {
      "name": "life_cycle_stage",
      "valueType": "reference",
      "value": "Deploy"
    },
    {
      "name": "life_cycle_stage_status",
      "valueType": "reference",
      "value": "Reserved"
    },
    {
      "name": "managed_by",
      "valueType": "reference",
      "value": "46c9e158a9fe198101d44d0d22cb640d"
    },
    {
      "name": "manufacturer",
      "valueType": "reference",
      "value": "b7e831bdc0a80169015ae101f3c4d6cd"
    },
    {
      "name": "model_number",
      "valueType": "string",
      "value": "7450ESS-1"
    },
    {
      "name": "monitor",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "network_domain",
      "valueType": "string",
      "value": "core"
    },
    {
      "name": "ni_function",
      "valueType": "reference",
      "value": "2d22153940990d10f8772175cacd728b"
    },
    {
      "name": "ni_role",
      "valueType": "reference",
      "value": "c68e3f15405dc910f8772175cacd72f1"
    },
    {
      "name": "ni_type",
      "valueType": "reference",
      "value": "3772e8d54015c910f8772175cacd721c"
    },
    {
      "name": "ram",
      "valueType": "integer",
      "value": "3000"
    },
    {
      "name": "replaceable",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "serial_number",
      "valueType": "string",
      "value": "7894564568225"
    },
    {
      "name": "skip_sync",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "spare",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "template_id",
      "valueType": "reference",
      "value": "49433535e5d28110f877657a33339131"
    },
    {
      "name": "unit_position",
      "valueType": "integer",
      "value": "2"
    },
    {
      "name": "unverified",
      "valueType": "boolean",
      "value": "false"
    }
  ],
  "resourceRelationship": [
    {
      "relationshipType": "Contains::Contained by",
      "resource": {
        "id": "f5d1c429405dc910f8772175cacd723f",
        "href": "/api/sn_ni_core/resource/f5d1c429405dc910f8772175cacd723f"
      }
    },
    {
      "relationshipType": "Contains::Contained by",
      "resource": {
        "id": "d6e100e5405dc910f8772175cacd72e9",
        "href": "/api/sn_ni_core/resource/d6e100e5405dc910f8772175cacd72e9"
      }
    },
    {
      "relationshipType": "Contained by::Contains",
      "resource": {
        "id": "5b10e8154015c910f8772175cacd724d",
        "href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
      }
    }
  ],
  "resourceSpecification": {
    "id": "0ae34df1e5528110f877657a33339119",
    "href": "/api/now/table/cmdb_model/0ae34df1e5528110f877657a33339119",
    "@referredType": "EquipmentModel"
  },
  "@type": "cmdb_ci_ni_telco_equipment"
}

API aberta do inventário de recursos - POST /sn_ni_core/resource

Cria um registro de recurso.

Formato da URL

URL padrão: /api/sn_ni_core/resource

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 26. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
@tipo	Tipo de recurso. Valores válidos: cmdb_ci_cable (cabo) cmdb_ci_interface_card (Cartão de interface) cmdb_ci_ip_address (Endereço IP) cmdb_ci_ni_logical_path (Conexão lógica) cmdb_ci_ni_interface (Interface de rede) cmdb_ci_ni_site (local da rede) cmdb_ci_ni_ Physical_link (Conexão física) cmdb_ci_strand (cadeia) cmdb_ci_topology (Topologia) Nome de uma tabela especificada pelo sn_ni_core.equipment_tables sys_property ou nome de uma tabela que estende as tabelas especificadas. Nome de uma tabela que estende o Suporte de equipamento [cmdb_ci_equipment_holder]. Tipo de dados: cadeia de caracteres
descrição	Descrição do recurso. Tipo de dados: cadeia de caracteres
nome	Obrigatório. Nome do recurso. Tipo de dados: cadeia de caracteres
anotação	Lista de anotações sobre o recurso. Tipo de dados: matriz de objetos "note": [ { "text": "String" } ]
anotação.texto	Obrigatório se o parâmetro note for usado. O texto da nota. Tipo de dados: cadeia de caracteres
local	Necessário para recursos de suporte de equipamento em que o tipo de contêiner é gaiola, compartimento, gabinete, rack, linha ou pacote de modelo de inventário. Necessário para todos os recursos de equipamento. Site de rede para o recurso. Este parâmetro não é compatível com recursos de Site de rede, Conexão física ou Conexão lógica. Tipo de dados: objeto "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Tipo de local. Este valor é sempre GeographicAddress. Tipo de dados: cadeia de caracteres
local.href	Link relativo para o registro do local. Tipo de dados: cadeia de caracteres
place.id	Obrigatório se o parâmetro place for usado. Sys_id do registro do local. Tipo de dados: cadeia de caracteres Tabela: site de rede [cmdb_ci_ni_site]
relatedParty	Detalhes sobre contatos do recurso. Tipo de dados: matriz de objetos "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Tipo de parte relacionada. Localizado no campo Tipo. Tipo de dados: cadeia de caracteres Tabela: no campo de tipo da tabela Grupo [sys_user_group].
relatedParty.href	Link relativo ao registro de parte relacionada. Tipo de dados: cadeia de caracteres
relatedParty.id	Obrigatório se o parâmetro relatedParty for usado. Sys_id do registro de parte relacionada. Tipo de dados: cadeia de caracteres Tabela: Grupo [sys_user_group]
recursoCaracterística	Lista de características do recurso. Os tipos de recursos a seguir exigem características de recursos específicas. Para recursos de Conexão física e Conexão lógica, uma característica de Porta A ou Porta Z é necessária. Se o Status da fase do ciclo de vida do recurso for Em uso, a Porta A e a Porta Z serão necessárias. Para recursos de suporte de equipamento, uma característica de tipo de contêiner é necessária. Tipo de dados: matriz de objetos "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Obrigatório se o parâmetro resourceCharacteristic for usado. Nome do campo da tabela de recursos especificada pelo parâmetro @type. Você não pode usar os campos model_id, name, network_site,operation_notes, operating_status, short_description, start_date ou quaisquer campos com prefixo sys_, como sys_id. Tipo de dados: cadeia de caracteres
recursoCaracterística.valor	Obrigatório se o parâmetro resourceCharacteristic for usado. O valor da característica. Tipo de dados: cadeia de caracteres
resourceCharacteristic.valueType	Tipo de valor. Valores válidos: booliano data/hora float inteiro ph_number referência Cadeia de caracteres Tipo de dados: cadeia de caracteres
relacionamento de recurso	Lista de recursos relacionados. Os seguintes tipos de recursos exigem recursos relacionados específicos. Para recursos de Cartão de interface, é necessário um relacionamento com um recurso de Suporte de equipamento em que o Tipo de contêiner é Slot ou Sub-slot. Para recursos de interface de rede, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Para recursos de suporte de equipamento em que o tipo de contêiner é Slot ou Sub-slot, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Tipo de dados: matriz "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Obrigatório se o parâmetro resourceRelationship for usado. Tipo de relacionamento entre os dois recursos no formato [este descritor de recurso]::[descritor de recurso relacionado]. Por exemplo, Contains::Contained by indica que o recurso relacionado é o secundário deste recurso. Os valores válidos para os descritores estão localizados na tabela Tipo de relacionamento de IC [cmdb_rel_type] nas colunas Descritor primário e Descritor secundário. Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso	Obrigatório se o parâmetro resourceRelationship for usado. Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso. Cabo Equipamento Suporte de equipamentos Cartão de interface Conexão lógica Interface de rede Local da Rede Conexão física Cadeia Topologia Tipo de dados: objeto "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Obrigatório se o parâmetro resourceRelationship for usado. Sys_id do recurso relacionado. Localizado em uma das tabelas a seguir, dependendo do tipo de recurso relacionado. Cartão de interface [cmdb_ci_interface_card] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o suporte de equipamento [cmdb_ci_equipment_holder] Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso.href	Link relativo ao registro de recurso relacionado. Tipo de dados: cadeia de caracteres
especificação de recurso	Especificação de recurso. Tipo de dados: objeto "resourceSpecification": { "id": "String" }
resourceSpecification.id	Obrigatório se o parâmetro resourceSpecification for usado. Sys_id do modelo associado ao recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de modelo. Modelos de cabo [sn_ent_cable_model] Modelos de suporte de equipamento [sn_ent_nw_holder_model] Modelos de equipamento [sn_ent_nw_equipment_model] Modelos de cartão de interface [sn_ent_nw_interface_model] Modelos de conexão lógica [sn_ent_logical_nw_connection_model] Modelos de interface de rede [sn_ent_nw_interface_model] Modelos de conexão física [sn_ent_ Physical_nw_connection_model] Modelos de perna [sn_ent_strand_model] Modelos de topologia [sn_ent_network_topology_model] Tipo de dados: cadeia de caracteres
startOperatingDate	Data e hora em que o recurso começou a operar pela primeira vez. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

Tabela 28. Cabeçalhos da solicitação

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

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Local	URL do recurso criado.

Códigos de status

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

Tabela 30. Códigos de status

Código do status	Descrição
215	Solicitação recebida com sucesso para processamento. A solicitação será concluída de forma assíncrona.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
@tipo	Tipo de recurso. Valores válidos: cmdb_ci_cable (cabo) cmdb_ci_interface_card (Cartão de interface) cmdb_ci_ip_address (Endereço IP) cmdb_ci_ni_logical_path (Conexão lógica) cmdb_ci_ni_interface (Interface de rede) cmdb_ci_ni_site (local da rede) cmdb_ci_ni_ Physical_link (Conexão física) cmdb_ci_strand (cadeia) cmdb_ci_topology (Topologia) Nome de uma tabela especificada pelo sn_ni_core.equipment_tables sys_property ou nome de uma tabela que estende as tabelas especificadas. Nome de uma tabela que estende o Suporte de equipamento [cmdb_ci_equipment_holder]. Tipo de dados: cadeia de caracteres
descrição	Descrição do recurso. Tipo de dados: cadeia de caracteres
href	Link relativo para o registro do recurso. Tipo de dados: cadeia de caracteres
id	Sys_id do recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de recurso. Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cartão de interface [cmdb_ci_interface_card] Endereço IP [cmdb_ci_ip_address] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Cadeia [cmdb_ci_strand] Topologia [cmdb_ci_topology] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Tabelas secundárias que estendem qualquer uma das seguintes tabelas: Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cadeia [cmdb_ci_strand] Tipo de dados: cadeia de caracteres
nome	Nome do recurso. Tipo de dados: cadeia de caracteres
anotação	Lista de anotações sobre o recurso. Tipo de dados: matriz de objetos "note": [ { "text": "String" } ]
anotação.texto	O texto da nota. Tipo de dados: cadeia de caracteres
local	Site de rede para o recurso. Este parâmetro não é compatível com recursos de Site de rede, Conexão física ou Conexão lógica. Tipo de dados: objeto "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Tipo de local. Este valor é sempre GeographicAddress. Tipo de dados: cadeia de caracteres
local.href	Link relativo para o registro do local. Tipo de dados: cadeia de caracteres
place.id	Sys_id do registro do local. Tipo de dados: cadeia de caracteres Tabela: site de rede [cmdb_ci_ni_site]
relatedParty	Detalhes sobre contatos do recurso. Tipo de dados: matriz de objetos "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Tipo de parte relacionada. Localizado no campo Tipo. Tipo de dados: cadeia de caracteres Tabela: no campo de tipo da tabela Grupo [sys_user_group].
relatedParty.href	Link relativo ao registro de parte relacionada. Tipo de dados: cadeia de caracteres
relatedParty.id	Sys_id do registro de parte relacionada. Tipo de dados: cadeia de caracteres Tabela: Grupo [sys_user_group]
recursoCaracterística	Lista de características do recurso. Os tipos de recursos a seguir exigem características de recursos específicas. Para recursos de Conexão física e Conexão lógica, uma característica de Porta A ou Porta Z é necessária. Se o Status da fase do ciclo de vida do recurso for Em uso, a Porta A e a Porta Z serão necessárias. Para recursos de suporte de equipamento, uma característica de tipo de contêiner é necessária. Tipo de dados: matriz de objetos "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nome do campo da tabela de recursos especificada pelo parâmetro @type. Você não pode usar os campos model_id, name, network_site,operation_notes, operating_status, short_description, start_date ou quaisquer campos com prefixo sys_, como sys_id. Tipo de dados: cadeia de caracteres
recursoCaracterística.valor	O valor da característica. Tipo de dados: cadeia de caracteres
resourceCharacteristic.valueType	Tipo de valor. Valores válidos: booliano data/hora float inteiro ph_number referência Cadeia de caracteres Tipo de dados: cadeia de caracteres
relacionamento de recurso	Lista de recursos relacionados. Os seguintes tipos de recursos exigem recursos relacionados específicos. Para recursos de Cartão de interface, é necessário um relacionamento com um recurso de Suporte de equipamento em que o Tipo de contêiner é Slot ou Sub-slot. Para recursos de interface de rede, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Para recursos de suporte de equipamento em que o tipo de contêiner é Slot ou Sub-slot, é necessário um relacionamento com um recurso de equipamento ou cartão de interface. Tipo de dados: matriz "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Tipo de relacionamento entre os dois recursos no formato [este descritor de recurso]::[descritor de recurso relacionado]. Por exemplo, Contains::Contained by indica que o recurso relacionado é o secundário deste recurso. Os valores válidos para os descritores estão localizados na tabela Tipo de relacionamento de IC [cmdb_rel_type] nas colunas Descritor primário e Descritor secundário. Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso	Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso. Cabo Equipamento Suporte de equipamentos Cartão de interface Conexão lógica Interface de rede Local da Rede Conexão física Cadeia Topologia Tipo de dados: objeto "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id do recurso relacionado. Localizado em uma das tabelas a seguir, dependendo do tipo de recurso relacionado. Cartão de interface [cmdb_ci_interface_card] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o suporte de equipamento [cmdb_ci_equipment_holder] Tipo de dados: cadeia de caracteres
relacionamentorecurso.recurso.href	Link relativo ao registro de recurso relacionado. Tipo de dados: cadeia de caracteres
especificação de recurso	Especificação de recurso. Tipo de dados: objeto "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id do modelo associado ao recurso. Localizado em uma das seguintes tabelas, dependendo do tipo de modelo. Modelos de cabo [sn_ent_cable_model] Modelos de suporte de equipamento [sn_ent_nw_holder_model] Modelos de equipamento [sn_ent_nw_equipment_model] Modelos de cartão de interface [sn_ent_nw_interface_model] Modelos de conexão lógica [sn_ent_logical_nw_connection_model] Modelos de interface de rede [sn_ent_nw_interface_model] Modelos de conexão física [sn_ent_ Physical_nw_connection_model] Modelos de perna [sn_ent_strand_model] Modelos de topologia [sn_ent_network_topology_model] Tipo de dados: cadeia de caracteres
startOperatingDate	Data e hora em que o recurso começou a operar pela primeira vez. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo cria um local de rede em Denver, no estado do Colorado.

curl "https://instance.service-now.com/api/sn_ni_core/resource" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"DENVER CO CO/HUB\",
  \"note\": [
    {
      \"text\": \"Cisco maintenance team onsite June 22, 2022.\"
    }
  ],
  \"resourceCharacteristic\": [
    {
      \"name\": \"attested\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"can_print\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"clli_code\",
      \"valueType\": \"string\",
      \"value\": \"DNVRCOMR02T\"
    },
    {
      \"name\": \"comments\",
      \"valueType\": \"string\",
      \"value\": \"Site is scheduled for diesel generator test July 13, 2022 at 9am CST.\"
    },
    {
      \"name\": \"cost_cc\",
      \"valueType\": \"string\",
      \"value\": \"USD\"
    },
    {
      \"name\": \"county\",
      \"valueType\": \"string\",
      \"value\": \"DENVER\"
    },
    {
      \"name\": \"data_center_code\",
      \"valueType\": \"string\",
      \"value\": \"DNVR00564\"
    },
    {
      \"name\": \"fault_count\",
      \"valueType\": \"integer\",
      \"value\": \"0\"
    },
    {
      \"name\": \"install_status\",
      \"valueType\": \"integer\",
      \"value\": \"1\"
    },
    {
      \"name\": \"life_cycle_stage\",
      \"valueType\": \"reference\",
      \"value\": \"Operational\"
    },
    {
      \"name\": \"life_cycle_stage_status\",
      \"valueType\": \"reference\",
      \"value\": \"In Use\"
    },
    {
      \"name\": \"location\",
      \"valueType\": \"reference\",
      \"value\": \"25ab8f300a0a0bb300d99f69c3ac24cd\"
    },
    {
      \"name\": \"managed_by\",
      \"valueType\": \"reference\",
      \"value\": \"b0f31e5673500010c2e7660c4cf6a711\"
    },
    {
      \"name\": \"monitor\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"network_domain\",
      \"valueType\": \"string\",
      \"value\": \"core\"
    },
    {
      \"name\": \"ni_type\",
      \"valueType\": \"reference\",
      \"value\": \"8e8f3770404d0110f8772175cacd7204\"
    },
    {
      \"name\": \"pots_number\",
      \"valueType\": \"ph_number\",
      \"value\": \"[phone]\"
    },
    {
      \"name\": \"skip_sync\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"third_party_ownership\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"unverified\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    }
  ],
  \"resourceRelationship\": [
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"e6f6df8d4051c910f8772175cacd72b2\",
        \"href\": \"/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2\"
      }
    },
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"0ac19bc54051c910f8772175cacd724b\",
        \"href\": \"/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b\"
      }
    },
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"997e5c11875851109a9c0f65dabb35ac\",
        \"href\": \"/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"5b10e8154015c910f8772175cacd724d\",
        \"href\": \"/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"57e73b51405dc910f8772175cacd726e\",
        \"href\": \"/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"bf58f751405dc910f8772175cacd72e8\",
        \"href\": \"/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"b5711e31405d0d10f8772175cacd7232\",
        \"href\": \"/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"ed811e31405d0d10f8772175cacd72d3\",
        \"href\": \"/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"d74937d1405dc910f8772175cacd7288\",
        \"href\": \"/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"da0df2e3e4e64510f877e70ec9bcacc6\",
        \"href\": \"/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6\"
      }
    }
  ],
  \"@type\": \"cmdb_ci_ni_site\"
}" \
--user 'username':'password'

Corpo da resposta.

{
   "href": "/api/sn_ni_core/resource/00399f0aed349150f877305f29f832b2",
   "id": "00399f0aed349150f877305f29f832b2",
   "name": "DENVER CO CO/HUB",
   "note": [
      {
         "text": "Cisco maintenance team onsite June 22, 2022."
      }
   ],
   "resourceCharacteristic": [
      {
         "name": "altitude_units",
         "valueType": "string",
         "value": "feet"
      },
      {
         "name": "attestation_status",
         "valueType": "string",
         "value": "Not Yet Reviewed"
      },
      {
         "name": "attested",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "can_print",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "clli_code",
         "valueType": "string",
         "value": "DNVRCOMR02T"
      },
      {
         "name": "comments",
         "valueType": "string",
         "value": "Site is scheduled for diesel generator test July 13, 2022 at 9am CST."
      },
      {
         "name": "cost_cc",
         "valueType": "string",
         "value": "USD"
      },
      {
         "name": "county",
         "valueType": "string",
         "value": "DENVER"
      },
      {
         "name": "data_center_code",
         "valueType": "string",
         "value": "DNVR00564"
      },
      {
         "name": "discovery_source",
         "valueType": "string",
         "value": "Resource Inventory Open API"
      },
      {
         "name": "fault_count",
         "valueType": "integer",
         "value": "0"
      },
      {
         "name": "first_discovered",
         "valueType": "datetime",
         "value": "2022-07-21T19:38:04.000Z"
      },
      {
         "name": "install_status",
         "valueType": "integer",
         "value": "1"
      },
      {
         "name": "last_discovered",
         "valueType": "datetime",
         "value": "2022-07-21T19:38:04.000Z"
      },
      {
         "name": "life_cycle_stage",
         "valueType": "reference",
         "value": "Operational"
      },
      {
         "name": "life_cycle_stage_status",
         "valueType": "reference",
         "value": "In Use"
      },
      {
         "name": "location",
         "valueType": "reference",
         "value": "25ab8f300a0a0bb300d99f69c3ac24cd"
      },
      {
         "name": "managed_by",
         "valueType": "reference",
         "value": "b0f31e5673500010c2e7660c4cf6a711"
      },
      {
         "name": "monitor",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "network_domain",
         "valueType": "string",
         "value": "core"
      },
      {
         "name": "ni_type",
         "valueType": "reference",
         "value": "8e8f3770404d0110f8772175cacd7204"
      },
      {
         "name": "pots_number",
         "valueType": "ph_number",
         "value": "[phone]"
      },
      {
         "name": "skip_sync",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "third_party_ownership",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "unverified",
         "valueType": "boolean",
         "value": "false"
      }
   ],
   "resourceRelationship": [
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "e6f6df8d4051c910f8772175cacd72b2",
            "href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
         }
      },
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "0ac19bc54051c910f8772175cacd724b",
            "href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
         }
      },
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "997e5c11875851109a9c0f65dabb35ac",
            "href": "/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "5b10e8154015c910f8772175cacd724d",
            "href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "57e73b51405dc910f8772175cacd726e",
            "href": "/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "bf58f751405dc910f8772175cacd72e8",
            "href": "/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "b5711e31405d0d10f8772175cacd7232",
            "href": "/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "ed811e31405d0d10f8772175cacd72d3",
            "href": "/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "d74937d1405dc910f8772175cacd7288",
            "href": "/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "da0df2e3e4e64510f877e70ec9bcacc6",
            "href": "/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6"
         }
      }
   ],
   "@type": "cmdb_ci_ni_site"
}

API aberta do inventário de recursos - POST /sn_ni_core/resourceinventoryviatemplate

Cria um item de configuração (IC) de recursos e uma hierarquia de IC relacionada com base em um modelo.

Antes de chamar este endpoint, você deve criar um modelo de inventário na tabela Modelo de inventário [sn_ni_core_inventory_template]. Você pode definir toda a hierarquia de ICs relacionados em um modelo de inventário. Você pode criar todos os ICs e relacionamentos por meio de uma única solicitação de API.

Formato da URL

URL padrão: /api/sn_ni_core/resourceinventoryviatemplate

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
Nenhum(a)

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

Nome	Descrição
substitui	Lista de colunas a serem substituídas e os valores a serem usados. Tipo de dados: objeto "overrides": { "column_name": "String" }
substitui.nome_da_coluna	Obrigatório se o parâmetro overrides for usado. Nome e valor da coluna. Tipo de dados: cadeia de caracteres
parentId	Obrigatório. Sys_id do IC primário. Localizado em uma das tabelas a seguir, dependendo do tipo de IC primário. Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cartão de interface [cmdb_ci_interface_card] Endereço IP [cmdb_ci_ip_address] Conexão lógica [cmdb_ci_ni_logical_path] Interface de rede [cmdb_ci_ni_interface] Local da rede [cmdb_ci_ni_site] Conexão física [cmdb_ci_ni_physical_link] Cadeia [cmdb_ci_strand] Topologia [cmdb_ci_topology] Tabelas especificadas pelo sn_ni_core.equipment_tables sys_property e quaisquer tabelas que estendam as tabelas especificadas. Tabelas que estendem o Suporte de equipamento [cmdb_ci_equipment_holder]. Tabelas secundárias que estendem qualquer uma das seguintes tabelas: Cabo [cmdb_ci_cable] Suporte do equipamento [cmdb_ci_ni_equipment_holder] Cadeia [cmdb_ci_strand] Tipo de dados: cadeia de caracteres
templateId	Obrigatório. Sys_id do modelo. Tipo de dados: cadeia de caracteres Tabela: modelo de inventário [sn_ni_core_inventory_template]
templateOverrides	Lista de substituições de modelo. Tipo de dados: matriz de objetos "templateOverrides": [ { "overrideTemplateId": "String", "templateId": "String" } ]
templateOverrides.overrideTemplateId	Obrigatório se o parâmetro templateOverrides for usado. sys_id de modelo disponível. Tipo de dados: cadeia de caracteres
templateOverrides.templateId	Obrigatório se o parâmetro templateOverrides for usado. sys_id do modelo relacionado. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

Tabela 34. Cabeçalhos da solicitação

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

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Local	URL do IC criado na parte superior da hierarquia.

Códigos de status

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

Tabela 36. Códigos de status

Código do status	Descrição
201	Recurso criado.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
500	Erro. Ocorreu um erro na solicitação. Por exemplo, a solicitação falhou nas verificações de validação.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
resultado	Objeto de resultado com informações sobre os ICs criados. Tipo de dados: objeto "result": { "sys_id": "String" }
resultado.sys_id	Sys_id do IC criado na parte superior da hierarquia. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo cria uma hierarquia de IC usando um modelo.

curl "https://instance.service-now.com/api/sn_ni_core/resourceinventoryviatemplate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "templateId": "90475711ed6ec110f877d2f57b8accda",
   "parentId": "917dd8f6870e851079c40f2d0ebb353d",
   "overrides": {
      "equipment_clli": "test"
   },
   "templateOverrides": [
      {
         "templateId": "ac3b679ded6ec110f877d2f57b8acc29",
         "overrideTemplateId": "f9604efb54e18110f87749bbc4ad38d8"
      },
      {
         "templateId": "171c23dded6ec110f877d2f57b8acc33",
         "overrideTemplateId": "0f38e59187424110e14f64e73cbb35b4"
      }
   ]
}" \
--user 'username':'password'

Corpo da resposta.

"result": {
   "sys_id": "00598f0aed346259f388105f29f892c4"
}