API CMDBQBScopedScriptableAPI - Com escopo

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 8 min. de leitura

    • Fornece métodos para executar Configuration Management Database (CMDB) Operações do Construtor de consultas em scripts do lado do servidor.

    Esta API é o equivalente no escopo CMDBQueryBuilderAPI - Global.

    Esta API requer o plug-in Gestão de configurações para aplicações com escopo (com.snc.cmdb.escopo) e é fornecida no sn_cmdb namespace.

    Para obter mais informações sobre CMDB Construtor de consultas, consulte CMDB Query Builder.

    CMDBQBScopedScriptableAPI - createReport(cadeia de caracteres savedQueryId, cadeia de caracteres savedQueryName)

    Cria um relatório que mostra os resultados de um Configuration Management Database (CMDB) O Construtor de consultas consulta e retorna o URL do relatório.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    savedQueryId Cadeia de caracteres Sys_id da consulta a ser usada para o relatório.

    Este parâmetro não será necessário se um nome de consulta for fornecido.

    Tabela: Consultas salvas [qb_saved_query]
    NomeConsulta salva Cadeia de caracteres Nome da consulta a ser usada para o relatório.

    Este parâmetro não será necessário se um sys_id de consulta for fornecido.

    Tabela: Salva em Nome Campo da tabela de consultas salvas [qb_saved_query].
    Tabela 2. Retornos
    Tipo Descrição
    Objeto Detalhes sobre o relatório criado e quaisquer erros.
    {
  "error": "String",
  "message": "String",
  "status": "String"
}
    <Object>.erro Código de erro. Retornado quando a criação do relatório falha ou parâmetros de entrada inválidos são fornecidos.

    Possíveis erros:

    • USER_NOT_AUTHORIZED_EXCEPTION
    • INVALID_PARAM
    • QUERY_SYS_ID_INVALID
    • REPORT_INELIGIBLE

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem que contém detalhes sobre o sucesso ou falha da criação do relatório.
    Possíveis mensagens:
    • <report-url>
    • O usuário não está autorizado a criar um relatório de consulta do CMDBQueryBuilder
    • Parâmetros inválidos. Forneça um SYSID válido ou um nome válido de uma consulta salva
    • Query Id inválido. Forneça um ID de consulta salva válido
    • A consulta deve ter uma programação com pelo menos uma execução para criar um relatório.
    Consulte também Schedule a CMDB query.

    Tipo de dados: Cadeia de caracteres
    <Object>.status Código de status. Retornado quando a atualização é bem-sucedida.

    Valor: sucesso

    Tipo de dados: Cadeia de caracteres

    Este exemplo mostra como criar um relatório aprovando um nome de consulta salvo.

    var queryReport = sn_cmdb.CMDBQBScopedScriptableAPI.createReport('','CMDBQueryTest1');

gs.info(JSON.stringify(queryReport, null, 2));

    Saída:

    {
   "message":"\/sys_report_template.do?sysparm_report_source_id=6d299cf81bbd4210bccf42a3b24bcb7a&sysparm_type=list&sysparm_title=CMDBQueryTest1&sysparm_source_type=source&sysparm_from_list=true&sysparm_chart_size=large&sysparm_manual_labor=true",
   "status":"success"
}

    Este exemplo mostra um erro quando o sys_id e o nome da consulta estão ausentes na chamada do método.

    var queryReport = sn_cmdb.CMDBQBScopedScriptableAPI.createReport('', '');

gs.info(JSON.stringify(queryReport, null, 2));

    Saída:

    {
   "error":"INVALID_PARAM",
   "message":"Invalid Parameters. Please provide either a valid sysId or a valid name of a saved query"
}

    CMDBQBScopedScriptableAPI - deleteQuery(cadeia de caracteres savedQueryId, cadeia de caracteres savedQueryName)

    Exclui um Configuration Management Database (CMDB) Consulta do Construtor de consultas.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    savedQueryId Cadeia de caracteres Sys_id da consulta a ser excluída.

    Este parâmetro pode ser fornecido como uma cadeia de caracteres vazia se um nome de consulta for fornecido.

    Tabela: Consultas salvas [qb_saved_query]
    NomeConsulta salva Cadeia de caracteres Nome da consulta a ser excluída.

    Este parâmetro não será necessário se um sys_id de consulta for fornecido.

    Tabela: Salva em Nome Campo da tabela de consultas salvas [qb_saved_query].
    Tabela 4. Retornos
    Tipo Descrição
    Objeto Detalhes sobre a consulta excluída e quaisquer erros.
    {
  "error": "String",
  "message": "String",
  "status": "String"
}
    <Object>.erro Código de erro. Retornado quando a operação de exclusão falha ou parâmetros de entrada inválidos são fornecidos.

    Possíveis erros:

    • USER_NOT_AUTHORIZED_EXCEPTION
    • INVALID_PARAM
    • QUERY_DELETE_FAILED

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem que contém detalhes sobre o sucesso ou falha da operação de exclusão.

    Possíveis mensagens:

    • Consulta salva excluída com sucesso
    • O usuário não está autorizado a excluir uma consulta CMDBQueryBuilder
    • Parâmetros inválidos. Forneça um SYSID válido ou um nome válido de uma consulta salva
    • Falha ao excluir a consulta salva fornecida

    Tipo de dados: Cadeia de caracteres
    <Object>.status Código de status. Retornado quando a atualização é bem-sucedida.

    Valor: sucesso

    Tipo de dados: Cadeia de caracteres

    Este exemplo mostra como excluir uma consulta salva passando o nome da consulta.

    var delQuery = sn_cmdb.CMDBQBScopedScriptableAPI.deleteQuery('', 'CMDBQueryTest1');

gs.info(JSON.stringify(delQuery, null, 2));

    Saída:

    {
   "message":"Successfully deleted the saved query",
   "status":"success"
}

    Este exemplo mostra um erro quando o sys_id e o nome da consulta estão ausentes na chamada do método.

    var delQuery = sn_cmdb.CMDBQBScopedScriptableAPI.deleteQuery('', '');

gs.info(JSON.stringify(delQuery, null, 2));

    Saída:

    {
   "error":"INVALID_PARAM",
   "message":"Invalid Parameters. Please provide either a valid sysId or a valid name of a saved query"
}

    CMDBQBScopedScriptableAPI - getSavedQueryExecutionDetails(Cadeia de caracteres savedQueryName, Boolian executeQuery, Number timeout)

    Retorna os detalhes de execução de um Configuration Management Database (CMDB) Consulta do Construtor de consultas.

    Como opção, você pode executar a consulta para retornar os detalhes da execução atual.

    Se ocorrer um problema de tempo limite ou memória durante a execução da consulta, você poderá ajustar o tamanho do lote de consulta para ajudar a aliviar esses problemas. Para obter mais informações, consulte Tamanho do lote para consultas salvas do Construtor de consultas .

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    NomeConsulta salva Cadeia de caracteres Nome da consulta para a qual recuperar detalhes de execução.

    Tabela: Nome Campo na tabela Consultas salvas [qb_saved_query].
    ExecuteQuery Booliano Opcional. Sinalizador que indica se a consulta especificada deve ser executada.

    Valores válidos:

    • Verdadeiro: Execute a consulta especificada e retorne os detalhes de execução.
    • Falso: Não execute a consulta especificada. Retorna os detalhes de execução mais recentes da consulta.

    Padrão: falso
    tempo limite Número Opcional. Valor inteiro que substitui o limite de tempo limite de execução de consulta padrão de cinco minutos.

    Unidade: segundos

    Padrão: Cinco minutos
    Tabela 6. Retornos
    Tipo Descrição
    Objeto Detalhes sobre a execução da consulta e quaisquer erros.
    {
  "error": "String",
  "execution_batch_size": Number,
  "message": "String",
  "query_id": "String",
  "status": "String",
  "table_name": "String"
}
    <Object>.erro Código de erro. Retornado quando a execução da consulta falha ou a consulta especificada não é encontrada.

    Possíveis erros:

    • QUERY_EXECUTION_NOT_FOUND
    • QUERY_NOT_FOUND
    • QUERY_EXECUTION_FAILED
    • USER_NOT_AUTHORIZED_EXCEPTION

    Tipo de dados: Cadeia de caracteres
    <Object>.execution_batch_size Tamanho do lote de 100 alocado para a execução da consulta. Este valor retornará somente se executeQueryo parâmetro é verdadeiro. Consulte também Batch size for CMDB Query Builder queries.

    Tipo de dados: Número
    <Object>.mensagem Mensagem que contém detalhes sobre o código de erro. Retornado quando a execução da consulta falha ou a consulta especificada não é encontrada.

    Possíveis mensagens:

    • Detalhes da execução da consulta não encontrados. Execute a consulta.
    • A consulta salva fornecida não foi encontrada. Certifique-se de passar o nome de uma consulta salva.
    • Falha na execução da consulta. Use uma consulta válida.
    • O usuário não está autorizado a executar uma consulta CMDBQueryBuilder.

    Tipo de dados: Cadeia de caracteres
    <Object>.query_id Sys_id da execução da consulta.

    Tipo de dados: Cadeia de caracteres

    Tabela: Status da consulta [qb_query_status]
    <Object>.status Status da execução da consulta.
    • CONCLUÍDO: A execução foi concluída.
    • FALHA: Ocorreu um erro ao executar a consulta.
    • TIME_OUT: A execução da consulta atingiu o tempo limite.
    • MAX_LIMIT: Número máximo de resultados de retorno atingido.

    Tipo de dados: Cadeia de caracteres
    <Object>.table_name Nome da tabela que contém os detalhes da execução da consulta.

    Tipo de dados: Cadeia de caracteres

    Este exemplo mostra como executar uma consulta salva e definir o valor do tempo limite de execução da consulta como 10 minutos.

    var savedQuery = sn_cmdb.CMDBQBScopedScriptableAPI.getSavedQueryExecutionDetails('CMDBQueryTest1', true, 600);

gs.info(JSON.stringify(savedQuery, null, 2));

    Saída:

    {
   "execution_batch_size": 100,
   "query_id":"024fd53a7773330033b5270bba106141",
   "table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
   "status":COMPLETE
}

    CMDBQBScopedScriptableAPI - saveQuery(cadeia de caracteres savedQueryName, cadeia de caracteres queryJson)

    Salva um Configuration Management Database (CMDB) Consulta do Construtor de consultas e retorna o sys_id da consulta salva.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    NomeConsulta salva Cadeia de caracteres Nome em que salvar a consulta.

    Tabela: Salva em Nome Campo da tabela de consultas salvas [qb_saved_query].
    Json Cadeia de caracteres JSON que define a consulta.

    Tabela: Salva em Consulta Campo da tabela de consultas salvas [qb_saved_query].
    Tabela 8. Retornos
    Tipo Descrição
    Objeto Objeto que contém detalhes sobre a consulta salva e quaisquer erros.
    {
   "error": "String",
   "message": "String",
   "status": "String"
}
    <Object>.erro Código de erro. Retornado quando a operação de salvamento falha ou parâmetros de entrada inválidos são fornecidos.

    Possíveis erros:

    • USER_NOT_AUTHORIZED_EXCEPTION
    • QUERY_NAME_INVALID
    • QUERY_INVALID
    • QUERY_EXISTS_ALREADY
    • QUERY_SAVE_FAILED

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem que contém detalhes sobre o sucesso ou falha da operação de salvamento.

    Possíveis mensagens:

    • A consulta foi salva com sucesso com o SYSID <sy_id>
    • O usuário não está autorizado a salvar uma consulta CMDBQueryBuilder
    • O nome da consulta está vazio. Forneça um nome
    • QueryJson é inválido. Forneça uma queryJson válida
    • O nome da consulta já está sendo usado. Use um nome diferente
    • Exceção inesperada ao salvar a consulta

    Tipo de dados: Cadeia de caracteres
    <Object>.status Código de status. Retornado quando a operação de salvamento é bem-sucedida.

    Valor: sucesso

    Tipo de dados: Cadeia de caracteres

    Este exemplo mostra como adicionar uma consulta à tabela Consultas salvas [qb_saved_query].

    var queryJson = "{\"type\":\"cmdb\",\"nodes\":[{\"label\":\"Server\",\"unique_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_server\",\"ci_type_label\":\"Server\",\"sys_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"x\":72,\"y\":337,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":true,\"nodeId\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"name\":\"Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"className\":\"cmdb_ci_server\"},{\"label\":\"Database\",\"unique_id\":\"b640269c1b310210bccf42a3b24bcb36\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/database.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_database\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_database\",\"ci_type_label\":\"Database\",\"sys_id\":\"b640269c1b310210bccf42a3b24bcb36\",\"x\":510,\"y\":340,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":false,\"nodeId\":\"b640269c1b310210bccf42a3b24bcb36_4_23_2024_5_50_57\",\"name\":\"Database 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"b640269c1b310210bccf42a3b24bcb36_4_23_2024_5_50_57\",\"className\":\"cmdb_ci_database\"}],\"edges\":[{\"id\":\"Server 1_Database 1\",\"from\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"to\":\"b640269c1b310210bccf42a3b24bcb36_4_23_2024_5_50_57\",\"isDotted\":false,\"type\":\"relation\",\"isReverse\":false,\"direction\":\"outbound\",\"hiddenLevel\":0,\"relations\":[\"607ad1b2c0a8010e01941856b365af90\",\"1a9cb166f1571100a92eb60da2bce5c5\"]}],\"usedNames\":{\"cmdb_ci_server\":1,\"cmdb_ci_database\":1}}";

var newQuery = sn_cmdb.CMDBQBScopedScriptableAPI.saveQuery('CMDBQueryTest1', queryJson);

gs.info(JSON.stringify(newQuery, null, 2));

    Saída:

    {
   "message":"Successfully saved the query with sysId d93f96981b310210bccf42a3b24bcb41",
   "status":"success"
}

    Este exemplo mostra um erro quando uma consulta JSON inválida é fornecida.

    var queryJson = "Test";
var newQuery = sn_cmdb.CMDBQBScopedScriptableAPI.saveQuery('Test', queryJson);

gs.info(JSON.stringify(newQuery, null, 2));

    Saída:

    {
   "error":"QUERY_INVALID",
   "message":"QueryJson is invalid. Please provide a valid queryJson"
}

    CMDBQBScopedScriptableAPI - updateQuery(cadeia de caracteres savedQueryId, cadeia de caracteres savedQueryJson)

    Atualiza o JSON de um Configuration Management Database (CMDB) Consulta do Construtor de consultas.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    savedQueryId Cadeia de caracteres Sys_id da consulta a ser atualizada.

    Este parâmetro não será necessário se um nome de consulta for fornecido.

    Tabela: Consultas salvas [qb_saved_query]
    NomeConsulta salva Cadeia de caracteres Nome da consulta a ser atualizada.

    Este parâmetro não será necessário se um sys_id de consulta for fornecido.

    Tabela: Salva em Nome Campo na tabela Consultas salvas [qb_saved_query].
    Json Cadeia de caracteres JSON para atualizar a consulta.

    Tabela: Salva em Consulta Campo na tabela Consultas salvas [qb_saved_query].
    Tabela 10. Retornos
    Tipo Descrição
    Objeto Detalhes sobre a consulta atualizada e quaisquer erros.
    {
  "error": "String",
  "message": "String",
  "status": "String"
}
    <Object>.erro Código de erro. Retornado quando a atualização falha ou parâmetros de entrada inválidos são fornecidos.

    Possíveis erros:

    • USER_NOT_AUTHORIZED_EXCEPTION
    • INVALID_PARAM
    • QUERY_INVALID
    • QUERY_UPDATE_FAILED
    • UNAUTHORIZED_REPORT_SOURCE_USER

    Tipo de dados: Cadeia de caracteres
    <Object>.mensagem Mensagem que contém detalhes sobre o sucesso ou falha da atualização.

    Possíveis mensagens:

    • Consulta salva atualizada com sucesso
    • O usuário não está autorizado a atualizar uma consulta CMDBQueryBuilder
    • Parâmetros inválidos. Forneça um SYSID válido ou um nome válido de uma consulta salva
    • QueryJson é inválido. Forneça uma queryJson válida
    • Falha ao atualizar a consulta salva fornecida
    • O usuário não está autorizado a atualizar a origem do relatório de uma consulta salva

    Tipo de dados: Cadeia de caracteres
    <Object>.status Código de status. Retornado quando a atualização é bem-sucedida.

    Valor: sucesso

    Tipo de dados: Cadeia de caracteres

    Este exemplo mostra como atualizar uma consulta salva passando o nome da consulta.

    var queryJson = "{\"type\":\"cmdb\",\"nodes\":[{\"label\":\"Server\",\"unique_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_server\",\"ci_type_label\":\"Server\",\"sys_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"x\":72,\"y\":336,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":true,\"nodeId\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"name\":\"Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"className\":\"cmdb_ci_server\"},{\"label\":\"Web Server\",\"unique_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/web_server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_web_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_web_server\",\"ci_type_label\":\"Web Server\",\"sys_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"x\":446,\"y\":330,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":false,\"nodeId\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"name\":\"Web Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"className\":\"cmdb_ci_web_server\"}],\"edges\":[{\"id\":\"Server 1_Web Server 1\",\"from\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"to\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"isDotted\":false,\"type\":\"relation\",\"isReverse\":false,\"direction\":\"outbound\",\"hiddenLevel\":0,\"relations\":[\"607ad1b2c0a8010e01941856b365af90\"]}],\"usedNames\":{\"cmdb_ci_server\":1,\"cmdb_ci_database\":1,\"cmdb_ci_web_server\":1}}";

var queryUpdate = sn_cmdb.CMDBQBScopedScriptableAPI.updateQuery('', 'CMDBQueryTest1', queryJson); 

gs.info(JSON.stringify(queryUpdate, null, 2));

    Saída:

    {
   "message":"Successfully updated the saved query",
   "status":"success"
}

    Este exemplo mostra um erro quando o sys_id e o nome da consulta estão ausentes na chamada do método.

    var queryJson = "{\"type\":\"cmdb\",\"nodes\":[{\"label\":\"Server\",\"unique_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_server\",\"ci_type_label\":\"Server\",\"sys_id\":\"d93f96981b310210bccf42a3b24bcb41\",\"x\":72,\"y\":336,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":true,\"nodeId\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"name\":\"Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"className\":\"cmdb_ci_server\"},{\"label\":\"Web Server\",\"unique_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"nodeType\":\"class\",\"image\":\"images/app.ngbsm/web_server.svg\",\"properties\":\"\",\"allowed_connections\":[],\"filters\":{\"platform\":\"cmdb_ci_web_server\",\"custom\":\"\"},\"ci_type\":\"cmdb_ci_web_server\",\"ci_type_label\":\"Web Server\",\"sys_id\":\"984f5a981b310210bccf42a3b24bcb03\",\"x\":446,\"y\":330,\"returnValues\":[],\"filters_attrib\":\"\",\"applied_filters\":\"\",\"isStartNode\":false,\"nodeId\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"name\":\"Web Server 1\",\"type\":\"class\",\"refFilterApplied\":false,\"focused\":false,\"id\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"className\":\"cmdb_ci_web_server\"}],\"edges\":[{\"id\":\"Server 1_Web Server 1\",\"from\":\"d93f96981b310210bccf42a3b24bcb41_4_23_2024_5_50_54\",\"to\":\"984f5a981b310210bccf42a3b24bcb03_4_23_2024_6_32_19\",\"isDotted\":false,\"type\":\"relation\",\"isReverse\":false,\"direction\":\"outbound\",\"hiddenLevel\":0,\"relations\":[\"607ad1b2c0a8010e01941856b365af90\"]}],\"usedNames\":{\"cmdb_ci_server\":1,\"cmdb_ci_database\":1,\"cmdb_ci_web_server\":1}}";

var queryUpdate = sn_cmdb.CMDBQBScopedScriptableAPI.updateQuery('', '', queryJson);

gs.info(JSON.stringify(queryUpdate, null, 2));

    Saída:

    {
   "error":"INVALID_PARAM",
   "message":"Invalid Parameters. Please provide either a valid sysId or a valid name of a saved query"
}