API de identificação e reconciliação
A API de identificação e reconciliação fornece endpoints que usam 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 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 mudanças no banco de dados.
Em vez disso, 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 da URL
URL com controle de versão: /api/now/{api_version}/identifyreconcile
URL padrão: /api/now/identifyreconcile
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| sysparm_data_source | Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres Padrão: insira a carga da API na tabela de cargas incompletas. |
| Nome | Descrição |
|---|---|
| itens | Lista de ICs a serem criados ou atualizados. Tipo de dados: matriz de objetos |
| itens.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 de objetos |
| itens.pesquisa.NomeDeClasse | 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.pesquisa.id_interno | 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.pesquisar.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 |
| itens.pesquisar.sys_object_source_info.source_feed | Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_name | Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_native_key | Chave/id exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o IC foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.pesquisa.valores | Objeto que descreve os campos deste item de pesquisa como pares de nome/valor, em que o nome é o nome do campo. Tipo de dados: objeto Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como: |
| 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 de objetos |
| itens.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. 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 |
| itens.relacionados.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 exclusivo da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.related.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o item relacionado foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens.configurações | Objeto que contém parâmetros que definem os tipos de atualizações permitidas. Tipo de dados: objeto |
| itens.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:
Padrão: falso |
| itens.configurações.atualizaçãoSemDowngrade | Sinalizador que indica se a atualização e o downgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemTroca | Sinalizador que indica se este IC pode ser atualizado e sua classe alternada. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemUpgrade | Sinalizador que indica se a atualização e o upgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.sys_object_source_info | Objeto que descreve um identificador de IC exclusivo. Tipo de dados: objeto |
| 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 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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens de referência | Lista de referência entre dois itens na carga útil. Tipo de dados: matriz de objetos |
| itensDeReferência.referenciados | O internal_id definido para o item que está sendo referenciado por outro item. Tipo de dados: cadeia de caracteres |
| referenceItems.referencedBy | 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 | Lista de relacionamentos entre dois itens definidos na carga útil. Um objeto nesta matriz pode usar um de dois formatos:
Tipo de dados: matriz de objetos
|
| relações.secundário | Índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento. Tipo de dados: número |
| relações.id_criança | O internal_id do item secundário no relacionamento. Tipo de dados: cadeia de caracteres |
| relações.primário | Í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 |
| relações.sys_rel_source_info.source_name | Nome da origem da descoberta. Padrão: origem de descoberta aprovada no parâmetro de 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 | Tipo de relacionamento existente entre os itens primários e secundários. 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.
| 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. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| 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 | Lista de resultados produzidos pela consulta. Tipo de dados: matriz |
| result.additionalCommittedItems | Lista de ICs não incluídos na matriz items do corpo da solicitação a ser inserida ou atualizada. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.className | O sys_class_name deste IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errorCount | Número de erros encontrados ao processar este IC adicional. Tipo de dados: número |
| result.additionalCommittedItems.errors | Lista de erros encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.errors.error | Tipo de erro encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errors.message | Mensagem de erro encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts | Lista de tentativas feitas para identificar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC adicional. Valores possíveis:
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 tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC adicional. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedItems.mergedPayloads | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional. Tipo de dados: matriz |
| result.additionalCommittedItems.operation | Operação realizada para este IC adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.sysId | Sys_id encontrado para este IC adicional por meio de identificação. Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings | Lista de avisos encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.warnings.error | Tipo de aviso encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings.message | Mensagem de aviso encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations | Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relations lista para inserir ou atualizar. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.className | O sys_class_name deste IC de relacionamento dependente adicional. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: número |
| result.additionalCommittedRelations.errors | Lista de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.inputIndices | Lista de valores de índice para objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.markers | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedRelations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.operation | Operação realizada para este IC de relacionamento dependente adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| resultado.itens | Lista de ICs incluídos na matriz items do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads]. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| result.items.additionalRelatedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.additionalRelatedItems.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.sysId | Sys_id deste IC relacionado. Tipo de dados: cadeia de caracteres |
| result.items.className | Sys_class_name deste IC. Tipo de dados: cadeia de caracteres |
| Itens.Resultado.PesquisaIndicesDuplicados | 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 items.lookup do corpo da solicitação 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: |
| result.items.errorCount | Número de erros encontrados ao processar este IC. Tipo de dados: número |
| itens.resultados.erros | Lista de erros encontrados ao processar este IC. Tipo de dados: matriz de objetos |
| resultado.itens.erros.erro | Tipo de erro encontrado ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.erros.mensagem | Mensagem de erro encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationTentativas | Lista de tentativas feitas para identificar este IC. Tipo de dados: matriz de objetos |
| result.items.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.attributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.items.info | Lista de informações adicionais sobre o processamento do item. Tipo de dados: matriz de objetos |
| resultado.itens.info.código | Tipo de reclassificação que foi ignorado. Valores possíveis:
|
| resultado.itens.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 |
| Itens.Resultado.InputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC. Tipo de dados: matriz de objetos |
| itens.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC. Tipo de dados: matriz |
| resultado.itens.operação | Operação realizada para este IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.relatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.relatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| Itens.Resultados.Itens.InputIndices | Lista de valores de índice para ICs e itens de pesquisa das matrizes items e items.lookup do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz de objetos |
| Itens.Resultados.Itens.InputIndices.Indiceprincipal | Valor de índice da matriz items do corpo da solicitação que corresponde ao IC primário do item relacionado. Tipo de dados: número |
| Itens.Resultados.Itens.InputIndices.SubIndex | Valor de índice da matriz items.lookup do corpo da solicitação que corresponde ao item relacionado. Tipo de dados: número |
| itens.resultados.itens.relacionados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.relatedItems.mergedPayloadIds | Lista de valores de sys_id para entradas na tabela Cargas Parciais de IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento. Tipo de dados: matriz |
| result.items.relatedSysIds | Lista de valores de sys_id para itens relacionados (itens de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz Valores notáveis:
|
| result.items.sysId | Sys_id encontrado para este IC por meio de identificação. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| avisos.itens.resultados | Lista de avisos encontrados durante o processamento deste IC. Tipo de dados: matriz de objetos |
| resultado.itens.avisos.erro | Tipo de aviso encontrado durante o processamento deste IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.avisos.mensagem | Mensagem de aviso encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.logContextId | ID de contexto relatado para esta carga. Tipo de dados: cadeia de caracteres |
| relações.resultados | Lista de ICs de relacionamento dependente da matriz relations do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.relations.className | O sys_class_name deste IC de relacionamento dependente. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.relations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: número |
| relações.resultados.erros | Lista de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.inputIndices | Lista de valores de índice para os objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente. Tipo de dados: matriz |
| relacionamentos.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.relations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente. Tipo de dados: matriz |
| resultado.relações.operação | Operação realizada para este IC de relacionamento dependente. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| avisos.relações.resultados | Lista de avisos encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.warnings.error | Tipo de aviso encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.warnings.message | Mensagem de aviso encontrada ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
Envie uma carga que contém um servidor Linux (com pesquisas de item relacionado ao número de série e 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 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 mudanças no banco de dados.
- Cargas úteis parciais
- Caso um item tenha um aviso ou erro, indica se uma operação de item é INSERT_AS_PARTIAL ou INSERT_INCOMPLETE.
- Retorna os sys_ids de cargas parciais que foram mescladas com cargas parciais existentes.
- Oferece suporte ao recurso de desduplicação de carga.
- Gera um resumo.
Formato da URL
URL com controle de versão: /api/now/{api_version}/identifyreconcile/enhanced
URL padrão: /api/now/identifyreconcile/enhanced
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| 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. Por exemplo, para substituir os valores padrão das cargas parciais, confirmações parciais, desduplicar cargas e gerar opções de resumo IRE aprimoradas: partial_payloads:falso,partial_commits:falso,deduplicate_payloads:falso,generate_summary:verdadeiro Nota: Por padrão, ou se partial_payloads estiver definido como verdadeiro, partial_commits e deduplicate_payloads serão habilitados, mesmo se estiverem definidos como falsos, pois esses recursos são essenciais para a funcionalidade de cargas parciais. Para obter mais informações sobre as opções de IRE aprimoradas, consulte Mecanismo de identificação e reconciliação (IRE). Valores válidos para cada par de nome-valor:
Tipo de dados: cadeia de caracteres |
| sysparm_data_source | Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres Padrão: insira a carga da API na tabela de cargas incompletas. |
| Nome | Descrição |
|---|---|
| itens | Lista de ICs a serem criados ou atualizados. Tipo de dados: matriz de objetos |
| itens.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 de objetos |
| itens.pesquisa.NomeDeClasse | 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.pesquisa.id_interno | 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.pesquisar.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 |
| itens.pesquisar.sys_object_source_info.source_feed | Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_name | Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_native_key | Chave/id exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o IC foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.pesquisa.valores | Objeto que descreve os campos deste item de pesquisa como pares de nome/valor, em que o nome é o nome do campo. Tipo de dados: objeto Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como: |
| 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 de objetos |
| itens.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. 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 |
| itens.relacionados.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 exclusivo da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.related.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o item relacionado foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens.configurações | Objeto que contém parâmetros que definem os tipos de atualizações permitidas. Tipo de dados: objeto |
| itens.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:
Padrão: falso |
| itens.configurações.atualizaçãoSemDowngrade | Sinalizador que indica se a atualização e o downgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemTroca | Sinalizador que indica se este IC pode ser atualizado e sua classe alternada. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemUpgrade | Sinalizador que indica se a atualização e o upgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.sys_object_source_info | Objeto que descreve um identificador de IC exclusivo. Tipo de dados: objeto |
| 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 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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens de referência | Lista de referência entre dois itens na carga útil. Tipo de dados: matriz de objetos |
| itensDeReferência.referenciados | O internal_id definido para o item que está sendo referenciado por outro item. Tipo de dados: cadeia de caracteres |
| referenceItems.referencedBy | 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 | Lista de relacionamentos entre dois itens definidos na carga útil. Um objeto nesta matriz pode usar um de dois formatos:
Tipo de dados: matriz de objetos
|
| relações.secundário | Índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento. Tipo de dados: número |
| relações.id_criança | O internal_id do item secundário no relacionamento. Tipo de dados: cadeia de caracteres |
| relações.primário | Í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 |
| relações.sys_rel_source_info.source_name | Nome da origem da descoberta. Padrão: origem de descoberta aprovada no parâmetro de 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 | Tipo de relacionamento existente entre os itens primários e secundários. 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.
| 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. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| 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 "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 |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Lista de resultados produzidos pela consulta. Tipo de dados: matriz |
| result.additionalCommittedItems | Lista de ICs não incluídos na matriz items do corpo da solicitação a ser inserida ou atualizada. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.className | O sys_class_name deste IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errorCount | Número de erros encontrados ao processar este IC adicional. Tipo de dados: número |
| result.additionalCommittedItems.errors | Lista de erros encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.errors.error | Tipo de erro encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errors.message | Mensagem de erro encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts | Lista de tentativas feitas para identificar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC adicional. Valores possíveis:
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 tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC adicional. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedItems.mergedPayloads | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional. Tipo de dados: matriz |
| result.additionalCommittedItems.operation | Operação realizada para este IC adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.sysId | Sys_id encontrado para este IC adicional por meio de identificação. Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings | Lista de avisos encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.warnings.error | Tipo de aviso encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings.message | Mensagem de aviso encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations | Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relations lista para inserir ou atualizar. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.className | O sys_class_name deste IC de relacionamento dependente adicional. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: número |
| result.additionalCommittedRelations.errors | Lista de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.inputIndices | Lista de valores de índice para objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.markers | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedRelations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.operation | Operação realizada para este IC de relacionamento dependente adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| resultado.itens | Lista de ICs incluídos na matriz items do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads]. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| result.items.additionalRelatedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.additionalRelatedItems.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.sysId | Sys_id deste IC relacionado. Tipo de dados: cadeia de caracteres |
| result.items.className | Sys_class_name deste IC. Tipo de dados: cadeia de caracteres |
| Itens.Resultado.PesquisaIndicesDuplicados | 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 items.lookup do corpo da solicitação 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: |
| result.items.errorCount | Número de erros encontrados ao processar este IC. Tipo de dados: número |
| itens.resultados.erros | Lista de erros encontrados ao processar este IC. Tipo de dados: matriz de objetos |
| resultado.itens.erros.erro | Tipo de erro encontrado ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.erros.mensagem | Mensagem de erro encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationTentativas | Lista de tentativas feitas para identificar este IC. Tipo de dados: matriz de objetos |
| result.items.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.attributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.items.info | Lista de informações adicionais sobre o processamento do item. Tipo de dados: matriz de objetos |
| resultado.itens.info.código | Tipo de reclassificação que foi ignorado. Valores possíveis:
|
| resultado.itens.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 |
| Itens.Resultado.InputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC. Tipo de dados: matriz de objetos |
| itens.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC. Tipo de dados: matriz |
| resultado.itens.operação | Operação realizada para este IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.relatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.relatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| Itens.Resultados.Itens.InputIndices | Lista de valores de índice para ICs e itens de pesquisa das matrizes items e items.lookup do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz de objetos |
| Itens.Resultados.Itens.InputIndices.Indiceprincipal | Valor de índice da matriz items do corpo da solicitação que corresponde ao IC primário do item relacionado. Tipo de dados: número |
| Itens.Resultados.Itens.InputIndices.SubIndex | Valor de índice da matriz items.lookup do corpo da solicitação que corresponde ao item relacionado. Tipo de dados: número |
| itens.resultados.itens.relacionados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.relatedItems.mergedPayloadIds | Lista de valores de sys_id para entradas na tabela Cargas Parciais de IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento. Tipo de dados: matriz |
| result.items.relatedSysIds | Lista de valores de sys_id para itens relacionados (itens de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz Valores notáveis:
|
| result.items.sysId | Sys_id encontrado para este IC por meio de identificação. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| avisos.itens.resultados | Lista de avisos encontrados durante o processamento deste IC. Tipo de dados: matriz de objetos |
| resultado.itens.avisos.erro | Tipo de aviso encontrado durante o processamento deste IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.avisos.mensagem | Mensagem de aviso encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.logContextId | ID de contexto relatado para esta carga. Tipo de dados: cadeia de caracteres |
| relações.resultados | Lista de ICs de relacionamento dependente da matriz relations do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.relations.className | O sys_class_name deste IC de relacionamento dependente. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.relations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: número |
| relações.resultados.erros | Lista de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.inputIndices | Lista de valores de índice para os objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente. Tipo de dados: matriz |
| relacionamentos.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.relations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente. Tipo de dados: matriz |
| resultado.relações.operação | Operação realizada para este IC de relacionamento dependente. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| avisos.relações.resultados | Lista de avisos encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.warnings.error | Tipo de aviso encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.warnings.message | Mensagem de aviso encontrada ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
Envie uma carga parcial para um IC de computador.
curl "https://instance.servicenow.com/api/now/identifyreconcile/enhanced" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{ \
"items" : [ \
{ \
"className" : "cmdb_ci_computer", \
"sys_object_source_info" : { \
"source_name" : "ServiceNow", \
"source_native_key" : "ncomputer3367" \
}, \
"values" : { \
"cpu_core_count" : "6", \
"ram" : "8192", \
"manufacturer" : "DELL", \
"company" : "My Company" \
} \
} \
] \
}'
A resposta mostra que a carga foi inserida na tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads].
{
"result": {
"items": [{
"className": "cmdb_ci_computer",
"operation": "INSERT_AS_PARTIAL",
"sysId": "Unknown",
"partialSysIds": ["1aec79151bb45010593876a61a4bcb28"],
"identifierEntrySysId": "Unknown",
"errors": [],
"warnings": [{
"error": "MISSING_MATCHING_ATTRIBUTES",
"message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'"
}],
"identificationAttempts": [{
"info": "sys_object_source NO_MATCH",
"identifierName": "",
"attemptResult": "NO_MATCH",
"attributes": [],
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["serial_number", "serial_number_type"],
"searchOnTable": "cmdb_serial_number",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["serial_number"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["name"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["mac_address", "name"],
"searchOnTable": "cmdb_ci_network_adapter",
"hybridEntryCiAttributes": []
}],
"errorCount": 0,
"markers": [],
"warningCount": 1,
"mergedPayloadIds": ["7ddcb9551bb45010593876a61a4bcb08"],
"inputIndices": [0]
}],
"additionalCommittedItems": [],
"relations": [],
"additionalCommittedRelations": []
}
}
Envie uma segunda carga parcial que conclua a descrição do IC do computador, com a opção IRE aprimorado 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 (inserir/atualizar) a ser executada com a carga especificada (corpo da solicitação), sem confirmar as operações no banco de dados.
Use este endpoint para simular o envio de uma carga útil (corpo da solicitação) para o endpoint Identificação e reconciliação - POST /now/identifyreconcile.
Em vez disso, 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 da URL
URL com controle de versão: /api/now/{api_version}/identifyreconcile/query
URL padrão: /api/now/identifyreconcile/query
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| sysparm_data_source | Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres Padrão: insira a carga da API na tabela de cargas incompletas. |
| Nome | Descrição |
|---|---|
| itens | Lista de ICs a serem criados ou atualizados. Tipo de dados: matriz de objetos |
| itens.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 de objetos |
| itens.pesquisa.NomeDeClasse | 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.pesquisa.id_interno | 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.pesquisar.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 |
| itens.pesquisar.sys_object_source_info.source_feed | Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_name | Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_native_key | Chave/id exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o IC foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.pesquisa.valores | Objeto que descreve os campos deste item de pesquisa como pares de nome/valor, em que o nome é o nome do campo. Tipo de dados: objeto Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como: |
| 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 de objetos |
| itens.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. 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 |
| itens.relacionados.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 exclusivo da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.related.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o item relacionado foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens.configurações | Objeto que contém parâmetros que definem os tipos de atualizações permitidas. Tipo de dados: objeto |
| itens.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:
Padrão: falso |
| itens.configurações.atualizaçãoSemDowngrade | Sinalizador que indica se a atualização e o downgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemTroca | Sinalizador que indica se este IC pode ser atualizado e sua classe alternada. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemUpgrade | Sinalizador que indica se a atualização e o upgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.sys_object_source_info | Objeto que descreve um identificador de IC exclusivo. Tipo de dados: objeto |
| 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 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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens de referência | Lista de referência entre dois itens na carga útil. Tipo de dados: matriz de objetos |
| itensDeReferência.referenciados | O internal_id definido para o item que está sendo referenciado por outro item. Tipo de dados: cadeia de caracteres |
| referenceItems.referencedBy | 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 | Lista de relacionamentos entre dois itens definidos na carga útil. Um objeto nesta matriz pode usar um de dois formatos:
Tipo de dados: matriz de objetos
|
| relações.secundário | Índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento. Tipo de dados: número |
| relações.id_criança | O internal_id do item secundário no relacionamento. Tipo de dados: cadeia de caracteres |
| relações.primário | Í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 |
| relações.sys_rel_source_info.source_name | Nome da origem da descoberta. Padrão: origem de descoberta aprovada no parâmetro de 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 | Tipo de relacionamento existente entre os itens primários e secundários. 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.
| 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. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| 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 | Lista de resultados produzidos pela consulta. Tipo de dados: matriz |
| result.additionalCommittedItems | Lista de ICs não incluídos na matriz items do corpo da solicitação a ser inserida ou atualizada. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.className | O sys_class_name deste IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errorCount | Número de erros encontrados ao processar este IC adicional. Tipo de dados: número |
| result.additionalCommittedItems.errors | Lista de erros encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.errors.error | Tipo de erro encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errors.message | Mensagem de erro encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts | Lista de tentativas feitas para identificar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC adicional. Valores possíveis:
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 tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC adicional. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedItems.mergedPayloads | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional. Tipo de dados: matriz |
| result.additionalCommittedItems.operation | Operação realizada para este IC adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.sysId | Sys_id encontrado para este IC adicional por meio de identificação. Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings | Lista de avisos encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.warnings.error | Tipo de aviso encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings.message | Mensagem de aviso encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations | Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relations lista para inserir ou atualizar. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.className | O sys_class_name deste IC de relacionamento dependente adicional. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: número |
| result.additionalCommittedRelations.errors | Lista de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.inputIndices | Lista de valores de índice para objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.markers | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedRelations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.operation | Operação realizada para este IC de relacionamento dependente adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| resultado.itens | Lista de ICs incluídos na matriz items do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads]. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| result.items.additionalRelatedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.additionalRelatedItems.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.sysId | Sys_id deste IC relacionado. Tipo de dados: cadeia de caracteres |
| result.items.className | Sys_class_name deste IC. Tipo de dados: cadeia de caracteres |
| Itens.Resultado.PesquisaIndicesDuplicados | 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 items.lookup do corpo da solicitação 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: |
| result.items.errorCount | Número de erros encontrados ao processar este IC. Tipo de dados: número |
| itens.resultados.erros | Lista de erros encontrados ao processar este IC. Tipo de dados: matriz de objetos |
| resultado.itens.erros.erro | Tipo de erro encontrado ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.erros.mensagem | Mensagem de erro encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationTentativas | Lista de tentativas feitas para identificar este IC. Tipo de dados: matriz de objetos |
| result.items.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.attributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.items.info | Lista de informações adicionais sobre o processamento do item. Tipo de dados: matriz de objetos |
| resultado.itens.info.código | Tipo de reclassificação que foi ignorado. Valores possíveis:
|
| resultado.itens.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 |
| Itens.Resultado.InputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC. Tipo de dados: matriz de objetos |
| itens.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC. Tipo de dados: matriz |
| resultado.itens.operação | Operação realizada para este IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.relatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.relatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| Itens.Resultados.Itens.InputIndices | Lista de valores de índice para ICs e itens de pesquisa das matrizes items e items.lookup do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz de objetos |
| Itens.Resultados.Itens.InputIndices.Indiceprincipal | Valor de índice da matriz items do corpo da solicitação que corresponde ao IC primário do item relacionado. Tipo de dados: número |
| Itens.Resultados.Itens.InputIndices.SubIndex | Valor de índice da matriz items.lookup do corpo da solicitação que corresponde ao item relacionado. Tipo de dados: número |
| itens.resultados.itens.relacionados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.relatedItems.mergedPayloadIds | Lista de valores de sys_id para entradas na tabela Cargas Parciais de IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento. Tipo de dados: matriz |
| result.items.relatedSysIds | Lista de valores de sys_id para itens relacionados (itens de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz Valores notáveis:
|
| result.items.sysId | Sys_id encontrado para este IC por meio de identificação. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| avisos.itens.resultados | Lista de avisos encontrados durante o processamento deste IC. Tipo de dados: matriz de objetos |
| resultado.itens.avisos.erro | Tipo de aviso encontrado durante o processamento deste IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.avisos.mensagem | Mensagem de aviso encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.logContextId | ID de contexto relatado para esta carga. Tipo de dados: cadeia de caracteres |
| relações.resultados | Lista de ICs de relacionamento dependente da matriz relations do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.relations.className | O sys_class_name deste IC de relacionamento dependente. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.relations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: número |
| relações.resultados.erros | Lista de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.inputIndices | Lista de valores de índice para os objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente. Tipo de dados: matriz |
| relacionamentos.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.relations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente. Tipo de dados: matriz |
| resultado.relações.operação | Operação realizada para este IC de relacionamento dependente. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| avisos.relações.resultados | Lista de avisos encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.warnings.error | Tipo de aviso encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.warnings.message | 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 que contém um servidor Linux (com pesquisas de itens relacionados ao número de série e do adaptador de rede) e um comutador de IP, com um relacionamento de conexão de 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 (inserir/atualizar) a ser executada com a carga especificada (corpo da solicitação), sem confirmar as operações no banco de dados.
Use este endpoint para simular o envio de uma carga útil (corpo da solicitação) para o endpoint Identificação e reconciliação - POST /now/identifyreconcile/enhanced.
- Cargas úteis parciais
- Caso um item tenha um aviso ou erro, indica se uma operação de item é INSERT_AS_PARTIAL ou INSERT_INCOMPLETE.
- Retorna os sys_ids de cargas parciais que foram mescladas com cargas parciais existentes.
- Oferece suporte ao recurso de desduplicação de carga.
- Gera um resumo.
Formato da URL
URL com controle de versão: /api/now/{api_version}/identifyreconcile/queryEnhanced
URL padrão: /api/now/identifyreconcile/queryEnhanced
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| 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. Por exemplo, para substituir os valores padrão das cargas parciais, confirmações parciais, desduplicar cargas e gerar opções de resumo IRE aprimoradas: partial_payloads:falso,partial_commits:falso,deduplicate_payloads:falso,generate_summary:verdadeiro Nota: Por padrão, ou se partial_payloads estiver definido como verdadeiro, partial_commits e deduplicate_payloads serão habilitados, mesmo se estiverem definidos como falsos, pois esses recursos são essenciais para a funcionalidade de cargas parciais. Para obter mais informações sobre as opções de IRE aprimoradas, consulte Mecanismo de identificação e reconciliação (IRE). Valores válidos para cada par de nome-valor:
Tipo de dados: cadeia de caracteres |
| sysparm_data_source | Origem das informações de IC. Este deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres Padrão: insira a carga da API na tabela de cargas incompletas. |
| Nome | Descrição |
|---|---|
| itens | Lista de ICs a serem criados ou atualizados. Tipo de dados: matriz de objetos |
| itens.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 de objetos |
| itens.pesquisa.NomeDeClasse | 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.pesquisa.id_interno | 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.pesquisar.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 |
| itens.pesquisar.sys_object_source_info.source_feed | Nome que identifica exclusivamente o feed que envia este IC. Use se a origem puder ter vários feeds. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_name | Fonte de dados para as informações de IC. Este valor deve ser um dos valores de opção definidos para o campo discovery_source da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_native_key | Chave/id exclusiva da origem do IC. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.lookup.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o IC foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.pesquisa.valores | Objeto que descreve os campos deste item de pesquisa como pares de nome/valor, em que o nome é o nome do campo. Tipo de dados: objeto Os nomes e tipos de campo dependem dos campos selecionados pelo usuário, como: |
| 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 de objetos |
| itens.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. 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 |
| itens.relacionados.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 exclusivo da origem do item relacionado. Pode ser qualquer cadeia de caracteres exclusiva do item. Tipo de dados: cadeia de caracteres |
| itens.related.sys_object_source_info.source_recency_timestamp | Data e hora UTC em que o item relacionado foi verificado. Tipo de dados: cadeia de caracteres Formato: AAAA-MM-DD hh:mm:ss |
| itens.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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens.configurações | Objeto que contém parâmetros que definem os tipos de atualizações permitidas. Tipo de dados: objeto |
| itens.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:
Padrão: falso |
| itens.configurações.atualizaçãoSemDowngrade | Sinalizador que indica se a atualização e o downgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemTroca | Sinalizador que indica se este IC pode ser atualizado e sua classe alternada. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.configurações.atualizaçãoSemUpgrade | Sinalizador que indica se a atualização e o upgrade são permitidos para este IC. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| itens.sys_object_source_info | Objeto que descreve um identificador de IC exclusivo. Tipo de dados: objeto |
| 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 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 tipos de campo dependem dos campos selecionados pelo usuário, como: |
| itens de referência | Lista de referência entre dois itens na carga útil. Tipo de dados: matriz de objetos |
| itensDeReferência.referenciados | O internal_id definido para o item que está sendo referenciado por outro item. Tipo de dados: cadeia de caracteres |
| referenceItems.referencedBy | 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 | Lista de relacionamentos entre dois itens definidos na carga útil. Um objeto nesta matriz pode usar um de dois formatos:
Tipo de dados: matriz de objetos
|
| relações.secundário | Índice inteiro do objeto de IC na matriz items que representa o secundário no relacionamento. Tipo de dados: número |
| relações.id_criança | O internal_id do item secundário no relacionamento. Tipo de dados: cadeia de caracteres |
| relações.primário | Í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 |
| relações.sys_rel_source_info.source_name | Nome da origem da descoberta. Padrão: origem de descoberta aprovada no parâmetro de 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 | Tipo de relacionamento existente entre os itens primários e secundários. 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.
| 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. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| 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 "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 |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Lista de resultados produzidos pela consulta. Tipo de dados: matriz |
| result.additionalCommittedItems | Lista de ICs não incluídos na matriz items do corpo da solicitação a ser inserida ou atualizada. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.className | O sys_class_name deste IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errorCount | Número de erros encontrados ao processar este IC adicional. Tipo de dados: número |
| result.additionalCommittedItems.errors | Lista de erros encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.errors.error | Tipo de erro encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.errors.message | Mensagem de erro encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts | Lista de tentativas feitas para identificar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC adicional. Valores possíveis:
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 tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC adicional. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.additionalCommittedItems.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC adicional. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedItems.mergedPayloads | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC adicional. Tipo de dados: matriz |
| result.additionalCommittedItems.operation | Operação realizada para este IC adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.sysId | Sys_id encontrado para este IC adicional por meio de identificação. Valores notáveis: Desconhecido - Falha na identificação deste IC adicional. Consulte errors para obter detalhes. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings | Lista de avisos encontrados ao processar este IC adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedItems.warnings.error | Tipo de aviso encontrado ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedItems.warnings.message | Mensagem de aviso encontrada ao processar este IC adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations | Lista de ICs de relacionamento dependente não incluídos no corpo da solicitação relations lista para inserir ou atualizar. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.className | O sys_class_name deste IC de relacionamento dependente adicional. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: número |
| result.additionalCommittedRelations.errors | Lista de erros encontrados ao processar este IC de relacionamento dependente adicional. Tipo de dados: matriz de objetos |
| result.additionalCommittedRelations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente adicional. Tipo de dados: cadeia de caracteres |
| result.additionalCommittedRelations.inputIndices | Lista de valores de índice para objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.markers | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.additionalCommittedRelations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente adicional. Tipo de dados: matriz |
| result.additionalCommittedRelations.operation | Operação realizada para este IC de relacionamento dependente adicional. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| resultado.itens | Lista de ICs incluídos na matriz items do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads]. Tipo de dados: matriz de objetos |
| result.items.additionalRelatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| result.items.additionalRelatedItems.inputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.additionalRelatedItems.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste item relacionado. Tipo de dados: matriz |
| result.items.additionalRelatedItems.sysId | Sys_id deste IC relacionado. Tipo de dados: cadeia de caracteres |
| result.items.className | Sys_class_name deste IC. Tipo de dados: cadeia de caracteres |
| Itens.Resultado.PesquisaIndicesDuplicados | 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 items.lookup do corpo da solicitação 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: |
| result.items.errorCount | Número de erros encontrados ao processar este IC. Tipo de dados: número |
| itens.resultados.erros | Lista de erros encontrados ao processar este IC. Tipo de dados: matriz de objetos |
| resultado.itens.erros.erro | Tipo de erro encontrado ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.erros.mensagem | Mensagem de erro encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationTentativas | Lista de tentativas feitas para identificar este IC. Tipo de dados: matriz de objetos |
| result.items.identificationAttempts.attemptResult | Resultado desta tentativa de identificação de IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.attributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.hybridEntryCiAttributes | Lista de atributos de entrada de identificador de IC usados durante esta tentativa de identificação de IC. Tipo de dados: matriz Os nomes e tipos de atributo dependem dos dados do corpo da solicitação e do identificador em uso, como: |
| result.items.identificationAttempts.identifierName | Regra de identificador usada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identificationAttempts.searchOnTable | Nome da tabela pesquisada para esta tentativa de identificação de IC. Tipo de dados: cadeia de caracteres |
| result.items.identifierEntrySysId | Sys_id da regra do identificador usada para identificar este IC. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| result.items.info | Lista de informações adicionais sobre o processamento do item. Tipo de dados: matriz de objetos |
| resultado.itens.info.código | Tipo de reclassificação que foi ignorado. Valores possíveis:
|
| resultado.itens.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 |
| Itens.Resultado.InputIndices | Lista de valores de índice para ICs da matriz items do corpo da solicitação que correspondem a este IC. Tipo de dados: matriz de objetos |
| itens.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC. Tipo de dados: matriz |
| resultado.itens.operação | Operação realizada para este IC. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.items.relatedItems | Lista de ICs relacionados (IC de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.items.relatedItems.className | O sys_class_name do item relacionado. Tipo de dados: cadeia de caracteres |
| Itens.Resultados.Itens.InputIndices | Lista de valores de índice para ICs e itens de pesquisa das matrizes items e items.lookup do corpo da solicitação que correspondem a este item relacionado. Tipo de dados: matriz de objetos |
| Itens.Resultados.Itens.InputIndices.Indiceprincipal | Valor de índice da matriz items do corpo da solicitação que corresponde ao IC primário do item relacionado. Tipo de dados: número |
| Itens.Resultados.Itens.InputIndices.SubIndex | Valor de índice da matriz items.lookup do corpo da solicitação que corresponde ao item relacionado. Tipo de dados: número |
| itens.resultados.itens.relacionados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.items.relatedItems.mergedPayloadIds | Lista de valores de sys_id para entradas na tabela Cargas Parciais de IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas neste IC durante o processamento. Tipo de dados: matriz |
| result.items.relatedSysIds | Lista de valores de sys_id para itens relacionados (itens de pesquisa de tabela) da matriz items.lookup do corpo da solicitação. Tipo de dados: matriz Valores notáveis:
|
| result.items.sysId | Sys_id encontrado para este IC por meio de identificação. Valores notáveis:
Tipo de dados: cadeia de caracteres |
| avisos.itens.resultados | Lista de avisos encontrados durante o processamento deste IC. Tipo de dados: matriz de objetos |
| resultado.itens.avisos.erro | Tipo de aviso encontrado durante o processamento deste IC. Tipo de dados: cadeia de caracteres |
| resultado.itens.avisos.mensagem | Mensagem de aviso encontrada ao processar este IC. Tipo de dados: cadeia de caracteres |
| resultado.logContextId | ID de contexto relatado para esta carga. Tipo de dados: cadeia de caracteres |
| relações.resultados | Lista de ICs de relacionamento dependente da matriz relations do corpo da solicitação. Tipo de dados: matriz de objetos |
| result.relations.className | O sys_class_name deste IC de relacionamento dependente. Somente valor compatível:
Tipo de dados: cadeia de caracteres |
| result.relations.errorCount | Número de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: número |
| relações.resultados.erros | Lista de erros encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.errors.error | Tipo de erro encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.errors.message | Mensagem de erro encontrada ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.inputIndices | Lista de valores de índice para os objetos de IC de relacionamento dependente na matriz relations do corpo da solicitação que correspondem a este IC de relacionamento dependente. Tipo de dados: matriz |
| relacionamentos.resultados.marcadores | Lista de valores de marcador para uso interno. Tipo de dados: matriz |
| result.relations.mergedPayloadIds | Lista de valores de sys_id para cargas parciais da tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads] que foram mescladas durante o processamento deste IC de relacionamento dependente. Tipo de dados: matriz |
| resultado.relações.operação | Operação realizada para este IC de relacionamento dependente. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| avisos.relações.resultados | Lista de avisos encontrados ao processar este IC de relacionamento dependente. Tipo de dados: matriz de objetos |
| result.relations.warnings.error | Tipo de aviso encontrado ao processar este IC de relacionamento dependente. Tipo de dados: cadeia de caracteres |
| result.relations.warnings.message | 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 seria inserida na tabela Cargas Parciais do IRE do CMDB [cmdb_ire_partial_payloads].
{
"result": {
"relations": [],
"items": [
{
"identifierEntrySysId": "Unknown",
"partialSysIds": [
"1aec79151bb45010593876a61a4bcb28"
],
"sysId": "Unknown",
"errorCount": 0,
"markers": [],
"className": "cmdb_ci_computer",
"inputIndices": [
0
],
"operation": "INSERT_AS_PARTIAL",
"errors": [],
"identificationAttempts": [
{
"info": "sys_object_source NO_MATCH",
"attemptResult": "NO_MATCH",
"identifierName": "",
"attributes": [],
"hybridEntryCiAttributes": []
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number",
"serial_number_type"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_serial_number"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"mac_address",
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_network_adapter"
}
],
"warningCount": 1,
"warnings": [
{
"message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'",
"error": "MISSING_MATCHING_ATTRIBUTES"
}
],
"mergedPayloadIds": [
"7ddcb9551bb45010593876a61a4bcb08"
]
}
],
"additionalCommittedRelations": [],
"additionalCommittedItems": []
}
}
Simule o envio de uma segunda carga parcial que concluiria a descrição do IC do computador, com a opção de IRE aprimorado de geração de resumo habilitada.
curl "https://instance.servicenow.com/api/now/identifyreconcile/queryEnhanced?options=generate_summary:true" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{ \
}'
A resposta mostra que o IC do computador seria inserido e exibe um resumo das operações que seriam realizadas.
{
"result": {
"relations": [],
"hasError": false,
"additionalCommittedItems": [],
"hasWarning": false,
"items": [
{
"relatedSysIds": [
"735c79151bb45010593876a61a4bcb67"
],
"identifierEntrySysId": "Unknown",
"sysId": "ff5c79151bb45010593876a61a4bcb64",
"errorCount": 0,
"markers": [],
"className": "cmdb_ci_computer",
"inputIndices": [
0
],
"operation": "INSERT",
"relatedItems": [
{
"operation": "INSERT",
"warningCount": 0,
"errors": [],
"sysId": "735c79151bb45010593876a61a4bcb67",
"className": "cmdb_ci_network_adapter",
"errorCount": 0,
"markers": [],
"inputIndices": [
{
"subIndex": 0,
"mainIndex": 0
}
],
"mergedPayloadIds": []
}
],
"mergedPayloadIds": [
"fe4c39151bb45010593876a61a4bcbd3"
],
"identificationAttempts": [
{
"info": "sys_object_source NO_MATCH",
"attemptResult": "NO_MATCH",
"identifierName": "",
"attributes": [],
"hybridEntryCiAttributes": []
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number",
"serial_number_type"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_serial_number"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "NO_MATCH",
"identifierName": "Hardware Rule",
"attributes": [
"mac_address",
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_network_adapter"
}
],
"warningCount": 0
}
],
"additionalCommittedRelations": [],
"summary": {
"cmdb_ci_network_adapter": {
"mergedPartialPayloads": 0,
"inserted": 1,
"partial": 0,
"warnings": 0,
"incomplete": 0,
"additionalInserted": 0,
"unchanged": 0,
"skipped": 0,
"updated": 0,
"errors": 0
},
"cmdb_ci_computer": {
"mergedPartialPayloads": 1,
"inserted": 1,
"partial": 0,
"warnings": 0,
"incomplete": 0,
"additionalInserted": 0,
"unchanged": 0,
"skipped": 0,
"updated": 0,
"errors": 0
}
}
}
}