API de identificação e reconciliação

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 102 min. de leitura
  • . Identificação e reconciliação A API fornece endpoints que usam o mecanismo de Identificação e reconciliação (IRE) para minimizar a criação de itens de configuração duplicados (ICs) e reconciliar atributos de IC aceitando somente informações de fontes autorizadas ao atualizar o. Configuration Management Database (CMDB).

    Os usuários devem ter a função itil ou de ativo para usar esta API.

    Para obter mais informações sobre o IRE, consulte Mecanismo de identificação e reconciliação (IRE) .

    Identificação e reconciliação - POST /now/identifyreconciliar

    Insere ou atualiza itens de configuração (ICs) no CMDB aplicando regras de identificação e reconciliação à carga especificada (corpo da solicitação). Use esta API em vez de atualizar o. CMDB diretamente.

    Use Identificação e reconciliação - POST /now/identifyreconciliar/query endpoint para simular o envio de uma carga para este endpoint sem confirmar mudanças no banco de dados.

    Use Identificação e reconciliação - POST /now/identifyreconciliar/enhanced Em vez disso, o endpoint se você precisar especificar opções de IRE aprimorado. Para obter mais informações sobre as opções de IRE aprimorado, consulte Mecanismo de identificação e reconciliação (IRE) .

    Formato de URL

    URL com controle de versão: /api/now/api_version/identifyreconciliar

    URL padrão: /api/now/identifyreconciliar

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres

    Tabela 2. Parâmetros de consulta
    Nome Descrição
    sysparm_data_source Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    Padrão: Insira a carga da API na tabela Cargas incompletas.

    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    itens Lista de ICs a serem criados ou atualizados.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.classname Obrigatório. O sys_class_name (nome da classe/tabela) do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB tabela, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: Cadeia de caracteres

    items.internal_id Identificador exclusivo deste item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup Matriz de objetos em que cada objeto descreve um registro de identificação baseado em pesquisa. Esses registros são usados para identificar o item de configuração de nível superior com base em uma tabela de pesquisa que tem uma referência à tabela Item de configuração [cmdb_ci].

    Tipo de dados: Objetos de matriz desativados

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.lookup.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB classe/tabela, como cmdb_serial_number ou cmdb_ci_network_adapter, ou um CMDB classe de hierarquia.

    Tipo de dados: Cadeia de caracteres

    items.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.lookup.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    valores.pesquisa.itens Objeto que descreve campos para este item de pesquisa como pares de nome/valor, em que o nome é o nome do campo.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    itens.relacionado Matriz de objetos em que cada objeto descreve um registro de item a ser criado ou atualizado, com base em uma tabela relacionada que tem uma referência ao IC de nível superior que está sendo identificado. As regras na tabela Entrada relacionada [cmdb_related_entry] definem que tipo de registros podem estar nesta matriz.

    A tabela relacionada pode ou não estender a tabela Item de configuração [cmdb_ci]. Esses registros não são usados para identificar o item de configuração.

    Tipo de dados: Matriz de objetos

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.related.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do item relacionado a ser criado ou atualizado.

    Tipo de dados: Cadeia de caracteres

    items.related.internal_id Identificador exclusivo para este item relacionado nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.related.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este item relacionado. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_name Fonte de dados para as informações do item relacionado. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.related.sys_object_source_info.source_native_key ID/chave exclusiva da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o item relacionado foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.related.values Objeto que descreve campos a serem criados ou atualizados para este item relacionado como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings Objeto que contém parâmetros que definem os tipos de atualizações permitidos.

    Tipo de dados: Objeto

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules Sinalizador que indica se o IRE deve ignorar a execução da regra de restrição de reclassificação que corresponde à classe do item de carga útil.
    Valores válidos:
    • Verdadeiro: Ignore a execução da regra.
    • Falso: Execute a regra.

    Padrão: falso

    items.settings.updateWithoutDowngrade Sinalizador que indica se atualização e downgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o downgrade não é permitido.
    • Atualização e downgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutSwitch Sinalizador que indica se este IC pode ser atualizado e sua classe alternada.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas a alternância de classe não é permitida.
    • Atualização de item e alternância de classe são permitidas.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutUpgrade Sinalizador que indica se atualização e upgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o upgrade não é permitido.
    • Atualização e upgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    itens.sys_object_source_info Objeto que descreve um identificador de IC exclusivo.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.valores Objeto que descreve campos a serem criados ou atualizados para este IC como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    ReferênciItems Lista de referência entre dois itens na carga. Os valores de cada item de referência são preenchidos antes de identificar um IC usando as regras de IRE definidas em uma classe.

    Tipo de dados: Matriz de objetos

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    ReferênciaItems.referenciado . internal_iddefinido para o item que está sendo referenciado por outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referencedBy . internal_iddefinido para o item que faz referência a outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referceField Nome do campo de referência na classe/tabela do referencedByitem.

    Tipo de dados: Cadeia de caracteres

    relações Lista de relacionamentos entre dois itens definidos na carga.
    Um objeto nesta matriz pode usar um dos dois formatos:
    • O objeto pode definir um relacionamento entre dois itens de nível superior (somente) usando parente. childpares nome-valor, com valores que representam índices de item da carga itemsmatriz.
    • O objeto pode definir um relacionamento entre quaisquer dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_ide. child_idpares de chave/valor, com valores representando internal_idvalores definidos para esses itens.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child Índice inteiro do objeto de IC no itemsmatriz que representa o secundário no relacionamento.

    Tipo de dados: Número

    relations.child_id . internal_iddo item secundário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.parent Índice inteiro do objeto de IC no itemsmatriz que representa o primário no relacionamento.

    Tipo de dados: Número

    relations.parent_id . internal_iddo item primário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.sys_rel_source_info Informações de origem da Descoberta para o relacionamento. Para relacionamentos sem dependência, essas informações estão na tabela Origens de relacionamento [sys_rel_source].

    Tipo de dados: Objeto

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name Nome da origem da Descoberta.

    Padrão: Origem da descoberta passada no parâmetro Método de API.

    relations.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "DESCONHECIDO" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.

    relations.type Tipo de relacionamento existente entre os itens primário e secundário. Deve ser um valor de campo de nome da tabela Tipo de relacionamento de IC [cmdb_rel_type].

    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 4. 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 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

    Nome Descrição
    resultado Lista de resultados produzidos pela consulta.

    Tipo de dados: Matriz

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    Result.ItemoCommittedAditionalCommittedItems Lista de ICs não incluídos no corpo da solicitação itemsmatriz a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    Result.additionalCommittedItems.Classname O sys_class_name deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.AditionalCommittedItems.Contagem de erros Número de erros encontrados ao processar este IC adicional.

    Tipo de dados: Número

    Erros.Result.ItemsCommittedItems.adicionais Lista de erros encontrados ao processar este IC adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    Result.additionalCommittedItems.errors.error Tipo de erro encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.errors.message Mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttents Lista de tentativas feitas para identificar este IC adicional.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    AdditionalCommittedItems.IdentificationAttempts.attemptResult Resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttributes.Attributes Matriz de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.IdentifierName Regra de identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.IdentyfierEntrySysId Sys_id para a regra de identificador usada para identificar este IC adicional.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC adicional.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    Marcadores.ResultadosItemsCommittedItems.adicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    AdditionalCommittedItems.mergedPayloads Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Result.ItemsCommittedItems.adicionalCommittedItems.Operation Operação realizada para este IC adicional.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC adicional é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC adicional.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.SYSID Sys_id encontrado para este IC adicional por meio de identificação.

    Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    ItemsCommittedItems.additionalCommittedItems.warnings Lista de avisos encontrados durante o processamento deste IC adicional.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedItems.warnings.error Tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.warnings.message Mensagem de aviso encontrada durante o processamento deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedRelations Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relationslista a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    AdditionalCommittedRelations.Classname O sys_class_name deste IC de relacionamento dependente adicional.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    RelacionaçõesCommittedRelacionadosadicionais.Contagem de erros Número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Número

    RelacionadosCommittedRelacionadosadicionais.Erros Lista de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedRelacionamentos.Erros.ERROR Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    Result.RelacionadosCommittedRelacionamentos.Erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedRelations.inputIndices Lista de valores de índice para objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    Marcadores.ResultadosRelacionadosCommittedRelacionadosadicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.RelacionadosCommittedRelacionamentos.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Relacionamentos.RelacionadosCommittedRelacionadosadicionais Operação realizada para este IC de relacionamento dependente adicional.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente é inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação é realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: Cadeia de caracteres

    result.items Lista de ICs incluídos no corpo da solicitação itemsmatriz.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: Matriz de objetos

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.additionalRelatedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsmatriz que corresponde a este item relacionado.

    Tipo de dados: Matriz

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId Sys_id deste IC relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.className Sys_class_name deste IC.

    Tipo de dados: Cadeia de caracteres

    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para items.lookupElementos de matriz que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento do corpo da solicitação items.lookupMatriz que faz referência a um determinado IC relacionado. Seus valores são o conjunto de elementos adicionais da mesma matriz que fazem referência ao mesmo IC relacionado.

    Tipo de dados: Objeto

    Este exemplo mostra um caso em que o segundo elemento no items.lookupA matriz faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount Número de erros encontrados ao processar este IC.

    Tipo de dados: Número

    result.items.errors Lista de erros encontrados ao processar este IC.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error Tipo de erro encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.errors.message Mensagem de erro encontrada ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts Lista de tentativas feitas para identificar este IC.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult Resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.attributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName Regra de identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identifierEntrySysId Sys_id para a regra de identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Para obter detalhes, consulte errors.

    Tipo de dados: Cadeia de caracteres

    result.items.info Lista de informações adicionais sobre o processamento do item.

    Tipo de dados: Matriz de objetos

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code Tipo de reclassificação ignorado.
    Valores possíveis:
    • IGNORADO_CLASS_SWITCH
    • IGNORADO_CLASS_DOWNGRADE
    • IGNORADO_CLASS_UPGRADE
    result.items.info.message Mensagem que fornece informações adicionais sobre o motivo para ignorar a reclassificação.

    Tipo de dados: Cadeia de caracteres

    result.items.info.ruleSysId Sys_id da regra de restrição de reclassificação que foi correspondida. Aplicável somente quando o IRE ignora a reclassificação devido à regra de restrição de reclassificação. Este valor ficará vazio se a reclassificação for ignorada devido a uma carga útil ou sinalizador global.

    Tipo de dados: Cadeia de caracteres

    result.items.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation Operação realizada para este IC.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems Lista de ICs relacionados (IC de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz de objetos

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems.inputIndices Lista de valores de índice para ICs e itens de pesquisa do corpo da solicitação itemse. items.lookupmatrizes que correspondem a este item relacionado.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex Valor de índice do corpo da solicitação itemsMatriz que corresponde ao IC primário do item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.inputIndices.subIndex Valor de índice do corpo da solicitação items.lookupmatriz que corresponde ao item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.relatedItems.mergedPayloadIds Lista de valores sys_id para entradas na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds Lista de valores sys_id para itens relacionados (itens de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz

    Valores notáveis:
    • Nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId Sys_id encontrado para este IC por meio de identificação.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings Lista de avisos encontrados durante o processamento deste IC.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error Tipo de aviso encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings.message Mensagem de aviso encontrada durante o processamento deste IC.

    Tipo de dados: Cadeia de caracteres

    Result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: Cadeia de caracteres

    resultado.relações Lista de ICs de relacionamento dependente do corpo da solicitação relationsmatriz.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    Result.relations.classname O sys_class_name deste IC de relacionamento dependente.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    Relations.errorCount.Result.relations Número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Número

    resultados.relações.erros Lista de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error Tipo de erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    resultado.relações.erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    result.relations.inputIndices Lista de valores de índice para os objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    relations.markers.result Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.relations.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    resultado.relações.operação Operação realizada para este IC de relacionamento dependente.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente foi inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação foi realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino foi atualizado.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.result Lista de avisos encontrados durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error Tipo de aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.message Mensagem de aviso encontrada durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Envie uma carga contendo um servidor Linux (com pesquisas de item relacionado ao número de série e ao adaptador de rede) e um comutador IP, com um relacionamento dependente de Conexão IP entre eles.

    curl "https://instance.servicenow.com/api/now/identifyreconcile" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username:password" \
    --data '{ \
      "items": [{ \
        "className": "cmdb_ci_linux_server", \
        "values": { \
          "sys_class_name": "cmdb_ci_linux_server", \
          "name": "lnux101", \
          "host_name": "lnux101.servicenow.com", \
          "ip_address": "10.11.12.173", \
          "os_name": "Linux Red Hat" \
        }, \
        "lookup": [{ \
          "className": "cmdb_serial_number", \
          "values": { \
            "serial_number": "lnux101", \
            "serial_number_type": "uuid", \
            "valid": "true" \
          } \
        }, { \
          "className": "cmdb_ci_network_adapter", \
          "values": { \
            "name": "eth0", \
            "ip_address": "10.11.12.173", \
            "mac_address": "00:55:51:21:26:2f" \
          } \
        }] \
      }, { \
        "className": "cmdb_ci_ip_switch", \
        "values": { \
          "name": "IP-Switch-1", \
          "serial_number": "Switch23587", \
          "serial_number_type": "uuid" \
        } \
      }], \
      "relations": [{ \
        "parent": 0, \
        "child": 1, \
        "type": "IP Connection::IP Connection" \
      }]
    }'

    O IC do servidor Linux é identificado por meio de uma pesquisa de Regra de Hardware para seu nome na tabela Hardware [cmdb_ci_hardware] e é processado como uma atualização de um IC existente na tabela Servidor Linux [cmdb_ci_linux_server]. O comutador IP é identificado de forma semelhante por meio de uma pesquisa de Regra de Hardware para obter seu nome na tabela Hardware e atualiza um IC existente na tabela Comutador de IP [cmdb_ci_ip_switch]. Por fim, o relacionamento dependente de Conexão IP entre o servidor e o comutador é inserido como um novo registro na tabela Relacionamento de IC [cmdb_rel_ci].

    {
      "result": {
        "items": [{
          "className": "cmdb_ci_linux_server",
          "operation": "UPDATE",
          "sysId": "539747cac0a801640163e60735fbbf6e",
          "relatedSysIds": [null, null],
          "relatedItems": [{
            "markers": [],
            "inputIndices": [{
              "mainIndex": 0,
              "subIndex": 0
            }],
            "mergedPayloadIds": [],
            "className": "cmdb_serial_number"
          }, {
            "markers": [],
            "inputIndices": [{
              "mainIndex": 0,
              "subIndex": 1
            }],
            "mergedPayloadIds": [],
            "className": "cmdb_ci_network_adapter"
          }],
          "additionalRelatedItems": [],
          "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
          "identificationAttempts": [{
            "identifierName": "Hardware Rule",
            "attemptResult": "NO_MATCH",
            "attributes": ["serial_number", "serial_number_type"],
            "searchOnTable": "cmdb_serial_number",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "MATCHED",
            "attributes": ["name"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }],
          "markers": [],
          "inputIndices": [0],
          "mergedPayloadIds": [],
          "errorCount": 0
        }, {
          "className": "cmdb_ci_ip_switch",
          "operation": "UPDATE",
          "sysId": "304481257f701200bee45f19befa915b",
          "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
          "identificationAttempts": [{
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number", "serial_number_type"],
            "searchOnTable": "cmdb_serial_number",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "NO_MATCH",
            "attributes": ["serial_number"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "MATCHED",
            "attributes": ["name"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }],
          "markers": [],
          "inputIndices": [1],
          "mergedPayloadIds": [],
          "errorCount": 0
        }],
        "additionalCommittedItems": [],
        "relations": [{
          "className": "cmdb_rel_ci",
          "operation": "INSERT",
          "markers": [],
          "inputIndices": [0],
          "mergedPayloadIds": [],
          "errorCount": 0
        }],
        "additionalCommittedRelations": []
      }
    }

    Identificação e reconciliação - POST /now/identifyreconciliar/enhanced

    Insere ou atualiza itens de configuração (ICs) no CMDB aplicando regras de identificação e reconciliação à carga especificada (corpo da solicitação). Use esta API em vez de atualizar o. CMDB diretamente.

    Use Identificação e reconciliação - POST /now/identifyreconciliar/queryEnhanced endpoint para simular o envio de uma carga para este endpoint sem confirmar mudanças no banco de dados.

    Este método é semelhante ao Identificação e reconciliação - POST /now/identifyreconciliar, mas adiciona a seguinte funcionalidade:
    • Cargas parciais
      • Em caso de um item ter um aviso ou erro, indica se uma operação de item é INSERT_AS_PARTIAL ou INSERT_INCOMPLETE.
      • Retorna os sys_ids de cargas parciais que foram mescladas com cargas parciais existentes.
    • Oferece suporte ao recurso de desduplicação de carga.
    • Gera um resumo.

    Formato de URL

    URL com controle de versão: /api/now/

    URL padrão: /api/now/identifyreconciliar/enhanced

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres

    Tabela 8. Parâmetros de consulta
    Nome Descrição
    opções Lista separada por vírgulas de pares de nome e valor que representam as opções de IRE aprimorado aplicadas à solicitação.

    Como exemplo, para substituir os valores padrão das cargas parciais, confirmações parciais, desduplicar cargas úteis e gerar resumo das opções de IRE aprimorado:

    partial_payloads:false,partial_commits:false,deduplicate_payloads:false,generate_summary:true
    Nota:
    Por padrão ou se partial_payloadsdefinido como verdadeiro, ambos partial_commitse. deduplicate_payloadsestão habilitados, mesmo se estiverem definidos como falsos, pois esses recursos são essenciais para a funcionalidade de cargas parciais.

    Para obter mais informações sobre as opções de IRE aprimorado, consulte Mecanismo de identificação e reconciliação (IRE) .

    Valores válidos para cada par nome-valor:
    • Verdadeiro: Habilite esta opção de IRE aprimorado.
    • Falso: Desabilite esta opção de IRE aprimorado.

    Tipo de dados: Cadeia de caracteres

    sysparm_data_source Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    Padrão: Insira a carga da API na tabela Cargas incompletas.

    Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    itens Lista de ICs a serem criados ou atualizados.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.classname Obrigatório. O sys_class_name (nome da classe/tabela) do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB tabela, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: Cadeia de caracteres

    items.internal_id Identificador exclusivo deste item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup Matriz de objetos em que cada objeto descreve um registro de identificação baseado em pesquisa. Esses registros são usados para identificar o item de configuração de nível superior com base em uma tabela de pesquisa que tem uma referência à tabela Item de configuração [cmdb_ci].

    Tipo de dados: Objetos de matriz desativados

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.lookup.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB classe/tabela, como cmdb_serial_number ou cmdb_ci_network_adapter, ou um CMDB classe de hierarquia.

    Tipo de dados: Cadeia de caracteres

    items.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.lookup.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    valores.pesquisa.itens Objeto que descreve campos para este item de pesquisa como pares de nome/valor, em que o nome é o nome do campo.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    itens.relacionado Matriz de objetos em que cada objeto descreve um registro de item a ser criado ou atualizado, com base em uma tabela relacionada que tem uma referência ao IC de nível superior que está sendo identificado. As regras na tabela Entrada relacionada [cmdb_related_entry] definem que tipo de registros podem estar nesta matriz.

    A tabela relacionada pode ou não estender a tabela Item de configuração [cmdb_ci]. Esses registros não são usados para identificar o item de configuração.

    Tipo de dados: Matriz de objetos

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.related.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do item relacionado a ser criado ou atualizado.

    Tipo de dados: Cadeia de caracteres

    items.related.internal_id Identificador exclusivo para este item relacionado nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.related.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este item relacionado. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_name Fonte de dados para as informações do item relacionado. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.related.sys_object_source_info.source_native_key ID/chave exclusiva da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o item relacionado foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.related.values Objeto que descreve campos a serem criados ou atualizados para este item relacionado como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings Objeto que contém parâmetros que definem os tipos de atualizações permitidos.

    Tipo de dados: Objeto

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules Sinalizador que indica se o IRE deve ignorar a execução da regra de restrição de reclassificação que corresponde à classe do item de carga útil.
    Valores válidos:
    • Verdadeiro: Ignore a execução da regra.
    • Falso: Execute a regra.

    Padrão: falso

    items.settings.updateWithoutDowngrade Sinalizador que indica se atualização e downgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o downgrade não é permitido.
    • Atualização e downgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutSwitch Sinalizador que indica se este IC pode ser atualizado e sua classe alternada.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas a alternância de classe não é permitida.
    • Atualização de item e alternância de classe são permitidas.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutUpgrade Sinalizador que indica se atualização e upgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o upgrade não é permitido.
    • Atualização e upgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    itens.sys_object_source_info Objeto que descreve um identificador de IC exclusivo.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.valores Objeto que descreve campos a serem criados ou atualizados para este IC como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    ReferênciItems Lista de referência entre dois itens na carga. Os valores de cada item de referência são preenchidos antes de identificar um IC usando as regras de IRE definidas em uma classe.

    Tipo de dados: Matriz de objetos

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    ReferênciaItems.referenciado . internal_iddefinido para o item que está sendo referenciado por outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referencedBy . internal_iddefinido para o item que faz referência a outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referceField Nome do campo de referência na classe/tabela do referencedByitem.

    Tipo de dados: Cadeia de caracteres

    relações Lista de relacionamentos entre dois itens definidos na carga.
    Um objeto nesta matriz pode usar um dos dois formatos:
    • O objeto pode definir um relacionamento entre dois itens de nível superior (somente) usando parente. childpares nome-valor, com valores que representam índices de item da carga itemsmatriz.
    • O objeto pode definir um relacionamento entre quaisquer dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_ide. child_idpares de chave/valor, com valores representando internal_idvalores definidos para esses itens.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child Índice inteiro do objeto de IC no itemsmatriz que representa o secundário no relacionamento.

    Tipo de dados: Número

    relations.child_id . internal_iddo item secundário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.parent Índice inteiro do objeto de IC no itemsmatriz que representa o primário no relacionamento.

    Tipo de dados: Número

    relations.parent_id . internal_iddo item primário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.sys_rel_source_info Informações de origem da Descoberta para o relacionamento. Para relacionamentos sem dependência, essas informações estão na tabela Origens de relacionamento [sys_rel_source].

    Tipo de dados: Objeto

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name Nome da origem da Descoberta.

    Padrão: Origem da descoberta passada no parâmetro Método de API.

    relations.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "DESCONHECIDO" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.

    relations.type Tipo de relacionamento existente entre os itens primário e secundário. Deve ser um valor de campo de nome da tabela Tipo de relacionamento de IC [cmdb_rel_type].

    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 10. 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 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte 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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação.

    Detalhe da mensagem de erro "Bloco [...] não é uma entrada válida" indica que optionso parâmetro de consulta não está no formato de par nome-valor correto.

    Por exemplo, especificar um optionsparâmetro de parcial Produz um código de status 500 com "Bloco [parcial] não é uma entrada válida" no detalhe da mensagem.

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

    Nome Descrição
    resultado Lista de resultados produzidos pela consulta.

    Tipo de dados: Matriz

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    Result.ItemoCommittedAditionalCommittedItems Lista de ICs não incluídos no corpo da solicitação itemsmatriz a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    Result.additionalCommittedItems.Classname O sys_class_name deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.AditionalCommittedItems.Contagem de erros Número de erros encontrados ao processar este IC adicional.

    Tipo de dados: Número

    Erros.Result.ItemsCommittedItems.adicionais Lista de erros encontrados ao processar este IC adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    Result.additionalCommittedItems.errors.error Tipo de erro encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.errors.message Mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttents Lista de tentativas feitas para identificar este IC adicional.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    AdditionalCommittedItems.IdentificationAttempts.attemptResult Resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttributes.Attributes Matriz de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.IdentifierName Regra de identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.IdentyfierEntrySysId Sys_id para a regra de identificador usada para identificar este IC adicional.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC adicional.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    Marcadores.ResultadosItemsCommittedItems.adicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    AdditionalCommittedItems.mergedPayloads Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Result.ItemsCommittedItems.adicionalCommittedItems.Operation Operação realizada para este IC adicional.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC adicional é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC adicional.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.SYSID Sys_id encontrado para este IC adicional por meio de identificação.

    Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    ItemsCommittedItems.additionalCommittedItems.warnings Lista de avisos encontrados durante o processamento deste IC adicional.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedItems.warnings.error Tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.warnings.message Mensagem de aviso encontrada durante o processamento deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedRelations Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relationslista a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    AdditionalCommittedRelations.Classname O sys_class_name deste IC de relacionamento dependente adicional.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    RelacionaçõesCommittedRelacionadosadicionais.Contagem de erros Número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Número

    RelacionadosCommittedRelacionadosadicionais.Erros Lista de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedRelacionamentos.Erros.ERROR Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    Result.RelacionadosCommittedRelacionamentos.Erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedRelations.inputIndices Lista de valores de índice para objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    Marcadores.ResultadosRelacionadosCommittedRelacionadosadicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.RelacionadosCommittedRelacionamentos.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Relacionamentos.RelacionadosCommittedRelacionadosadicionais Operação realizada para este IC de relacionamento dependente adicional.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente é inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação é realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: Cadeia de caracteres

    result.items Lista de ICs incluídos no corpo da solicitação itemsmatriz.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: Matriz de objetos

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.additionalRelatedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsmatriz que corresponde a este item relacionado.

    Tipo de dados: Matriz

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId Sys_id deste IC relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.className Sys_class_name deste IC.

    Tipo de dados: Cadeia de caracteres

    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para items.lookupElementos de matriz que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento do corpo da solicitação items.lookupMatriz que faz referência a um determinado IC relacionado. Seus valores são o conjunto de elementos adicionais da mesma matriz que fazem referência ao mesmo IC relacionado.

    Tipo de dados: Objeto

    Este exemplo mostra um caso em que o segundo elemento no items.lookupA matriz faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount Número de erros encontrados ao processar este IC.

    Tipo de dados: Número

    result.items.errors Lista de erros encontrados ao processar este IC.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error Tipo de erro encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.errors.message Mensagem de erro encontrada ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts Lista de tentativas feitas para identificar este IC.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult Resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.attributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName Regra de identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identifierEntrySysId Sys_id para a regra de identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Para obter detalhes, consulte errors.

    Tipo de dados: Cadeia de caracteres

    result.items.info Lista de informações adicionais sobre o processamento do item.

    Tipo de dados: Matriz de objetos

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code Tipo de reclassificação ignorado.
    Valores possíveis:
    • IGNORADO_CLASS_SWITCH
    • IGNORADO_CLASS_DOWNGRADE
    • IGNORADO_CLASS_UPGRADE
    result.items.info.message Mensagem que fornece informações adicionais sobre o motivo para ignorar a reclassificação.

    Tipo de dados: Cadeia de caracteres

    result.items.info.ruleSysId Sys_id da regra de restrição de reclassificação que foi correspondida. Aplicável somente quando o IRE ignora a reclassificação devido à regra de restrição de reclassificação. Este valor ficará vazio se a reclassificação for ignorada devido a uma carga útil ou sinalizador global.

    Tipo de dados: Cadeia de caracteres

    result.items.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation Operação realizada para este IC.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems Lista de ICs relacionados (IC de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz de objetos

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems.inputIndices Lista de valores de índice para ICs e itens de pesquisa do corpo da solicitação itemse. items.lookupmatrizes que correspondem a este item relacionado.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex Valor de índice do corpo da solicitação itemsMatriz que corresponde ao IC primário do item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.inputIndices.subIndex Valor de índice do corpo da solicitação items.lookupmatriz que corresponde ao item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.relatedItems.mergedPayloadIds Lista de valores sys_id para entradas na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds Lista de valores sys_id para itens relacionados (itens de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz

    Valores notáveis:
    • Nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId Sys_id encontrado para este IC por meio de identificação.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings Lista de avisos encontrados durante o processamento deste IC.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error Tipo de aviso encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings.message Mensagem de aviso encontrada durante o processamento deste IC.

    Tipo de dados: Cadeia de caracteres

    Result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: Cadeia de caracteres

    resultado.relações Lista de ICs de relacionamento dependente do corpo da solicitação relationsmatriz.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    Result.relations.classname O sys_class_name deste IC de relacionamento dependente.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    Relations.errorCount.Result.relations Número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Número

    resultados.relações.erros Lista de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error Tipo de erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    resultado.relações.erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    result.relations.inputIndices Lista de valores de índice para os objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    relations.markers.result Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.relations.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    resultado.relações.operação Operação realizada para este IC de relacionamento dependente.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente foi inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação foi realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino foi atualizado.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.result Lista de avisos encontrados durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error Tipo de aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.message Mensagem de aviso encontrada durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Envie uma carga parcial para um IC de computador.

    curl "https://instance.servicenow.com/api/now/identifyreconcile/enhanced" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
      "items" : [ \
        { \
          "className" : "cmdb_ci_computer", \
          "sys_object_source_info" : { \
            "source_name" : "ServiceNow", \
            "source_native_key" : "ncomputer3367" \
          }, \
          "values" : { \
            "cpu_core_count" : "6", \
            "ram" : "8192", \
            "manufacturer" : "DELL", \
            "company" : "My Company" \
          } \
        } \
      ] \
    }'

    A resposta mostra que a carga foi inserida na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    {
      "result": {
        "items": [{
          "className": "cmdb_ci_computer",
          "operation": "INSERT_AS_PARTIAL",
          "sysId": "Unknown",
          "partialSysIds": ["1aec79151bb45010593876a61a4bcb28"],
          "identifierEntrySysId": "Unknown",
          "errors": [],
          "warnings": [{
            "error": "MISSING_MATCHING_ATTRIBUTES",
            "message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'"
          }],
          "identificationAttempts": [{
            "info": "sys_object_source NO_MATCH",
            "identifierName": "",
            "attemptResult": "NO_MATCH",
            "attributes": [],
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number", "serial_number_type"],
            "searchOnTable": "cmdb_serial_number",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["name"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["mac_address", "name"],
            "searchOnTable": "cmdb_ci_network_adapter",
            "hybridEntryCiAttributes": []
          }],
          "errorCount": 0,
          "markers": [],
          "warningCount": 1,
          "mergedPayloadIds": ["7ddcb9551bb45010593876a61a4bcb08"],
          "inputIndices": [0]
        }],
        "additionalCommittedItems": [],
        "relations": [],
        "additionalCommittedRelations": []
      }
    }

    Envie uma segunda carga parcial que conclua a descrição do IC do computador, com a opção IRE aprimorada de geração de resumo habilitada.

    curl "https://instance.servicenow.com/api/now/identifyreconcile/enhanced?options=generate_summary:true" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
    }'

    A resposta mostra que o IC do computador está inserido e exibe um resumo das operações realizadas.

    {
      "result": {
        "relations": [],
        "hasError": false,
        "additionalCommittedItems": [],
        "hasWarning": false,
        "items": [
          {
            "relatedSysIds": [
              "735c79151bb45010593876a61a4bcb67"
            ],
            "identifierEntrySysId": "Unknown",
            "sysId": "ff5c79151bb45010593876a61a4bcb64",
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_computer",
            "inputIndices": [
              0
            ],
            "operation": "INSERT",
            "relatedItems": [
              {
                "operation": "INSERT",
                "warningCount": 0,
                "errors": [],
                "sysId": "735c79151bb45010593876a61a4bcb67",
                "className": "cmdb_ci_network_adapter",
                "errorCount": 0,
                "markers": [],
                "inputIndices": [
                  {
                    "subIndex": 0,
                    "mainIndex": 0
                  }
                ],
                "mergedPayloadIds": []
              }
            ],
            "mergedPayloadIds": [
              "fe4c39151bb45010593876a61a4bcbd3"
            ],
            "identificationAttempts": [
              {
                "info": "sys_object_source NO_MATCH",
                "attemptResult": "NO_MATCH",
                "identifierName": "",
                "attributes": [],
                "hybridEntryCiAttributes": []
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "mac_address",
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_network_adapter"
              }
            ],
            "warningCount": 0
          }
        ],
        "additionalCommittedRelations": [],
        "summary": {
          "cmdb_ci_network_adapter": {
            "mergedPartialPayloads": 0,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          },
          "cmdb_ci_computer": {
            "mergedPartialPayloads": 1,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          }
        }
      }
    }

    Identificação e reconciliação - POST /now/identifyreconciliar/query

    Determina o. CMDB operação (inserir/atualizar) a ser executada com a carga especificada (corpo da solicitação), sem confirmar as operações no banco de dados.

    Use este endpoint para simular o envio de uma carga (corpo da solicitação) para Identificação e reconciliação - POST /now/identifyreconciliar endpoint.

    Use Identificação e reconciliação - POST /now/identifyreconciliar/enhanced Em vez disso, o endpoint se você precisar especificar opções de IRE aprimorado. Para obter mais informações sobre as opções de IRE aprimorado, consulte Mecanismo de identificação e reconciliação (IRE) .

    Formato de URL

    URL com controle de versão: /api/now/

    URL padrão: /api/now/identifyreconciliar/query

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres

    Tabela 14. Parâmetros de consulta
    Nome Descrição
    sysparm_data_source Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    Padrão: Insira a carga da API na tabela Cargas incompletas.

    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    itens Lista de ICs a serem criados ou atualizados.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.classname Obrigatório. O sys_class_name (nome da classe/tabela) do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB tabela, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: Cadeia de caracteres

    items.internal_id Identificador exclusivo deste item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup Matriz de objetos em que cada objeto descreve um registro de identificação baseado em pesquisa. Esses registros são usados para identificar o item de configuração de nível superior com base em uma tabela de pesquisa que tem uma referência à tabela Item de configuração [cmdb_ci].

    Tipo de dados: Objetos de matriz desativados

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.lookup.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB classe/tabela, como cmdb_serial_number ou cmdb_ci_network_adapter, ou um CMDB classe de hierarquia.

    Tipo de dados: Cadeia de caracteres

    items.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.lookup.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    valores.pesquisa.itens Objeto que descreve campos para este item de pesquisa como pares de nome/valor, em que o nome é o nome do campo.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    itens.relacionado Matriz de objetos em que cada objeto descreve um registro de item a ser criado ou atualizado, com base em uma tabela relacionada que tem uma referência ao IC de nível superior que está sendo identificado. As regras na tabela Entrada relacionada [cmdb_related_entry] definem que tipo de registros podem estar nesta matriz.

    A tabela relacionada pode ou não estender a tabela Item de configuração [cmdb_ci]. Esses registros não são usados para identificar o item de configuração.

    Tipo de dados: Matriz de objetos

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.related.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do item relacionado a ser criado ou atualizado.

    Tipo de dados: Cadeia de caracteres

    items.related.internal_id Identificador exclusivo para este item relacionado nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.related.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este item relacionado. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_name Fonte de dados para as informações do item relacionado. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.related.sys_object_source_info.source_native_key ID/chave exclusiva da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o item relacionado foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.related.values Objeto que descreve campos a serem criados ou atualizados para este item relacionado como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings Objeto que contém parâmetros que definem os tipos de atualizações permitidos.

    Tipo de dados: Objeto

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules Sinalizador que indica se o IRE deve ignorar a execução da regra de restrição de reclassificação que corresponde à classe do item de carga útil.
    Valores válidos:
    • Verdadeiro: Ignore a execução da regra.
    • Falso: Execute a regra.

    Padrão: falso

    items.settings.updateWithoutDowngrade Sinalizador que indica se atualização e downgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o downgrade não é permitido.
    • Atualização e downgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutSwitch Sinalizador que indica se este IC pode ser atualizado e sua classe alternada.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas a alternância de classe não é permitida.
    • Atualização de item e alternância de classe são permitidas.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutUpgrade Sinalizador que indica se atualização e upgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o upgrade não é permitido.
    • Atualização e upgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    itens.sys_object_source_info Objeto que descreve um identificador de IC exclusivo.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.valores Objeto que descreve campos a serem criados ou atualizados para este IC como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    ReferênciItems Lista de referência entre dois itens na carga. Os valores de cada item de referência são preenchidos antes de identificar um IC usando as regras de IRE definidas em uma classe.

    Tipo de dados: Matriz de objetos

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    ReferênciaItems.referenciado . internal_iddefinido para o item que está sendo referenciado por outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referencedBy . internal_iddefinido para o item que faz referência a outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referceField Nome do campo de referência na classe/tabela do referencedByitem.

    Tipo de dados: Cadeia de caracteres

    relações Lista de relacionamentos entre dois itens definidos na carga.
    Um objeto nesta matriz pode usar um dos dois formatos:
    • O objeto pode definir um relacionamento entre dois itens de nível superior (somente) usando parente. childpares nome-valor, com valores que representam índices de item da carga itemsmatriz.
    • O objeto pode definir um relacionamento entre quaisquer dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_ide. child_idpares de chave/valor, com valores representando internal_idvalores definidos para esses itens.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child Índice inteiro do objeto de IC no itemsmatriz que representa o secundário no relacionamento.

    Tipo de dados: Número

    relations.child_id . internal_iddo item secundário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.parent Índice inteiro do objeto de IC no itemsmatriz que representa o primário no relacionamento.

    Tipo de dados: Número

    relations.parent_id . internal_iddo item primário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.sys_rel_source_info Informações de origem da Descoberta para o relacionamento. Para relacionamentos sem dependência, essas informações estão na tabela Origens de relacionamento [sys_rel_source].

    Tipo de dados: Objeto

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name Nome da origem da Descoberta.

    Padrão: Origem da descoberta passada no parâmetro Método de API.

    relations.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "DESCONHECIDO" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.

    relations.type Tipo de relacionamento existente entre os itens primário e secundário. Deve ser um valor de campo de nome da tabela Tipo de relacionamento de IC [cmdb_rel_type].

    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 16. 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 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte 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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

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

    Nome Descrição
    resultado Lista de resultados produzidos pela consulta.

    Tipo de dados: Matriz

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    Result.ItemoCommittedAditionalCommittedItems Lista de ICs não incluídos no corpo da solicitação itemsmatriz a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    Result.additionalCommittedItems.Classname O sys_class_name deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.AditionalCommittedItems.Contagem de erros Número de erros encontrados ao processar este IC adicional.

    Tipo de dados: Número

    Erros.Result.ItemsCommittedItems.adicionais Lista de erros encontrados ao processar este IC adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    Result.additionalCommittedItems.errors.error Tipo de erro encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.errors.message Mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttents Lista de tentativas feitas para identificar este IC adicional.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    AdditionalCommittedItems.IdentificationAttempts.attemptResult Resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttributes.Attributes Matriz de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.IdentifierName Regra de identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.IdentyfierEntrySysId Sys_id para a regra de identificador usada para identificar este IC adicional.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC adicional.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    Marcadores.ResultadosItemsCommittedItems.adicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    AdditionalCommittedItems.mergedPayloads Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Result.ItemsCommittedItems.adicionalCommittedItems.Operation Operação realizada para este IC adicional.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC adicional é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC adicional.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.SYSID Sys_id encontrado para este IC adicional por meio de identificação.

    Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    ItemsCommittedItems.additionalCommittedItems.warnings Lista de avisos encontrados durante o processamento deste IC adicional.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedItems.warnings.error Tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.warnings.message Mensagem de aviso encontrada durante o processamento deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedRelations Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relationslista a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    AdditionalCommittedRelations.Classname O sys_class_name deste IC de relacionamento dependente adicional.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    RelacionaçõesCommittedRelacionadosadicionais.Contagem de erros Número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Número

    RelacionadosCommittedRelacionadosadicionais.Erros Lista de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedRelacionamentos.Erros.ERROR Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    Result.RelacionadosCommittedRelacionamentos.Erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedRelations.inputIndices Lista de valores de índice para objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    Marcadores.ResultadosRelacionadosCommittedRelacionadosadicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.RelacionadosCommittedRelacionamentos.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Relacionamentos.RelacionadosCommittedRelacionadosadicionais Operação realizada para este IC de relacionamento dependente adicional.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente é inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação é realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: Cadeia de caracteres

    result.items Lista de ICs incluídos no corpo da solicitação itemsmatriz.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: Matriz de objetos

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.additionalRelatedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsmatriz que corresponde a este item relacionado.

    Tipo de dados: Matriz

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId Sys_id deste IC relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.className Sys_class_name deste IC.

    Tipo de dados: Cadeia de caracteres

    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para items.lookupElementos de matriz que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento do corpo da solicitação items.lookupMatriz que faz referência a um determinado IC relacionado. Seus valores são o conjunto de elementos adicionais da mesma matriz que fazem referência ao mesmo IC relacionado.

    Tipo de dados: Objeto

    Este exemplo mostra um caso em que o segundo elemento no items.lookupA matriz faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount Número de erros encontrados ao processar este IC.

    Tipo de dados: Número

    result.items.errors Lista de erros encontrados ao processar este IC.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error Tipo de erro encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.errors.message Mensagem de erro encontrada ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts Lista de tentativas feitas para identificar este IC.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult Resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.attributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName Regra de identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identifierEntrySysId Sys_id para a regra de identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Para obter detalhes, consulte errors.

    Tipo de dados: Cadeia de caracteres

    result.items.info Lista de informações adicionais sobre o processamento do item.

    Tipo de dados: Matriz de objetos

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code Tipo de reclassificação ignorado.
    Valores possíveis:
    • IGNORADO_CLASS_SWITCH
    • IGNORADO_CLASS_DOWNGRADE
    • IGNORADO_CLASS_UPGRADE
    result.items.info.message Mensagem que fornece informações adicionais sobre o motivo para ignorar a reclassificação.

    Tipo de dados: Cadeia de caracteres

    result.items.info.ruleSysId Sys_id da regra de restrição de reclassificação que foi correspondida. Aplicável somente quando o IRE ignora a reclassificação devido à regra de restrição de reclassificação. Este valor ficará vazio se a reclassificação for ignorada devido a uma carga útil ou sinalizador global.

    Tipo de dados: Cadeia de caracteres

    result.items.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation Operação realizada para este IC.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems Lista de ICs relacionados (IC de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz de objetos

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems.inputIndices Lista de valores de índice para ICs e itens de pesquisa do corpo da solicitação itemse. items.lookupmatrizes que correspondem a este item relacionado.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex Valor de índice do corpo da solicitação itemsMatriz que corresponde ao IC primário do item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.inputIndices.subIndex Valor de índice do corpo da solicitação items.lookupmatriz que corresponde ao item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.relatedItems.mergedPayloadIds Lista de valores sys_id para entradas na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds Lista de valores sys_id para itens relacionados (itens de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz

    Valores notáveis:
    • Nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId Sys_id encontrado para este IC por meio de identificação.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings Lista de avisos encontrados durante o processamento deste IC.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error Tipo de aviso encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings.message Mensagem de aviso encontrada durante o processamento deste IC.

    Tipo de dados: Cadeia de caracteres

    Result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: Cadeia de caracteres

    resultado.relações Lista de ICs de relacionamento dependente do corpo da solicitação relationsmatriz.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    Result.relations.classname O sys_class_name deste IC de relacionamento dependente.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    Relations.errorCount.Result.relations Número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Número

    resultados.relações.erros Lista de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error Tipo de erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    resultado.relações.erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    result.relations.inputIndices Lista de valores de índice para os objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    relations.markers.result Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.relations.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    resultado.relações.operação Operação realizada para este IC de relacionamento dependente.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente foi inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação foi realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino foi atualizado.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.result Lista de avisos encontrados durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error Tipo de aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.message Mensagem de aviso encontrada durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Simule o envio de uma carga que contém um servidor Linux (com pesquisas de item relacionado ao número de série e ao adaptador de rede) e um comutador IP, com um relacionamento de conexão IP entre eles.

    curl "https://instance.servicenow.com/api/now/identifyreconcile/query" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
      "items": [{ \
        "className": "cmdb_ci_linux_server", \
        "values": { \
          "sys_class_name": "cmdb_ci_linux_server", \
          "name": "lnux101", \
          "host_name": "lnux101.servicenow.com", \
          "ip_address": "10.11.12.173", \
          "os_name": "Linux Red Hat" \
        }, \
        "lookup": [{ \
          "className": "cmdb_serial_number", \
          "values": { \
            "serial_number": "lnux101", \
            "serial_number_type": "uuid", \
            "valid": "true" \
          } \
        }, { \
          "className": "cmdb_ci_network_adapter", \
          "values": { \
            "name": "eth0", \
            "ip_address": "10.11.12.173", \
            "mac_address": "00:55:51:21:26:2f" \
          } \
        }] \
      }, { \
        "className": "cmdb_ci_ip_switch", \
        "values": { \
          "name": "IP-Switch-1", \
          "serial_number": "Switch23587", \
          "serial_number_type": "uuid" \
        } \
      }], \
      "relations": [{ \
        "parent": 0, \
        "child": 1, \
        "type": "IP Connection::IP Connection" \
      }] \
    }'

    O IC do servidor Linux é identificado por meio de uma pesquisa de Regra de Hardware para seu nome na tabela Hardware [cmdb_ci_hardware] e é processado como uma atualização de um IC existente na tabela Servidor Linux [cmdb_ci_linux_server]. O comutador IP é identificado de forma semelhante por meio de uma pesquisa de Regra de Hardware para obter seu nome na tabela Hardware e atualiza um IC existente na tabela Comutador de IP [cmdb_ci_ip_switch]. Por fim, o relacionamento de conexão IP entre o servidor e o comutador é inserido como um novo registro na tabela Relacionamento de IC [cmdb_rel_ci].

    {
      "result": {
        "relations": [
          {
            "operation": "INSERT",
            "mergedPayloadIds": [],
            "className": "cmdb_rel_ci",
            "errorCount": 0,
            "markers": [],
            "inputIndices": [
              0
            ]
          }
        ],
        "items": [
          {
            "relatedSysIds": [
              null,
              null
            ],
            "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
            "sysId": "539747cac0a801640163e60735fbbf6e",
            "errorCount": 0,
            "markers": [],
            "identificationAttempts": [
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "MATCHED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              }
            ],
            "inputIndices": [
              0
            ],
            "additionalRelatedItems": [],
            "operation": "UPDATE",
            "relatedItems": [
              {
                "markers": [],
                "mergedPayloadIds": [],
                "inputIndices": [
                  {
                    "subIndex": 0,
                    "mainIndex": 0
                  }
                ],
                "className": "cmdb_serial_number"
              },
              {
                "markers": [],
                "mergedPayloadIds": [],
                "inputIndices": [
                  {
                    "subIndex": 1,
                    "mainIndex": 0
                  }
                ],
                "className": "cmdb_ci_network_adapter"
              }
            ],
            "mergedPayloadIds": [],
            "className": "cmdb_ci_linux_server"
          },
          {
            "operation": "UPDATE",
            "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
            "mergedPayloadIds": [],
            "sysId": "304481257f701200bee45f19befa915b",
            "identificationAttempts": [
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "MATCHED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              }
            ],
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_ip_switch",
            "inputIndices": [
              1
            ]
          }
        ],
        "additionalCommittedRelations": [],
        "additionalCommittedItems": []
      }
    }

    Identificação e reconciliação - POST /now/identifyreconciliar/queryEnhanced

    Determina o. CMDB operação (inserir/atualizar) a ser executada com a carga especificada (corpo da solicitação), sem confirmar as operações no banco de dados.

    Use este endpoint para simular o envio de uma carga (corpo da solicitação) para Identificação e reconciliação - POST /now/identifyreconciliar/enhanced endpoint.

    Este método é semelhante ao Identificação e reconciliação - POST /now/identifyreconciliar/query, mas adiciona a seguinte funcionalidade:
    • Cargas parciais
      • Em caso de um item ter um aviso ou erro, indica se uma operação de item é INSERT_AS_PARTIAL ou INSERT_INCOMPLETE.
      • Retorna os sys_ids de cargas parciais que foram mescladas com cargas parciais existentes.
    • Oferece suporte ao recurso de desduplicação de carga.
    • Gera um resumo.

    Formato de URL

    URL com controle de versão: /api/now/

    URL padrão: /api/now/identifyreconciliar/queryEnhanced

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres

    Tabela 20. Parâmetros de consulta
    Nome Descrição
    opções Lista separada por vírgulas de pares de nome e valor que representam as opções de IRE aprimorado aplicadas à solicitação.

    Como exemplo, para substituir os valores padrão das cargas parciais, confirmações parciais, desduplicar cargas úteis e gerar resumo das opções de IRE aprimorado:

    partial_payloads:false,partial_commits:false,deduplicate_payloads:false,generate_summary:true
    Nota:
    Por padrão ou se partial_payloadsdefinido como verdadeiro, ambos partial_commitse. deduplicate_payloadsestão habilitados, mesmo se estiverem definidos como falsos, pois esses recursos são essenciais para a funcionalidade de cargas parciais.

    Para obter mais informações sobre as opções de IRE aprimorado, consulte Mecanismo de identificação e reconciliação (IRE) .

    Valores válidos para cada par nome-valor:
    • Verdadeiro: Habilite esta opção de IRE aprimorado.
    • Falso: Desabilite esta opção de IRE aprimorado.

    Tipo de dados: Cadeia de caracteres

    sysparm_data_source Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    Padrão: Insira a carga da API na tabela Cargas incompletas.

    Tabela 21. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    itens Lista de ICs a serem criados ou atualizados.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.classname Obrigatório. O sys_class_name (nome da classe/tabela) do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB tabela, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: Cadeia de caracteres

    items.internal_id Identificador exclusivo deste item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup Matriz de objetos em que cada objeto descreve um registro de identificação baseado em pesquisa. Esses registros são usados para identificar o item de configuração de nível superior com base em uma tabela de pesquisa que tem uma referência à tabela Item de configuração [cmdb_ci].

    Tipo de dados: Objetos de matriz desativados

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.lookup.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do IC a ser criado ou atualizado. Este valor pode ser qualquer um CMDB classe/tabela, como cmdb_serial_number ou cmdb_ci_network_adapter, ou um CMDB classe de hierarquia.

    Tipo de dados: Cadeia de caracteres

    items.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.lookup.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.lookup.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    itens.lookup.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    valores.pesquisa.itens Objeto que descreve campos para este item de pesquisa como pares de nome/valor, em que o nome é o nome do campo.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    itens.relacionado Matriz de objetos em que cada objeto descreve um registro de item a ser criado ou atualizado, com base em uma tabela relacionada que tem uma referência ao IC de nível superior que está sendo identificado. As regras na tabela Entrada relacionada [cmdb_related_entry] definem que tipo de registros podem estar nesta matriz.

    A tabela relacionada pode ou não estender a tabela Item de configuração [cmdb_ci]. Esses registros não são usados para identificar o item de configuração.

    Tipo de dados: Matriz de objetos

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    Items.related.classname Obrigatório. O sys_class_name ou o nome da classe/tabela do item relacionado a ser criado ou atualizado.

    Tipo de dados: Cadeia de caracteres

    items.related.internal_id Identificador exclusivo para este item relacionado nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info Objeto que descreve um identificador de IC exclusivo para uma fonte de dados especificada. Origens diferentes podem ter pares de nome-valor diferentes para o mesmo IC.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.related.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este item relacionado. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_name Fonte de dados para as informações do item relacionado. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.related.sys_object_source_info.source_native_key ID/chave exclusiva da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.related.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o item relacionado foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.related.values Objeto que descreve campos a serem criados ou atualizados para este item relacionado como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings Objeto que contém parâmetros que definem os tipos de atualizações permitidos.

    Tipo de dados: Objeto

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules Sinalizador que indica se o IRE deve ignorar a execução da regra de restrição de reclassificação que corresponde à classe do item de carga útil.
    Valores válidos:
    • Verdadeiro: Ignore a execução da regra.
    • Falso: Execute a regra.

    Padrão: falso

    items.settings.updateWithoutDowngrade Sinalizador que indica se atualização e downgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o downgrade não é permitido.
    • Atualização e downgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutSwitch Sinalizador que indica se este IC pode ser atualizado e sua classe alternada.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas a alternância de classe não é permitida.
    • Atualização de item e alternância de classe são permitidas.

    Tipo de dados: Booliano

    Padrão: falso

    items.settings.updateWithoutUpgrade Sinalizador que indica se atualização e upgrade são permitidos para este IC.
    Valores válidos:
    • Verdadeiro: Atualize o item, mas o upgrade não é permitido.
    • Atualização e upgrade do item são permitidos.

    Tipo de dados: Booliano

    Padrão: falso

    itens.sys_object_source_info Objeto que descreve um identificador de IC exclusivo.

    Tipo de dados: Objeto

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    itens.sys_object_source_info.source_feed Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_name Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres

    itens.sys_object_source_info.source_native_key Chave/ID exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item.

    Tipo de dados: Cadeia de caracteres

    items.sys_object_source_info.source_recency_timestamp Data e hora UTC em que o IC foi verificado.

    Tipo de dados: Cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss

    itens.valores Objeto que descreve campos a serem criados ou atualizados para este IC como pares de nome/valor, em que o nome é o nome do campo. Para um campo de referência, o valor deve ser o sys_id referenciado.

    Tipo de dados: Objeto

    Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como:

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    ReferênciItems Lista de referência entre dois itens na carga. Os valores de cada item de referência são preenchidos antes de identificar um IC usando as regras de IRE definidas em uma classe.

    Tipo de dados: Matriz de objetos

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    ReferênciaItems.referenciado . internal_iddefinido para o item que está sendo referenciado por outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referencedBy . internal_iddefinido para o item que faz referência a outro item.

    Tipo de dados: Cadeia de caracteres

    ReferceItems.referceField Nome do campo de referência na classe/tabela do referencedByitem.

    Tipo de dados: Cadeia de caracteres

    relações Lista de relacionamentos entre dois itens definidos na carga.
    Um objeto nesta matriz pode usar um dos dois formatos:
    • O objeto pode definir um relacionamento entre dois itens de nível superior (somente) usando parente. childpares nome-valor, com valores que representam índices de item da carga itemsmatriz.
    • O objeto pode definir um relacionamento entre quaisquer dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_ide. child_idpares de chave/valor, com valores representando internal_idvalores definidos para esses itens.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child Índice inteiro do objeto de IC no itemsmatriz que representa o secundário no relacionamento.

    Tipo de dados: Número

    relations.child_id . internal_iddo item secundário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.parent Índice inteiro do objeto de IC no itemsmatriz que representa o primário no relacionamento.

    Tipo de dados: Número

    relations.parent_id . internal_iddo item primário no relacionamento.

    Tipo de dados: Cadeia de caracteres

    relations.sys_rel_source_info Informações de origem da Descoberta para o relacionamento. Para relacionamentos sem dependência, essas informações estão na tabela Origens de relacionamento [sys_rel_source].

    Tipo de dados: Objeto

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name Nome da origem da Descoberta.

    Padrão: Origem da descoberta passada no parâmetro Método de API.

    relations.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "DESCONHECIDO" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.

    relations.type Tipo de relacionamento existente entre os itens primário e secundário. Deve ser um valor de campo de nome da tabela Tipo de relacionamento de IC [cmdb_rel_type].

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

    Códigos de status

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

    Tabela 24. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação.

    Detalhe da mensagem de erro "Bloco [...] não é uma entrada válida" indica que optionso parâmetro de consulta não está no formato de par nome-valor correto.

    Por exemplo, especificar um optionsparâmetro de parcial Produz um código de status 500 com "Bloco [parcial] não é uma entrada válida" no detalhe da mensagem.

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

    Nome Descrição
    resultado Lista de resultados produzidos pela consulta.

    Tipo de dados: Matriz

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    Result.ItemoCommittedAditionalCommittedItems Lista de ICs não incluídos no corpo da solicitação itemsmatriz a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    Result.additionalCommittedItems.Classname O sys_class_name deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.AditionalCommittedItems.Contagem de erros Número de erros encontrados ao processar este IC adicional.

    Tipo de dados: Número

    Erros.Result.ItemsCommittedItems.adicionais Lista de erros encontrados ao processar este IC adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    Result.additionalCommittedItems.errors.error Tipo de erro encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.errors.message Mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttents Lista de tentativas feitas para identificar este IC adicional.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    AdditionalCommittedItems.IdentificationAttempts.attemptResult Resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.IdentificationAttributes.Attributes Matriz de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    AdditionalCommittedItems.IdentificationAttempts.IdentifierName Regra de identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.IdentyfierEntrySysId Sys_id para a regra de identificador usada para identificar este IC adicional.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC adicional.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    Marcadores.ResultadosItemsCommittedItems.adicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    AdditionalCommittedItems.mergedPayloads Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Result.ItemsCommittedItems.adicionalCommittedItems.Operation Operação realizada para este IC adicional.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC adicional é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC adicional.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    Result.additionalCommittedItems.SYSID Sys_id encontrado para este IC adicional por meio de identificação.

    Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    ItemsCommittedItems.additionalCommittedItems.warnings Lista de avisos encontrados durante o processamento deste IC adicional.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedItems.warnings.error Tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedItems.warnings.message Mensagem de aviso encontrada durante o processamento deste IC adicional.

    Tipo de dados: Cadeia de caracteres

    AdditionalCommittedRelations Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relationslista a ser inserida ou atualizada.

    Tipo de dados: Matriz de objetos

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    AdditionalCommittedRelations.Classname O sys_class_name deste IC de relacionamento dependente adicional.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    RelacionaçõesCommittedRelacionadosadicionais.Contagem de erros Número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Número

    RelacionadosCommittedRelacionadosadicionais.Erros Lista de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    AdditionalCommittedRelacionamentos.Erros.ERROR Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    Result.RelacionadosCommittedRelacionamentos.Erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: Cadeia de caracteres

    result.additionalCommittedRelations.inputIndices Lista de valores de índice para objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    Marcadores.ResultadosRelacionadosCommittedRelacionadosadicionais Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.RelacionadosCommittedRelacionamentos.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    Relacionamentos.RelacionadosCommittedRelacionadosadicionais Operação realizada para este IC de relacionamento dependente adicional.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente é inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação é realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: Cadeia de caracteres

    result.items Lista de ICs incluídos no corpo da solicitação itemsmatriz.

    Tipo de dados: Matriz de objetos

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: Matriz de objetos

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.additionalRelatedItems.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsmatriz que corresponde a este item relacionado.

    Tipo de dados: Matriz

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId Sys_id deste IC relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.className Sys_class_name deste IC.

    Tipo de dados: Cadeia de caracteres

    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para items.lookupElementos de matriz que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento do corpo da solicitação items.lookupMatriz que faz referência a um determinado IC relacionado. Seus valores são o conjunto de elementos adicionais da mesma matriz que fazem referência ao mesmo IC relacionado.

    Tipo de dados: Objeto

    Este exemplo mostra um caso em que o segundo elemento no items.lookupA matriz faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount Número de erros encontrados ao processar este IC.

    Tipo de dados: Número

    result.items.errors Lista de erros encontrados ao processar este IC.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error Tipo de erro encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.errors.message Mensagem de erro encontrada ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts Lista de tentativas feitas para identificar este IC.
    Tipo de dados: Matriz de objetos
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult Resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • Identificação CORRESPONDIDA: Bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras de identificador que correspondeu exatamente aos atributos especificados.
    • MULTI_MATCH: Falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras de identificador ao corresponder com os atributos especificados.
    • NO_MATCH: Falha na identificação. Nenhum IC encontrado na tabela de regras de identificador que correspondeu aos atributos especificados.
    • IGNORADO: Identificação não tentada. Os atributos necessários para esta pesquisa de tabela de regra de identificador não foram fornecidos, portanto, a regra não foi aplicada.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.attributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC.

    Tipo de dados: Matriz

    Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como:

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName Regra de identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identificationAttempts.searchOnTable Nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: Cadeia de caracteres

    result.items.identifierEntrySysId Sys_id para a regra de identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Para obter detalhes, consulte errors.

    Tipo de dados: Cadeia de caracteres

    result.items.info Lista de informações adicionais sobre o processamento do item.

    Tipo de dados: Matriz de objetos

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code Tipo de reclassificação ignorado.
    Valores possíveis:
    • IGNORADO_CLASS_SWITCH
    • IGNORADO_CLASS_DOWNGRADE
    • IGNORADO_CLASS_UPGRADE
    result.items.info.message Mensagem que fornece informações adicionais sobre o motivo para ignorar a reclassificação.

    Tipo de dados: Cadeia de caracteres

    result.items.info.ruleSysId Sys_id da regra de restrição de reclassificação que foi correspondida. Aplicável somente quando o IRE ignora a reclassificação devido à regra de restrição de reclassificação. Este valor ficará vazio se a reclassificação for ignorada devido a uma carga útil ou sinalizador global.

    Tipo de dados: Cadeia de caracteres

    result.items.inputIndices Lista de valores de índice para ICs do corpo da solicitação itemsMatriz que corresponde a este IC.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation Operação realizada para este IC.
    Valores possíveis:
    • EXCLUIR: Um IC existente é removido da tabela de destino.
    • INSERIR: O IC é inserido na tabela de destino como um novo registro.
    • NO_CHANGE: Nenhuma operação é realizada para o IC.
    • ATUALIZAÇÃO: Um IC existente na tabela de destino é atualizado.
    • UPDATE_WITH_DOWNGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais genérica (classe ancestral).
    • UPDATE_WITH_SWITCH: Um IC existente na tabela de destino é atualizado e sua classe é alterada para outra classe que não é uma classe ancestral ou descendente.
    • UPDATE_WITH_UPGRADE: Um IC existente na tabela de destino é atualizado e sua classe é alterada para uma classe mais especializada (classe descendente).

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems Lista de ICs relacionados (IC de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz de objetos

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className O sys_class_name do item relacionado.

    Tipo de dados: Cadeia de caracteres

    result.items.relatedItems.inputIndices Lista de valores de índice para ICs e itens de pesquisa do corpo da solicitação itemse. items.lookupmatrizes que correspondem a este item relacionado.

    Tipo de dados: Matriz de objetos

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex Valor de índice do corpo da solicitação itemsMatriz que corresponde ao IC primário do item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.inputIndices.subIndex Valor de índice do corpo da solicitação items.lookupmatriz que corresponde ao item relacionado.

    Tipo de dados: Número

    result.items.relatedItems.markers Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    result.items.relatedItems.mergedPayloadIds Lista de valores sys_id para entradas na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds Lista de valores sys_id para itens relacionados (itens de pesquisa de tabela) do corpo da solicitação items.lookupmatriz.

    Tipo de dados: Matriz

    Valores notáveis:
    • Nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId Sys_id encontrado para este IC por meio de identificação.
    Valores notáveis:
    • Desconhecido: Falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings Lista de avisos encontrados durante o processamento deste IC.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error Tipo de aviso encontrado ao processar este IC.

    Tipo de dados: Cadeia de caracteres

    result.items.warnings.message Mensagem de aviso encontrada durante o processamento deste IC.

    Tipo de dados: Cadeia de caracteres

    Result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: Cadeia de caracteres

    resultado.relações Lista de ICs de relacionamento dependente do corpo da solicitação relationsmatriz.

    Tipo de dados: Matriz de objetos

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    Result.relations.classname O sys_class_name deste IC de relacionamento dependente.
    Somente valor compatível:
    • cmdb_rel_ci: A tabela de relacionamento de IC.

    Tipo de dados: Cadeia de caracteres

    Relations.errorCount.Result.relations Número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Número

    resultados.relações.erros Lista de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error Tipo de erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    resultado.relações.erros.mensagem Mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    result.relations.inputIndices Lista de valores de índice para os objetos de IC de relacionamento dependente no corpo da solicitação relationsMatriz que corresponde a este IC de relacionamento dependente.

    Tipo de dados: Matriz

    "inputIndices": [
      Number
    ]
    relations.markers.result Lista de valores de marcador para uso interno.

    Tipo de dados: Matriz

    "markers": []
    Result.relations.mergedPayloadIds Lista de valores sys_id para cargas parciais da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz

    "mergedPayloadIds": [
      "String"
    ]
    resultado.relações.operação Operação realizada para este IC de relacionamento dependente.
    Valores possíveis:
    • INSERIR: O IC de relacionamento dependente foi inserido na tabela de destino como um novo registro.
    • INSERT_AS_INCOMPLETE: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas Incompletas do IRE do CMDB [cmdb_ire_incomplete_payloads].
    • INSERT_AS_PARTIAL: O IC de relacionamento dependente tinha erros e foi inserido na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: Nenhuma operação foi realizada para o IC de relacionamento dependente.
    • ATUALIZAÇÃO: Um IC de relacionamento dependente existente na tabela de destino foi atualizado.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.result Lista de avisos encontrados durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Matriz de objetos

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error Tipo de aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    relations.warnings.message Mensagem de aviso encontrada durante o processamento deste IC de relacionamento dependente.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    Simule o envio de uma carga parcial para um IC de computador.

    curl "https://instance.servicenow.com/api/now/identifyreconcile/queryEnhanced" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
      "items" : [ \
        { \
          "className" : "cmdb_ci_computer", \
          "sys_object_source_info" : { \
            "source_name" : "ServiceNow", \
            "source_native_key" : "ncomputer3367" \
          }, \
          "values" : { \
            "cpu_core_count" : "6", \
            "ram" : "8192", \
            "manufacturer" : "DELL", \
            "company" : "My Company" \
          } \
        } \
      ] \
    }'

    A resposta mostra que a carga seria inserida na tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    {
      "result": {
        "relations": [],
        "items": [
          {
            "identifierEntrySysId": "Unknown",
            "partialSysIds": [
              "1aec79151bb45010593876a61a4bcb28"
            ],
            "sysId": "Unknown",
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_computer",
            "inputIndices": [
              0
            ],
            "operation": "INSERT_AS_PARTIAL",
            "errors": [],
            "identificationAttempts": [
              {
                "info": "sys_object_source NO_MATCH",
                "attemptResult": "NO_MATCH",
                "identifierName": "",
                "attributes": [],
                "hybridEntryCiAttributes": []
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "mac_address",
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_network_adapter"
              }
            ],
            "warningCount": 1,
            "warnings": [
              {
                "message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'",
                "error": "MISSING_MATCHING_ATTRIBUTES"
              }
            ],
            "mergedPayloadIds": [
              "7ddcb9551bb45010593876a61a4bcb08"
            ]
          }
        ],
        "additionalCommittedRelations": [],
        "additionalCommittedItems": []
      }
    }

    Simule o envio de uma segunda carga parcial que completaria a descrição do IC do computador, com a opção IRE aprimorado de geração de resumo habilitada.

    curl "https://instance.servicenow.com/api/now/identifyreconcile/queryEnhanced?options=generate_summary:true" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username:password" \
    --data '{ \
    }'

    A resposta mostra que o IC do computador seria inserido e exibe um resumo das operações que seriam realizadas.

    {
      "result": {
        "relations": [],
        "hasError": false,
        "additionalCommittedItems": [],
        "hasWarning": false,
        "items": [
          {
            "relatedSysIds": [
              "735c79151bb45010593876a61a4bcb67"
            ],
            "identifierEntrySysId": "Unknown",
            "sysId": "ff5c79151bb45010593876a61a4bcb64",
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_computer",
            "inputIndices": [
              0
            ],
            "operation": "INSERT",
            "relatedItems": [
              {
                "operation": "INSERT",
                "warningCount": 0,
                "errors": [],
                "sysId": "735c79151bb45010593876a61a4bcb67",
                "className": "cmdb_ci_network_adapter",
                "errorCount": 0,
                "markers": [],
                "inputIndices": [
                  {
                    "subIndex": 0,
                    "mainIndex": 0
                  }
                ],
                "mergedPayloadIds": []
              }
            ],
            "mergedPayloadIds": [
              "fe4c39151bb45010593876a61a4bcbd3"
            ],
            "identificationAttempts": [
              {
                "info": "sys_object_source NO_MATCH",
                "attemptResult": "NO_MATCH",
                "identifierName": "",
                "attributes": [],
                "hybridEntryCiAttributes": []
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "mac_address",
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_network_adapter"
              }
            ],
            "warningCount": 0
          }
        ],
        "additionalCommittedRelations": [],
        "summary": {
          "cmdb_ci_network_adapter": {
            "mergedPartialPayloads": 0,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          },
          "cmdb_ci_computer": {
            "mergedPartialPayloads": 1,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          }
        }
      }
    }