API de inventário de recursos em aberto

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 35 min. de leitura
  • . Inventário de recursos aberto A API 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]
    • Strand [cmdb_ci_strand]
    • Topologia [cmdb_ci_topology]
    • Tabelas especificadas pelo sn_ni_core.equipment_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do 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]
      • Strand [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 sn_ni_core namespace.

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

    Esta API pode ser estendida para fazer personalizações em relação aos parâmetros necessários, solicitar validação de corpo e mapeamentos de campo. Para obter mais informações, consulte o .

    . Inventário de recursos aberto A API é um ServiceNow® Implementação da especificação REST da API de inventário de recursos do Fórum TM. Esta implementação é baseada no TMF639 Resource Inventory API User Guide v4.0.1 Julho de 2020.

    API em aberto de inventário de recursos - EXCLUA /sn_ni_core/resource/

    Exclui um registro de recurso especificado.

    Formato de URL

    URL padrão: /api/sn_ni_core/resource/

    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 tabelas a seguir, 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_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do 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. 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
    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 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
    215 Solicitação recebida com sucesso para processamento. A solicitação será concluída de forma assíncrona.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. Falha na exclusão do recurso. O recurso pode ser exigido por 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 de inventário de recursos - OBTER /sn_ni_core/resource

    Recupera uma lista de todos os registros de recursos.

    Formato de 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
    . 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 (Site de rede)
    • cmdb_ci_ni_physical_link (Conexão física)
    • cmdb_ci_strand (Linha)
    • cmdb_ci_topology (Topologia)
    • Nome de uma tabela especificada pelo sn_ni_core.equipment_tablessys_property ou nome de uma tabela que estende as tabelas especificadas.
    • Nome de uma tabela que estende o suporte do 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
    • nota
    • lugar
    • RelatedParty
    • ResourceCharacterística
    • ResourceRelationship
    • ResourceSpecification
    • 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 offsetparâmetro para paginar a recuperação de 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 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.

    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. 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 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 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.
    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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    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 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 (Site de rede)
    • cmdb_ci_ni_physical_link (Conexão física)
    • cmdb_ci_strand (Linha)
    • cmdb_ci_topology (Topologia)
    • Nome de uma tabela especificada pelo sn_ni_core.equipment_tablessys_property ou nome de uma tabela que estende as tabelas especificadas.
    • Nome de uma tabela que estende o suporte do 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 de recurso.

    Tipo de dados: Cadeia de caracteres

    id Sys_id do recurso. Localizado em uma das tabelas a seguir, 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]
    • Strand [cmdb_ci_strand]
    • Topologia [cmdb_ci_topology]
    • Tabelas especificadas pelo sn_ni_core.equipment_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do 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]
      • Strand [cmdb_ci_strand]

    Tipo de dados: Cadeia de caracteres

    nome
    Nome do recurso.

    Tipo de dados: Cadeia de caracteres

    nota Lista de anotações sobre o recurso.

    Tipo de dados: Matriz de objetos

    "note": [
       {
          "text": "String"
       }
    ]
    note.text
    O texto da anotação.

    Tipo de dados: Cadeia de caracteres

    lugar
    Site de rede do 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"
    }
    ReferredType Tipo de local. Este valor é sempre GeographicAddress .

    Tipo de dados: Cadeia de caracteres

    place.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
    RelatedParty. Em referredType Tipo de parte relacionada. Localizado no em Tipo campo.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de tipo da tabela Grupo [sys_user_group].

    RelatedParty.href Link relativo para o registro da parte relacionada.

    Tipo de dados: Cadeia de caracteres

    relatedParty.id
    Sys_id do registro da 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].

    ResourceCharacterística Lista de características do recurso. Os seguintes tipos de recursos exigem características de recurso específicas.
    • Para recursos de Conexão física e Conexão lógica, um Porta A. ou Porta Z a característica é obrigatória. Se o status da fase do ciclo de vida do recurso estiver Em uso, ambos Porta A. e. Porta Z são obrigatórios.
    • Para recursos do suporte de equipamento, um Tipo de contêiner a característica é obrigató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 @typeparâmetro. Não é possível usar os campos model_id, name, network_site, operation_notes, operational_status, short_description, start_date ou quaisquer campos prefixados sys_, como sys_id.

    Tipo de dados: Cadeia de caracteres

    ResourceCharacteristic.value
    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

    ResourceRelationship 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 titular 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 equipamento ou recurso de 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 equipamento ou recurso de cartão de interface.

    Tipo de dados: Matriz

    "resourceRelationship": [
      {
        "relationshipType": "String",
        "resource": {Object}
      }
    ]
    ResourceRelationship.Relationship Type
    Tipo de relacionamento entre os dois recursos no formato : [este descritor de recurso]:::[descritor de recurso relacionado] . Por exemplo, Contém::Contido por 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] em Descritor primário e. Descritor secundário colunas.

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource
    Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso.
    • Cabo
    • Equipamento
    • Suporte de equipamento
    • Cartão de interface
    • Conexão lógica
    • Interface de rede
    • Site da rede
    • Conexão física
    • Perna
    • 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_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do equipamento [cmdb_ci_equipment_holder]

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource.href Link relativo para o registro de recurso relacionado.

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Especificação de recurso.

    Tipo de dados: Objeto

    "resourceSpecification": {
       "id": "String"
    }
    ResourceSpecification.id
    Sys_id do modelo associado ao recurso. Localizado em uma das tabelas a seguir, 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 cadeia [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 o. name, ide hrefCampos para os primeiros cinco registros de recursos do Site da 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 de inventário de recursos - OBTER /sn_ni_core/resource/

    Recupera um registro de recurso especificado.

    Formato de URL

    URL padrão: /api/sn_ni_core/resource/

    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 tabelas a seguir, 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]
    • Strand [cmdb_ci_strand]
    • Topologia [cmdb_ci_topology]
    • Tabelas especificadas pelo sn_ni_core.equipment_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do 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]
      • Strand [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
    • nota
    • lugar
    • RelatedParty
    • ResourceCharacterística
    • ResourceRelationship
    • ResourceSpecification
    • StartOperatingDate

    Tipo de dados: Cadeia de caracteres

    Padrão: Retorna todos os campos.

    Tabela 15. 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 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    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 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 (Site de rede)
    • cmdb_ci_ni_physical_link (Conexão física)
    • cmdb_ci_strand (Linha)
    • cmdb_ci_topology (Topologia)
    • Nome de uma tabela especificada pelo sn_ni_core.equipment_tablessys_property ou nome de uma tabela que estende as tabelas especificadas.
    • Nome de uma tabela que estende o suporte do 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 de recurso.

    Tipo de dados: Cadeia de caracteres

    id Sys_id do recurso. Localizado em uma das tabelas a seguir, 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]
    • Strand [cmdb_ci_strand]
    • Topologia [cmdb_ci_topology]
    • Tabelas especificadas pelo sn_ni_core.equipment_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do 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]
      • Strand [cmdb_ci_strand]

    Tipo de dados: Cadeia de caracteres

    nome
    Nome do recurso.

    Tipo de dados: Cadeia de caracteres

    nota Lista de anotações sobre o recurso.

    Tipo de dados: Matriz de objetos

    "note": [
       {
          "text": "String"
       }
    ]
    note.text
    O texto da anotação.

    Tipo de dados: Cadeia de caracteres

    lugar
    Site de rede do 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"
    }
    ReferredType Tipo de local. Este valor é sempre GeographicAddress .

    Tipo de dados: Cadeia de caracteres

    place.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
    RelatedParty. Em referredType Tipo de parte relacionada. Localizado no em Tipo campo.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de tipo da tabela Grupo [sys_user_group].

    RelatedParty.href Link relativo para o registro da parte relacionada.

    Tipo de dados: Cadeia de caracteres

    relatedParty.id
    Sys_id do registro da parte relacionada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo [sys_user_group]

    ResourceCharacterística Lista de características do recurso. Os seguintes tipos de recursos exigem características de recurso específicas.
    • Para recursos de Conexão física e Conexão lógica, um Porta A. ou Porta Z a característica é obrigatória. Se o status da fase do ciclo de vida do recurso estiver Em uso, ambos Porta A. e. Porta Z são obrigatórios.
    • Para recursos do suporte de equipamento, um Tipo de contêiner a característica é obrigató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 @typeparâmetro. Não é possível usar os campos model_id, name, network_site, operation_notes, operational_status, short_description, start_date ou quaisquer campos prefixados sys_, como sys_id.

    Tipo de dados: Cadeia de caracteres

    ResourceCharacteristic.value
    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

    ResourceRelationship 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 titular 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 equipamento ou recurso de 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 equipamento ou recurso de cartão de interface.

    Tipo de dados: Matriz

    "resourceRelationship": [
      {
        "relationshipType": "String",
        "resource": {Object}
      }
    ]
    ResourceRelationship.Relationship Type
    Tipo de relacionamento entre os dois recursos no formato : [este descritor de recurso]:::[descritor de recurso relacionado] . Por exemplo, Contém::Contido por 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] em Descritor primário e. Descritor secundário colunas.

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource
    Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso.
    • Cabo
    • Equipamento
    • Suporte de equipamento
    • Cartão de interface
    • Conexão lógica
    • Interface de rede
    • Site da rede
    • Conexão física
    • Perna
    • 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_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do equipamento [cmdb_ci_equipment_holder]

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource.href Link relativo para o registro de recurso relacionado.

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Especificação de recurso.

    Tipo de dados: Objeto

    "resourceSpecification": {
       "id": "String"
    }
    resourceSpecification.id
    Sys_id do modelo associado ao recurso. Localizado em uma das tabelas a seguir, 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 cadeia [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 de inventário de recursos - POST /sn_ni_core/resource

    Cria um registro de recurso.

    Formato de URL

    URL padrão: /api/sn_ni_core/resource

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    . 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 (Site de rede)
    • cmdb_ci_ni_physical_link (Conexão física)
    • cmdb_ci_strand (Linha)
    • cmdb_ci_topology (Topologia)
    • Nome de uma tabela especificada pelo sn_ni_core.equipment_tablessys_property ou nome de uma tabela que estende as tabelas especificadas.
    • Nome de uma tabela que estende o suporte do 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

    nota Lista de anotações sobre o recurso.

    Tipo de dados: Matriz de objetos

    "note": [
       {
          "text": "String"
       }
    ]
    note.text Necessário se noteo parâmetro é usado.
    O texto da anotação.

    Tipo de dados: Cadeia de caracteres

    lugar Necessário para recursos do suporte de equipamento em que o tipo de contêiner é gaiola, compartimento, gabinete, rack, alinhamento, ou Pacote de modelo de inventário. Necessário para todos os recursos de equipamento.
    Site de rede do 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"
    }
    ReferredType Tipo de local. Este valor é sempre GeographicAddress .

    Tipo de dados: Cadeia de caracteres

    place.href Link relativo para o registro do local.

    Tipo de dados: Cadeia de caracteres

    place.id Necessário se placeo parâmetro é 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. Em referredType Tipo de parte relacionada. Localizado no em Tipo campo.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de tipo da tabela Grupo [sys_user_group].

    RelatedParty.href Link relativo para o registro da parte relacionada.

    Tipo de dados: Cadeia de caracteres

    relatedParty.id Necessário se relatedPartyo parâmetro é usado.
    Sys_id do registro da parte relacionada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo [sys_user_group]

    ResourceCharacterística Lista de características do recurso. Os seguintes tipos de recursos exigem características de recurso específicas.
    • Para recursos de Conexão física e Conexão lógica, um Porta A. ou Porta Z a característica é obrigatória. Se o status da fase do ciclo de vida do recurso estiver Em uso, ambos Porta A. e. Porta Z são obrigatórios.
    • Para recursos do suporte de equipamento, um Tipo de contêiner a característica é obrigatória.

    Tipo de dados: Matriz de objetos

    "resourceCharacteristic": [
       {
          "name": "String",
          "value": "String",
          "valueType": "String"
       }
    ]
    resourceCharacteristic.name Necessário se resourceCharacteristico parâmetro é usado.
    Nome do campo da tabela de recursos especificada pelo @typeparâmetro. Não é possível usar os campos model_id, name, network_site, operation_notes, operational_status, short_description, start_date ou quaisquer campos prefixados sys_, como sys_id.

    Tipo de dados: Cadeia de caracteres

    ResourceCharacteristic.value Necessário se resourceCharacteristico parâmetro é 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

    ResourceRelationship 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 titular 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 equipamento ou recurso de 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 equipamento ou recurso de cartão de interface.

    Tipo de dados: Matriz

    "resourceRelationship": [
      {
        "relationshipType": "String",
        "resource": {Object}
      }
    ]
    ResourceRelationship.Relationship Type Necessário se resourceRelationshipo parâmetro é usado.
    Tipo de relacionamento entre os dois recursos no formato : [este descritor de recurso]:::[descritor de recurso relacionado] . Por exemplo, Contém::Contido por 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] em Descritor primário e. Descritor secundário colunas.

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource Necessário se resourceRelationshipo parâmetro é usado.
    Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso.
    • Cabo
    • Equipamento
    • Suporte de equipamento
    • Cartão de interface
    • Conexão lógica
    • Interface de rede
    • Site da rede
    • Conexão física
    • Perna
    • Topologia

    Tipo de dados: Objeto

    "resource": {
       "id": "String",
       "href": "String"
    }
    resourceRelationship.resource.id Necessário se resourceRelationshipo parâmetro é 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_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do equipamento [cmdb_ci_equipment_holder]

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource.href Link relativo para o registro de recurso relacionado.

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Especificação de recurso.

    Tipo de dados: Objeto

    "resourceSpecification": {
       "id": "String"
    }
    resourceSpecification.id Necessário se resourceSpecificationo parâmetro é usado.
    Sys_id do modelo associado ao recurso. Localizado em uma das tabelas a seguir, 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 cadeia [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/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.
    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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 24. 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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    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 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 (Site de rede)
    • cmdb_ci_ni_physical_link (Conexão física)
    • cmdb_ci_strand (Linha)
    • cmdb_ci_topology (Topologia)
    • Nome de uma tabela especificada pelo sn_ni_core.equipment_tablessys_property ou nome de uma tabela que estende as tabelas especificadas.
    • Nome de uma tabela que estende o suporte do 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 de recurso.

    Tipo de dados: Cadeia de caracteres

    id Sys_id do recurso. Localizado em uma das tabelas a seguir, 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]
    • Strand [cmdb_ci_strand]
    • Topologia [cmdb_ci_topology]
    • Tabelas especificadas pelo sn_ni_core.equipment_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do 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]
      • Strand [cmdb_ci_strand]

    Tipo de dados: Cadeia de caracteres

    nome
    Nome do recurso.

    Tipo de dados: Cadeia de caracteres

    nota Lista de anotações sobre o recurso.

    Tipo de dados: Matriz de objetos

    "note": [
       {
          "text": "String"
       }
    ]
    note.text
    O texto da anotação.

    Tipo de dados: Cadeia de caracteres

    lugar
    Site de rede do 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"
    }
    ReferredType Tipo de local. Este valor é sempre GeographicAddress .

    Tipo de dados: Cadeia de caracteres

    place.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. Em referredType Tipo de parte relacionada. Localizado no em Tipo campo.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo de tipo da tabela Grupo [sys_user_group].

    RelatedParty.href Link relativo para o registro da parte relacionada.

    Tipo de dados: Cadeia de caracteres

    relatedParty.id
    Sys_id do registro da parte relacionada.

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo [sys_user_group]

    ResourceCharacterística Lista de características do recurso. Os seguintes tipos de recursos exigem características de recurso específicas.
    • Para recursos de Conexão física e Conexão lógica, um Porta A. ou Porta Z a característica é obrigatória. Se o status da fase do ciclo de vida do recurso estiver Em uso, ambos Porta A. e. Porta Z são obrigatórios.
    • Para recursos do suporte de equipamento, um Tipo de contêiner a característica é obrigató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 @typeparâmetro. Não é possível usar os campos model_id, name, network_site, operation_notes, operational_status, short_description, start_date ou quaisquer campos prefixados sys_, como sys_id.

    Tipo de dados: Cadeia de caracteres

    ResourceCharacteristic.value
    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

    ResourceRelationship 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 titular 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 equipamento ou recurso de 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 equipamento ou recurso de cartão de interface.

    Tipo de dados: Matriz

    "resourceRelationship": [
      {
        "relationshipType": "String",
        "resource": {Object}
      }
    ]
    ResourceRelationship.Relationship Type
    Tipo de relacionamento entre os dois recursos no formato : [este descritor de recurso]:::[descritor de recurso relacionado] . Por exemplo, Contém::Contido por 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] em Descritor primário e. Descritor secundário colunas.

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource
    Detalhes sobre o recurso relacionado. O recurso relacionado deve ser um dos seguintes tipos de recurso.
    • Cabo
    • Equipamento
    • Suporte de equipamento
    • Cartão de interface
    • Conexão lógica
    • Interface de rede
    • Site da rede
    • Conexão física
    • Perna
    • 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_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do equipamento [cmdb_ci_equipment_holder]

    Tipo de dados: Cadeia de caracteres

    ResourceRelationship.resource.href Link relativo para o registro de recurso relacionado.

    Tipo de dados: Cadeia de caracteres

    ResourceSpecification Especificação de recurso.

    Tipo de dados: Objeto

    "resourceSpecification": {
       "id": "String"
    }
    resourceSpecification.id
    Sys_id do modelo associado ao recurso. Localizado em uma das tabelas a seguir, 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 cadeia [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 site de rede em Denver, 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\": \"(214) 555-1234\"
        },
        {
          \"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": "(214) 555-1234"
          },
          {
             "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 de inventário de recursos em aberto - POST /sn_ni_core/resourceinventoryviatemmodelo

    Cria um item de configuração de recurso (IC) 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. Em seguida, você pode criar todos os ICs e relacionamentos por meio de uma única solicitação de API.

    Formato de URL

    URL padrão: /api/sn_ni_core/resourceinventoryviatemplate

    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. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    substituições Lista de colunas a serem substituídas e os valores a serem usados.

    Tipo de dados: Objeto

    "overrides": {
      "column_name": "String"
    }
    substituições.column_name Necessário se overrideso parâmetro é 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]
    • Strand [cmdb_ci_strand]
    • Topologia [cmdb_ci_topology]
    • Tabelas especificadas pelo sn_ni_core.equipment_tablessys_property e todas as tabelas que estendem as tabelas especificadas.
    • Tabelas que estendem o suporte do 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]
      • Strand [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 Necessário se templateOverrideso parâmetro é usado. Sys_id do modelo disponível.

    Tipo de dados: Cadeia de caracteres

    TemplateOverrides.templateId Necessário se templateOverrideso parâmetro é 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 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 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 30. Códigos de status
    Código do status Descrição
    201 Recurso criado.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro. Ocorreu um erro com a 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"
    }
    sys_id.result.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"
    }