API de identificação e reconciliação

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 106 min. de leitura

    • A API de Identificação e Reconciliação usa o mecanismo de Identificação e Reconciliação (IRE) para minimizar a criação de itens de configuração (ICs) duplicados e para 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 asset 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/identifyreconcile

    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 o endpoint Identificação e reconciliação - POST /now/identifyreconcile/query para simular o envio de uma carga para este endpoint sem confirmar as mudanças no banco de dados.

    Use o endpoint Identificação e reconciliação - POST /now/identifyreconcile/enhanced se precisar especificar opções de IRE aprimoradas. Para obter mais informações sobre as opções de IRE aprimoradas, consulte Mecanismo de identificação e reconciliação (IRE).

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/identifyreconcile

    URL padrão: /api/now/identifyreconcile

    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 acessada. 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 Identifica a origem das informações do 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 de cargas incompletas.
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    itens Matriz de objetos em que cada objeto descreve um IC a ser criado ou atualizado.

    Tipo de dados: matriz

    "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 tabela CMDB, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: cadeia de caracteres
    itens.id_interno Identificador exclusivo para este item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.pesquisa 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: matriz

    "lookup": [
  {
    "className": "String",
    "internal_id": "String",
    "sys_object_source_info": {Object},
    "values": {Object}
  }
]
    itens.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 classe/tabela CMDB, como cmdb_serial_number ou cmdb_ci_network_adapter, ou uma classe de hierarquia diferente deCMDB.

    Tipo de dados: cadeia de caracteres
    itens.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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 em UTC em que o IC foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.pesquisa.valores Objeto que descreve os 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 os 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.relacionados Matriz de objetos na qual 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

    "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
    itens.related.internal_id Identificador exclusivo para este item relacionado nesta carga útil. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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
    itens.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 Chave/ID 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 em UTC em que o item relacionado foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.valores.relacionados Objeto que descreve os 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 os 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"
}
    itens.configurações Objeto que contém parâmetros que definem os tipos de atualizações permitidas.

    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
    itens.configurações.atualizaçãoSemDowngrade Indica se a atualização e o downgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o downgrade não é permitido.
    • false: a atualização e o downgrade do item são permitidos.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemComutador 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.
    • false: a atualização do item e a alternância de classe são permitidas.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemAtualizar Indica se a atualização e o upgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o upgrade não é permitido.
    • false: a atualização e o 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
    itens.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
    itens.sys_object_source_info.source_recency_timestamp Data e hora em 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 os 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 os 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"
}
    itens de referência Matriz de objetos em que cada objeto descreve uma referência entre dois itens na carga útil.

    Tipo de dados: matriz

    "referenceItems": [
  {
    "referenced": "String",
    "referencedBy": "String",
    "referenceField": "String"
  }
]
    itensDeReferência.referenciados O internal_id definido para o item que está sendo referenciado por outro item.

    Tipo de dados: cadeia de caracteres
    itensDeReferência.referenciadoPor O internal_id definido para o item que faz referência a outro item.

    Tipo de dados: cadeia de caracteres
    ItensDeReferência.CampoDeReferência Nome do campo de referência na classe/tabela do item referencedBy.

    Tipo de dados: cadeia de caracteres
    relações Matriz de objetos em que cada objeto descreve um relacionamento entre dois itens definidos na carga útil.
    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 pares de nome-valor parent e child, com valores que representam índices de item da matriz de carga items.
    • O objeto pode definir um relacionamento entre dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_id e child_id pares de chave/valor, com valores que representam internal_id valores definidos para esses itens.

    Tipo de dados: matriz

    "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"
  }
]
    relações.secundário O índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento.

    Tipo de dados: número
    relações.child_id O internal_id do item secundário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.parental O índice inteiro do objeto de IC na matriz items que representa o primário no relacionamento.

    Tipo de dados: número
    relações.parent_id O internal_id do item primário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.sys_rel_source_info Informações de origem da descoberta para o relacionamento. Para relacionamentos de não 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" 
}
    relações.sys_rel_source_info.source_name Nome da origem da descoberta.

    Padrão: origem da descoberta passada no parâmetro do método da API.
    relações.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "UNKNOWN" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.
    relações.tipo O tipo de relacionamento existente entre os itens primários e secundários. Este 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

    Códigos de status

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

    Tabela 6. Códigos de status
    Código de status Descrição
    200 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 Matriz de resultados produzidos pela consulta.

    Tipo de dados: matriz

    "result": [
  "additionalCommittedItems": [Array],
  "additionalCommittedRelations": [Array],
  "items": [Array],
  "relations": [Array]
]
    result.additionalCommittedItems Matriz de objetos em que cada objeto descreve um IC não incluído na matriz do corpo da solicitação items a ser inserida ou atualizada.

    Tipo de dados: matriz

    "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.additionalCommittedItems.errorCount O número de erros encontrados ao processar este IC adicional.

    Tipo de dados: número
    result.additionalCommittedItems.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC adicional.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.erros.mensagem A mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC adicional.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.additionalCommittedItems.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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.additionalCommittedItems.identificationAttempts.attributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

    Os nomes e os 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.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

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

    "hybridEntryCiAttributes": [
  "name": "String",
  "serial_number": "String"
]
    result.additionalCommittedItems.identificationAttempts.identifierName A regra do identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identifierEntrySysId O sys_id da regra do 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
    resultado.ItensConfirmadosadicionais.IndicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC adicional.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    resultado.adicionaisItensConfirmados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.adicionaisItensConfirmados.operação A 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.
    • UPDATE: 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 seja 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 O sys_id encontrado para este IC adicional por meio da identificação.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC adicional.

    Tipo de dados: matriz

    "warnings": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedItems.warnings.error O tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisitemscomprometido.avisos.mensagem A mensagem de aviso encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente não incluído na lista de corpo da solicitação relations a ser inserida ou atualizada.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: número
    result.additionalCommittedRelations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedRelations.errors.error O tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errors.message A mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.inputIndices Matriz de valores de índice para objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    resultado.adicionaisRelaçõesConfirmadas.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.RelaçõesConfirmadasadicionais.operação A 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 tem erros e está inserido na tabela de Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: nenhuma operação é realizada para o IC de relacionamento dependente.
    • UPDATE: um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: cadeia de caracteres
    Itens.resultados Matriz de objetos em que cada objeto descreve um IC incluído na matriz do corpo da solicitação items.

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados.índicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este item relacionado.

    Tipo de dados: matriz

    "inputIndices": [
    Number
]
    result.items.adicionaisItensRelacionados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.items.className O sys_class_name deste IC.

    Tipo de dados: cadeia de caracteres
    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para elementos de matriz items.lookup que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento da matriz do corpo da solicitação items.lookup 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 na matriz items.lookup faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

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

    Tipo de dados: número
    result.items.erros Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.erros.mensagem A mensagem de erro encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.items.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 A regra do identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identifierEntrySysId O sys_id da regra do identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    result.items.info Lista de objetos que contém informações adicionais sobre o processamento do item.

    Tipo de dados: matriz

    "info": [
  {
    "code": "String",
    "message": "String",
    "ruleSysId": "String"
  }
]
    result.items.info.code Tipo de reclassificação que foi ignorado.
    Valores possíveis:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    resultado.items.info.mensagem 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 Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    Itens.Resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.itens.operação A 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.
    • UPDATE: 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 seja 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 Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da matriz do corpo da solicitação items.lookup.

    Tipo de dados: matriz

    "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 Matriz de valores de índice para ICs e itens de pesquisa das matrizes de corpo da solicitação items e items.lookup que correspondem a este item relacionado.

    Tipo de dados: matriz

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

    Tipo de dados: número
    result.items.relatedItems.inputIndices.subIndex Valor de índice da matriz do corpo da solicitação items.lookup que corresponde ao item relacionado.

    Tipo de dados: número
    result.items.relatedItems.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    Valores notáveis:
    • nulo: nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
    Number,
    Number
]
    result.items.sysId O sys_id encontrado para este IC por meio da 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.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.aviso.mensagem A mensagem de aviso encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: cadeia de caracteres
    result.relations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente da matriz do corpo da solicitação relations.

    Tipo de dados: matriz

    "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 Relacionamento de IC.

    Tipo de dados: cadeia de caracteres
    result.relations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: número
    result.relations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.erros.mensagem A mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres
    result.relations.inputIndices Matriz de valores de índice para os objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    relacionamento.resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.relations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [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 A 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 de 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
    resultado.relações.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.aviso.mensagem A mensagem de aviso encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Envie uma carga contendo um servidor Linux (com número de série e pesquisas de item relacionado 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 por seu nome na tabela Hardware [cmdb_ci_hardware] e é processado como uma atualização para um IC existente na tabela do servidor Linux [cmdb_ci_linux_server]. O comutador de IP é identificado de forma semelhante por meio de uma pesquisa de regra de hardware por 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/identifyreconcile/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 o endpoint Identificação e reconciliação - POST /now/identifyreconcile/queryEnhanced para simular o envio de uma carga para este endpoint sem confirmar as mudanças no banco de dados.

    Este método é semelhante ao método Identificação e reconciliação - POST /now/identifyreconcile, mas adiciona a seguinte funcionalidade:
    • Cargas úteis parciais
      • No 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 das cargas úteis parciais que foram mescladas com as cargas úteis parciais existentes.
    • Oferece suporte ao recurso de desduplicação de carga.
    • Gera um resumo.

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/identifyreconcile/enhanced

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

    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 acessada. 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-valor que representam opções de IRE aprimoradas aplicadas à solicitação.

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

    parcial_payloads: falso, parcial_commits: falso, deduplicate_payloads: falso, generate_summary: verdadeiro
    Nota:
    Por padrão ou se partial_payloads for definido como verdadeiro, partial_commits e deduplicate_payloads serão habilitados, mesmo se forem definidos como falso, pois esses recursos são essenciais para a funcionalidade de cargas úteis parciais.

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

    Valores válidos para cada par de 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 Identifica a origem das informações do 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 de cargas incompletas.
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    itens Matriz de objetos em que cada objeto descreve um IC a ser criado ou atualizado.

    Tipo de dados: matriz

    "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 tabela CMDB, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: cadeia de caracteres
    itens.id_interno Identificador exclusivo para este item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.pesquisa 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: matriz

    "lookup": [
  {
    "className": "String",
    "internal_id": "String",
    "sys_object_source_info": {Object},
    "values": {Object}
  }
]
    itens.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 classe/tabela CMDB, como cmdb_serial_number ou cmdb_ci_network_adapter, ou uma classe de hierarquia diferente deCMDB.

    Tipo de dados: cadeia de caracteres
    itens.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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 em UTC em que o IC foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.pesquisa.valores Objeto que descreve os 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 os 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.relacionados Matriz de objetos na qual 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

    "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
    itens.related.internal_id Identificador exclusivo para este item relacionado nesta carga útil. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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
    itens.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 Chave/ID 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 em UTC em que o item relacionado foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.valores.relacionados Objeto que descreve os 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 os 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"
}
    itens.configurações Objeto que contém parâmetros que definem os tipos de atualizações permitidas.

    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
    itens.configurações.atualizaçãoSemDowngrade Indica se a atualização e o downgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o downgrade não é permitido.
    • false: a atualização e o downgrade do item são permitidos.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemComutador 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.
    • false: a atualização do item e a alternância de classe são permitidas.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemAtualizar Indica se a atualização e o upgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o upgrade não é permitido.
    • false: a atualização e o 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
    itens.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
    itens.sys_object_source_info.source_recency_timestamp Data e hora em 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 os 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 os 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"
}
    itens de referência Matriz de objetos em que cada objeto descreve uma referência entre dois itens na carga útil.

    Tipo de dados: matriz

    "referenceItems": [
  {
    "referenced": "String",
    "referencedBy": "String",
    "referenceField": "String"
  }
]
    itensDeReferência.referenciados O internal_id definido para o item que está sendo referenciado por outro item.

    Tipo de dados: cadeia de caracteres
    itensDeReferência.referenciadoPor O internal_id definido para o item que faz referência a outro item.

    Tipo de dados: cadeia de caracteres
    ItensDeReferência.CampoDeReferência Nome do campo de referência na classe/tabela do item referencedBy.

    Tipo de dados: cadeia de caracteres
    relações Matriz de objetos em que cada objeto descreve um relacionamento entre dois itens definidos na carga útil.
    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 pares de nome-valor parent e child, com valores que representam índices de item da matriz de carga items.
    • O objeto pode definir um relacionamento entre dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_id e child_id pares de chave/valor, com valores que representam internal_id valores definidos para esses itens.

    Tipo de dados: matriz

    "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"
  }
]
    relações.secundário O índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento.

    Tipo de dados: número
    relações.child_id O internal_id do item secundário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.parental O índice inteiro do objeto de IC na matriz items que representa o primário no relacionamento.

    Tipo de dados: número
    relações.parent_id O internal_id do item primário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.sys_rel_source_info Informações de origem da descoberta para o relacionamento. Para relacionamentos de não 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" 
}
    relações.sys_rel_source_info.source_name Nome da origem da descoberta.

    Padrão: origem da descoberta passada no parâmetro do método da API.
    relações.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "UNKNOWN" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.
    relações.tipo O tipo de relacionamento existente entre os itens primários e secundários. Este 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

    Códigos de status

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

    Tabela 12. Códigos de status
    Código de 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.

    O detalhe da mensagem de erro "O bloco [...] não é uma entrada válida" indica que o parâmetro de consulta options não está no formato correto do par nome-valor.

    Por exemplo, especificar um parâmetro options de parcial produz um código de status 500 com "O bloco [parcial] não é uma entrada válida" nos detalhes da mensagem.

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

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

    Tipo de dados: matriz

    "result": [
  "additionalCommittedItems": [Array],
  "additionalCommittedRelations": [Array],
  "items": [Array],
  "relations": [Array]
]
    result.additionalCommittedItems Matriz de objetos em que cada objeto descreve um IC não incluído na matriz do corpo da solicitação items a ser inserida ou atualizada.

    Tipo de dados: matriz

    "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.additionalCommittedItems.errorCount O número de erros encontrados ao processar este IC adicional.

    Tipo de dados: número
    result.additionalCommittedItems.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC adicional.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.erros.mensagem A mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC adicional.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.additionalCommittedItems.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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.additionalCommittedItems.identificationAttempts.attributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

    Os nomes e os 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.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

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

    "hybridEntryCiAttributes": [
  "name": "String",
  "serial_number": "String"
]
    result.additionalCommittedItems.identificationAttempts.identifierName A regra do identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identifierEntrySysId O sys_id da regra do 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
    resultado.ItensConfirmadosadicionais.IndicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC adicional.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    resultado.adicionaisItensConfirmados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.adicionaisItensConfirmados.operação A 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.
    • UPDATE: 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 seja 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 O sys_id encontrado para este IC adicional por meio da identificação.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC adicional.

    Tipo de dados: matriz

    "warnings": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedItems.warnings.error O tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisitemscomprometido.avisos.mensagem A mensagem de aviso encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente não incluído na lista de corpo da solicitação relations a ser inserida ou atualizada.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: número
    result.additionalCommittedRelations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedRelations.errors.error O tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errors.message A mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.inputIndices Matriz de valores de índice para objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    resultado.adicionaisRelaçõesConfirmadas.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.RelaçõesConfirmadasadicionais.operação A 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 tem erros e está inserido na tabela de Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: nenhuma operação é realizada para o IC de relacionamento dependente.
    • UPDATE: um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: cadeia de caracteres
    Itens.resultados Matriz de objetos em que cada objeto descreve um IC incluído na matriz do corpo da solicitação items.

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados.índicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este item relacionado.

    Tipo de dados: matriz

    "inputIndices": [
    Number
]
    result.items.adicionaisItensRelacionados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.items.className O sys_class_name deste IC.

    Tipo de dados: cadeia de caracteres
    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para elementos de matriz items.lookup que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento da matriz do corpo da solicitação items.lookup 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 na matriz items.lookup faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

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

    Tipo de dados: número
    result.items.erros Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.erros.mensagem A mensagem de erro encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.items.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 A regra do identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identifierEntrySysId O sys_id da regra do identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    result.items.info Lista de objetos que contém informações adicionais sobre o processamento do item.

    Tipo de dados: matriz

    "info": [
  {
    "code": "String",
    "message": "String",
    "ruleSysId": "String"
  }
]
    result.items.info.code Tipo de reclassificação que foi ignorado.
    Valores possíveis:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    resultado.items.info.mensagem 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 Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    Itens.Resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.itens.operação A 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.
    • UPDATE: 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 seja 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 Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da matriz do corpo da solicitação items.lookup.

    Tipo de dados: matriz

    "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 Matriz de valores de índice para ICs e itens de pesquisa das matrizes de corpo da solicitação items e items.lookup que correspondem a este item relacionado.

    Tipo de dados: matriz

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

    Tipo de dados: número
    result.items.relatedItems.inputIndices.subIndex Valor de índice da matriz do corpo da solicitação items.lookup que corresponde ao item relacionado.

    Tipo de dados: número
    result.items.relatedItems.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    Valores notáveis:
    • nulo: nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
    Number,
    Number
]
    result.items.sysId O sys_id encontrado para este IC por meio da 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.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.aviso.mensagem A mensagem de aviso encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: cadeia de caracteres
    result.relations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente da matriz do corpo da solicitação relations.

    Tipo de dados: matriz

    "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 Relacionamento de IC.

    Tipo de dados: cadeia de caracteres
    result.relations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: número
    result.relations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.erros.mensagem A mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres
    result.relations.inputIndices Matriz de valores de índice para os objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    relacionamento.resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.relations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [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 A 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 de 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
    resultado.relações.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.aviso.mensagem A mensagem de aviso encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Envie uma carga útil 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 útil foi inserida na tabela Cargas úteis parciais do CMDB IRE [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 útil 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/identifyreconcile/query

    Determina a operação CMDB (inserção/atualização) 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 útil (corpo da solicitação) para o endpoint Identificação e reconciliação - POST /now/identifyreconcile.

    Use o endpoint Identificação e reconciliação - POST /now/identifyreconcile/enhanced se precisar especificar opções de IRE aprimoradas. Para obter mais informações sobre as opções de IRE aprimoradas, consulte Mecanismo de identificação e reconciliação (IRE).

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/identifyreconcile/query

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

    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 acessada. 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 Identifica a origem das informações do 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 de cargas incompletas.
    Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    itens Matriz de objetos em que cada objeto descreve um IC a ser criado ou atualizado.

    Tipo de dados: matriz

    "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 tabela CMDB, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: cadeia de caracteres
    itens.id_interno Identificador exclusivo para este item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.pesquisa 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: matriz

    "lookup": [
  {
    "className": "String",
    "internal_id": "String",
    "sys_object_source_info": {Object},
    "values": {Object}
  }
]
    itens.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 classe/tabela CMDB, como cmdb_serial_number ou cmdb_ci_network_adapter, ou uma classe de hierarquia diferente deCMDB.

    Tipo de dados: cadeia de caracteres
    itens.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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 em UTC em que o IC foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.pesquisa.valores Objeto que descreve os 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 os 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.relacionados Matriz de objetos na qual 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

    "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
    itens.related.internal_id Identificador exclusivo para este item relacionado nesta carga útil. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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
    itens.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 Chave/ID 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 em UTC em que o item relacionado foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.valores.relacionados Objeto que descreve os 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 os 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"
}
    itens.configurações Objeto que contém parâmetros que definem os tipos de atualizações permitidas.

    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
    itens.configurações.atualizaçãoSemDowngrade Indica se a atualização e o downgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o downgrade não é permitido.
    • false: a atualização e o downgrade do item são permitidos.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemComutador 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.
    • false: a atualização do item e a alternância de classe são permitidas.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemAtualizar Indica se a atualização e o upgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o upgrade não é permitido.
    • false: a atualização e o 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
    itens.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
    itens.sys_object_source_info.source_recency_timestamp Data e hora em 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 os 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 os 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"
}
    itens de referência Matriz de objetos em que cada objeto descreve uma referência entre dois itens na carga útil.

    Tipo de dados: matriz

    "referenceItems": [
  {
    "referenced": "String",
    "referencedBy": "String",
    "referenceField": "String"
  }
]
    itensDeReferência.referenciados O internal_id definido para o item que está sendo referenciado por outro item.

    Tipo de dados: cadeia de caracteres
    itensDeReferência.referenciadoPor O internal_id definido para o item que faz referência a outro item.

    Tipo de dados: cadeia de caracteres
    ItensDeReferência.CampoDeReferência Nome do campo de referência na classe/tabela do item referencedBy.

    Tipo de dados: cadeia de caracteres
    relações Matriz de objetos em que cada objeto descreve um relacionamento entre dois itens definidos na carga útil.
    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 pares de nome-valor parent e child, com valores que representam índices de item da matriz de carga items.
    • O objeto pode definir um relacionamento entre dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_id e child_id pares de chave/valor, com valores que representam internal_id valores definidos para esses itens.

    Tipo de dados: matriz

    "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"
  }
]
    relações.secundário O índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento.

    Tipo de dados: número
    relações.child_id O internal_id do item secundário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.parental O índice inteiro do objeto de IC na matriz items que representa o primário no relacionamento.

    Tipo de dados: número
    relações.parent_id O internal_id do item primário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.sys_rel_source_info Informações de origem da descoberta para o relacionamento. Para relacionamentos de não 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" 
}
    relações.sys_rel_source_info.source_name Nome da origem da descoberta.

    Padrão: origem da descoberta passada no parâmetro do método da API.
    relações.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "UNKNOWN" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.
    relações.tipo O tipo de relacionamento existente entre os itens primários e secundários. Este 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

    Códigos de status

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

    Tabela 18. Códigos de status
    Código de 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 Matriz de resultados produzidos pela consulta.

    Tipo de dados: matriz

    "result": [
  "additionalCommittedItems": [Array],
  "additionalCommittedRelations": [Array],
  "items": [Array],
  "relations": [Array]
]
    result.additionalCommittedItems Matriz de objetos em que cada objeto descreve um IC não incluído na matriz do corpo da solicitação items a ser inserida ou atualizada.

    Tipo de dados: matriz

    "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.additionalCommittedItems.errorCount O número de erros encontrados ao processar este IC adicional.

    Tipo de dados: número
    result.additionalCommittedItems.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC adicional.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.erros.mensagem A mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC adicional.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.additionalCommittedItems.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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.additionalCommittedItems.identificationAttempts.attributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

    Os nomes e os 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.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

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

    "hybridEntryCiAttributes": [
  "name": "String",
  "serial_number": "String"
]
    result.additionalCommittedItems.identificationAttempts.identifierName A regra do identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identifierEntrySysId O sys_id da regra do 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
    resultado.ItensConfirmadosadicionais.IndicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC adicional.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    resultado.adicionaisItensConfirmados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.adicionaisItensConfirmados.operação A 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.
    • UPDATE: 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 seja 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 O sys_id encontrado para este IC adicional por meio da identificação.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC adicional.

    Tipo de dados: matriz

    "warnings": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedItems.warnings.error O tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisitemscomprometido.avisos.mensagem A mensagem de aviso encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente não incluído na lista de corpo da solicitação relations a ser inserida ou atualizada.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: número
    result.additionalCommittedRelations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedRelations.errors.error O tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errors.message A mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.inputIndices Matriz de valores de índice para objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    resultado.adicionaisRelaçõesConfirmadas.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.RelaçõesConfirmadasadicionais.operação A 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 tem erros e está inserido na tabela de Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: nenhuma operação é realizada para o IC de relacionamento dependente.
    • UPDATE: um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: cadeia de caracteres
    Itens.resultados Matriz de objetos em que cada objeto descreve um IC incluído na matriz do corpo da solicitação items.

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados.índicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este item relacionado.

    Tipo de dados: matriz

    "inputIndices": [
    Number
]
    result.items.adicionaisItensRelacionados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.items.className O sys_class_name deste IC.

    Tipo de dados: cadeia de caracteres
    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para elementos de matriz items.lookup que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento da matriz do corpo da solicitação items.lookup 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 na matriz items.lookup faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

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

    Tipo de dados: número
    result.items.erros Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.erros.mensagem A mensagem de erro encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.items.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 A regra do identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identifierEntrySysId O sys_id da regra do identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    result.items.info Lista de objetos que contém informações adicionais sobre o processamento do item.

    Tipo de dados: matriz

    "info": [
  {
    "code": "String",
    "message": "String",
    "ruleSysId": "String"
  }
]
    result.items.info.code Tipo de reclassificação que foi ignorado.
    Valores possíveis:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    resultado.items.info.mensagem 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 Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    Itens.Resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.itens.operação A 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.
    • UPDATE: 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 seja 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 Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da matriz do corpo da solicitação items.lookup.

    Tipo de dados: matriz

    "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 Matriz de valores de índice para ICs e itens de pesquisa das matrizes de corpo da solicitação items e items.lookup que correspondem a este item relacionado.

    Tipo de dados: matriz

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

    Tipo de dados: número
    result.items.relatedItems.inputIndices.subIndex Valor de índice da matriz do corpo da solicitação items.lookup que corresponde ao item relacionado.

    Tipo de dados: número
    result.items.relatedItems.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    Valores notáveis:
    • nulo: nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
    Number,
    Number
]
    result.items.sysId O sys_id encontrado para este IC por meio da 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.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.aviso.mensagem A mensagem de aviso encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: cadeia de caracteres
    result.relations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente da matriz do corpo da solicitação relations.

    Tipo de dados: matriz

    "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 Relacionamento de IC.

    Tipo de dados: cadeia de caracteres
    result.relations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: número
    result.relations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.erros.mensagem A mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres
    result.relations.inputIndices Matriz de valores de índice para os objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    relacionamento.resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.relations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [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 A 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 de 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
    resultado.relações.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.aviso.mensagem A mensagem de aviso encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Simule o envio de uma carga contendo um servidor Linux (com número de série e pesquisas de item relacionado 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 por seu nome na tabela Hardware [cmdb_ci_hardware] e é processado como uma atualização para um IC existente na tabela do servidor Linux [cmdb_ci_linux_server]. O comutador de IP é identificado de forma semelhante por meio de uma pesquisa de regra de hardware por 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/identifyreconcile/queryEnhanced

    Determina a operação CMDB (inserção/atualização) 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 útil (corpo da solicitação) para o endpoint Identificação e reconciliação - POST /now/identifyreconcile/enhanced.

    Este método é semelhante ao método Identificação e reconciliação - POST /now/identifyreconcile/query, mas adiciona a seguinte funcionalidade:
    • Cargas úteis parciais
      • No 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 das cargas úteis parciais que foram mescladas com as cargas úteis parciais existentes.
    • Oferece suporte ao recurso de desduplicação de carga.
    • Gera um resumo.

    Formato de URL

    URL com controle de versões: /api/now/{api_version}/identifyreconcile/queryEnhanced

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

    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 acessada. 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-valor que representam opções de IRE aprimoradas aplicadas à solicitação.

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

    parcial_payloads: falso, parcial_commits: falso, deduplicate_payloads: falso, generate_summary: verdadeiro
    Nota:
    Por padrão ou se partial_payloads for definido como verdadeiro, partial_commits e deduplicate_payloads serão habilitados, mesmo se forem definidos como falso, pois esses recursos são essenciais para a funcionalidade de cargas úteis parciais.

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

    Valores válidos para cada par de 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 Identifica a origem das informações do 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 de cargas incompletas.
    Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    itens Matriz de objetos em que cada objeto descreve um IC a ser criado ou atualizado.

    Tipo de dados: matriz

    "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 tabela CMDB, como cmdb_ci_linux_server ou cmdb_ci_win_server.

    Tipo de dados: cadeia de caracteres
    itens.id_interno Identificador exclusivo para este item nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.pesquisa 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: matriz

    "lookup": [
  {
    "className": "String",
    "internal_id": "String",
    "sys_object_source_info": {Object},
    "values": {Object}
  }
]
    itens.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 classe/tabela CMDB, como cmdb_serial_number ou cmdb_ci_network_adapter, ou uma classe de hierarquia diferente deCMDB.

    Tipo de dados: cadeia de caracteres
    itens.lookup.internal_id Identificador exclusivo para este registro de pesquisa nesta carga. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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 em UTC em que o IC foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.pesquisa.valores Objeto que descreve os 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 os 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.relacionados Matriz de objetos na qual 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

    "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
    itens.related.internal_id Identificador exclusivo para este item relacionado nesta carga útil. Pode ser qualquer valor, mas deve ser exclusivo na carga útil.

    Tipo de dados: cadeia de caracteres
    itens.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
    itens.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 Chave/ID 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 em UTC em que o item relacionado foi verificado.

    Tipo de dados: cadeia de caracteres

    Formato: AAAA-MM-DD hh:mm:ss
    itens.valores.relacionados Objeto que descreve os 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 os 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"
}
    itens.configurações Objeto que contém parâmetros que definem os tipos de atualizações permitidas.

    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
    itens.configurações.atualizaçãoSemDowngrade Indica se a atualização e o downgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o downgrade não é permitido.
    • false: a atualização e o downgrade do item são permitidos.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemComutador 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.
    • false: a atualização do item e a alternância de classe são permitidas.

    Tipo de dados: booliano

    Padrão: falso
    itens.configurações.atualizarSemAtualizar Indica se a atualização e o upgrade são permitidos para este IC.
    Valores válidos:
    • verdadeiro: atualize o item, mas o upgrade não é permitido.
    • false: a atualização e o 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
    itens.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
    itens.sys_object_source_info.source_recency_timestamp Data e hora em 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 os 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 os 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"
}
    itens de referência Matriz de objetos em que cada objeto descreve uma referência entre dois itens na carga útil.

    Tipo de dados: matriz

    "referenceItems": [
  {
    "referenced": "String",
    "referencedBy": "String",
    "referenceField": "String"
  }
]
    itensDeReferência.referenciados O internal_id definido para o item que está sendo referenciado por outro item.

    Tipo de dados: cadeia de caracteres
    itensDeReferência.referenciadoPor O internal_id definido para o item que faz referência a outro item.

    Tipo de dados: cadeia de caracteres
    ItensDeReferência.CampoDeReferência Nome do campo de referência na classe/tabela do item referencedBy.

    Tipo de dados: cadeia de caracteres
    relações Matriz de objetos em que cada objeto descreve um relacionamento entre dois itens definidos na carga útil.
    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 pares de nome-valor parent e child, com valores que representam índices de item da matriz de carga items.
    • O objeto pode definir um relacionamento entre dois itens, incluindo itens de nível superior, relacionados ou de pesquisa, usando parent_id e child_id pares de chave/valor, com valores que representam internal_id valores definidos para esses itens.

    Tipo de dados: matriz

    "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"
  }
]
    relações.secundário O índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento.

    Tipo de dados: número
    relações.child_id O internal_id do item secundário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.parental O índice inteiro do objeto de IC na matriz items que representa o primário no relacionamento.

    Tipo de dados: número
    relações.parent_id O internal_id do item primário no relacionamento.

    Tipo de dados: cadeia de caracteres
    relações.sys_rel_source_info Informações de origem da descoberta para o relacionamento. Para relacionamentos de não 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" 
}
    relações.sys_rel_source_info.source_name Nome da origem da descoberta.

    Padrão: origem da descoberta passada no parâmetro do método da API.
    relações.sys_rel_source_info.source_feed Qualquer cadeia de caracteres que seja uma subdescoberta/verificação na origem da descoberta.

    Padrão: "UNKNOWN" é armazenado na coluna source_feed ao criar um registro na tabela sys_rel_source.
    relações.tipo O tipo de relacionamento existente entre os itens primários e secundários. Este 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

    Códigos de status

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

    Tabela 24. Códigos de status
    Código de 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.

    O detalhe da mensagem de erro "O bloco [...] não é uma entrada válida" indica que o parâmetro de consulta options não está no formato correto do par nome-valor.

    Por exemplo, especificar um parâmetro options de parcial produz um código de status 500 com "O bloco [parcial] não é uma entrada válida" nos detalhes da mensagem.

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

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

    Tipo de dados: matriz

    "result": [
  "additionalCommittedItems": [Array],
  "additionalCommittedRelations": [Array],
  "items": [Array],
  "relations": [Array]
]
    result.additionalCommittedItems Matriz de objetos em que cada objeto descreve um IC não incluído na matriz do corpo da solicitação items a ser inserida ou atualizada.

    Tipo de dados: matriz

    "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.additionalCommittedItems.errorCount O número de erros encontrados ao processar este IC adicional.

    Tipo de dados: número
    result.additionalCommittedItems.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC adicional.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.erros.mensagem A mensagem de erro encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC adicional.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.additionalCommittedItems.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC adicional.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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.additionalCommittedItems.identificationAttempts.attributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

    Os nomes e os 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.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC adicional.

    Tipo de dados: matriz

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

    "hybridEntryCiAttributes": [
  "name": "String",
  "serial_number": "String"
]
    result.additionalCommittedItems.identificationAttempts.identifierName A regra do identificador usada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedItems.identifierEntrySysId O sys_id da regra do 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
    resultado.ItensConfirmadosadicionais.IndicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC adicional.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    resultado.adicionaisItensConfirmados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.adicionaisItensConfirmados.operação A 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.
    • UPDATE: 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 seja 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 O sys_id encontrado para este IC adicional por meio da identificação.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC adicional. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisItensConfirmados.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC adicional.

    Tipo de dados: matriz

    "warnings": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedItems.warnings.error O tipo de aviso encontrado ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    resultado.adicionaisitemscomprometido.avisos.mensagem A mensagem de aviso encontrada ao processar este IC adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente não incluído na lista de corpo da solicitação relations a ser inserida ou atualizada.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: número
    result.additionalCommittedRelations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.additionalCommittedRelations.errors.error O tipo de erro encontrado ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.errors.message A mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional.

    Tipo de dados: cadeia de caracteres
    result.additionalCommittedRelations.inputIndices Matriz de valores de índice para objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    resultado.adicionaisRelaçõesConfirmadas.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional.

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.RelaçõesConfirmadasadicionais.operação A 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 tem erros e está inserido na tabela de Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads].
    • NO_CHANGE: nenhuma operação é realizada para o IC de relacionamento dependente.
    • UPDATE: um IC de relacionamento dependente existente na tabela de destino é atualizado.

    Tipo de dados: cadeia de caracteres
    Itens.resultados Matriz de objetos em que cada objeto descreve um IC incluído na matriz do corpo da solicitação items.

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da tabela Cargas parciais do IRE do CMDB [cmdb_ire_partial_payloads].

    Tipo de dados: matriz

    "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.adicionaisItensRelacionados.índicesDeEntrada Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este item relacionado.

    Tipo de dados: matriz

    "inputIndices": [
    Number
]
    result.items.adicionaisItensRelacionados.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    result.items.className O sys_class_name deste IC.

    Tipo de dados: cadeia de caracteres
    result.items.duplicateLookupIndices Objeto que contém matrizes de valores de índice para elementos de matriz items.lookup que fazem referência ao mesmo IC relacionado.

    O nome da matriz indica o primeiro elemento da matriz do corpo da solicitação items.lookup 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 na matriz items.lookup faz referência ao mesmo IC relacionado que um elemento posterior dessa matriz:

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

    Tipo de dados: número
    result.items.erros Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.erros.mensagem A mensagem de erro encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts Matriz de objetos em que cada objeto descreve uma tentativa feita para identificar este IC.
    Tipo de dados: matriz
    "identificationAttempts": [
  {
    "attemptResult": "String",
    "attributes": [Array],
    "hybridEntryCiAttributes": [Array],
    "identiferName": "String",
    "searchOnTable": [Array]
  }
]
    result.items.identificationAttempts.attemptResult O resultado desta tentativa de identificação de IC.
    Valores possíveis:
    • CORRESPONDIDO: identificação bem-sucedida. Um IC exclusivo foi encontrado na tabela de regras do identificador que corresponde exatamente aos atributos especificados.
    • MULTI_MATCH: falha na identificação com um erro. ICs duplicados foram encontrados na tabela de regras do identificador ao fazer a correspondência com os atributos especificados.
    • NO_MATCH: falha na identificação. Nenhum IC encontrado na tabela de regras do identificador que corresponda aos atributos especificados.
    • SKIPPED: tentativa de identificação sem tentativa. 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 Matriz de atributos de entrada do identificador de IC usada durante esta tentativa de identificação de IC.

    Tipo de dados: matriz

    Os nomes e os 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 A regra do identificador usada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identificationAttempts.searchOnTable O nome da tabela pesquisada para esta tentativa de identificação de IC.

    Tipo de dados: cadeia de caracteres
    result.items.identifierEntrySysId O sys_id da regra do identificador usada para identificar este IC.
    Valores notáveis:
    • Desconhecido: falha na identificação deste IC. Consulte errors para obter detalhes.

    Tipo de dados: cadeia de caracteres
    result.items.info Lista de objetos que contém informações adicionais sobre o processamento do item.

    Tipo de dados: matriz

    "info": [
  {
    "code": "String",
    "message": "String",
    "ruleSysId": "String"
  }
]
    result.items.info.code Tipo de reclassificação que foi ignorado.
    Valores possíveis:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    resultado.items.info.mensagem 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 Matriz de valores de índice para ICs da matriz do corpo da solicitação items que correspondem a este IC.

    Tipo de dados: matriz

    "inputIndices": [
  {
    Number
  }
]
    Itens.Resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    "mergedPayloadIds": [
  "String"
]
    resultado.itens.operação A 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.
    • UPDATE: 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 seja 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 Matriz de objetos em que cada objeto descreve um IC relacionado (IC de pesquisa de tabela) da matriz do corpo da solicitação items.lookup.

    Tipo de dados: matriz

    "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 Matriz de valores de índice para ICs e itens de pesquisa das matrizes de corpo da solicitação items e items.lookup que correspondem a este item relacionado.

    Tipo de dados: matriz

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

    Tipo de dados: número
    result.items.relatedItems.inputIndices.subIndex Valor de índice da matriz do corpo da solicitação items.lookup que corresponde ao item relacionado.

    Tipo de dados: número
    result.items.relatedItems.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

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

    Tipo de dados: matriz

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

    Tipo de dados: matriz

    Valores notáveis:
    • nulo: nenhum sys_id foi identificado para este item relacionado.
    "relatedSysIds": [
    Number,
    Number
]
    result.items.sysId O sys_id encontrado para este IC por meio da 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.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.items.aviso.mensagem A mensagem de aviso encontrada ao processar este IC.

    Tipo de dados: cadeia de caracteres
    result.logContextId ID de contexto relatado para esta carga.

    Tipo de dados: cadeia de caracteres
    result.relations Matriz de objetos em que cada objeto descreve um IC de relacionamento dependente da matriz do corpo da solicitação relations.

    Tipo de dados: matriz

    "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 Relacionamento de IC.

    Tipo de dados: cadeia de caracteres
    result.relations.errorCount O número de erros encontrados ao processar este IC de relacionamento dependente.

    Tipo de dados: número
    result.relations.errors Matriz de objetos em que cada objeto descreve um erro encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.erros.mensagem A mensagem de erro encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres
    result.relations.inputIndices Matriz de valores de índice para os objetos de IC de relacionamento dependente na matriz do corpo da solicitação relations que correspondem a este IC de relacionamento dependente.

    Tipo de dados: matriz

    "inputIndices": [
  Number
]
    relacionamento.resultado.marcadores Matriz de valores de marcador para uso interno.

    Tipo de dados: matriz

    "markers": []
    result.relations.mergedPayloadIds Matriz de valores de sys_id para cargas úteis parciais da tabela Cargas úteis parciais do CMDB IRE [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 A 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 de 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
    resultado.relações.avisos Matriz de objetos em que cada objeto descreve um aviso encontrado ao processar este IC de relacionamento dependente.

    Tipo de dados: matriz

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

    Tipo de dados: cadeia de caracteres
    resultado.relação.aviso.mensagem A mensagem de aviso encontrada ao processar este IC de relacionamento dependente.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Simule o envio de uma carga útil 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 útil seria inserida na tabela Cargas úteis parciais do CMDB IRE [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 útil parcial que completaria 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/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
      }
    }
  }
}