Cartão PASco - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 7 min. de leitura

    • . Cartão PASco A API permite que você busque dados sobre indicadores e seus registros associados, como detalhamentos.

    Esta API requer Performance Analytics(com.snc.pa.analytics_center) e é executado em SNC namespace.

    PAScorecard - addParam(parâmetro de cadeia de caracteres, valor de cadeia de caracteres)

    Adiciona um parâmetro de consulta para filtrar as pontuações retornadas.

    Chame este método várias vezes no mesmo objeto PAScorecard para passar vários parâmetros, como o sys_id do indicador e um sys_id de detalhamento. Depois de especificar todos os parâmetros, chame consulta () para executar a consulta.

    Se você consultar um objeto PAScorecard sem parâmetros, a API retornará uma lista de todos os indicadores exibidos no Hub de análise, com suas pontuações.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    detalhamento Cadeia de caracteres Sys_id de um detalhamento para retornar informações do gráfico organizadas conforme definido pelo detalhamento. Por exemplo, o sys_id de um detalhamento de prioridade para retornar informações separadas do gráfico de tarefas para cada valor de prioridade, como o número de incidentes em aberto / Prioridade / 2 - Alto.
    breakdown_relation Cadeia de caracteres Especifique o sys_id de uma relação de detalhamento para detalhar os dados retornados usando essa relação. Você pode exibir as relações de detalhamento disponíveis definindo include_available_breakdownsparâmetro para verdadeiro .
    contém Cadeia de caracteres Lista separada por vírgulas de nomes ou descrições para retornar resultados somente de indicadores com um valor correspondente. Todos os itens da lista separados por vírgulas devem corresponder ou nenhum resultado será retornado: A lista segue a lógica AND, NOT OR.
    tela Cadeia de caracteres Sinalizador que indica o tipo de indicadores a serem retornados.
    Valores válidos:
    • Verdadeiro: Retorna somente indicadores exibidos no Hub de análise .
    • Todos: Retorna todos os indicadores.

    Padrão: verdadeiro
    display_value Cadeia de caracteres Operação de recuperação de dados para campos de referência e opção.
    Com base nesse valor, o valor de exibição e/ou o valor real no banco de dados são recuperados.
    • verdadeiro retorna valores de exibição para todos os campos.
    • falso retorna valores reais do banco de dados.
    • todos retorna valores reais e de exibição.

    Padrão: falso
    elements_filter Cadeia de caracteres Especifique o sys_id de um filtro de elementos para aplicar esse filtro aos dados retornados.

    Tipo de dados: Cadeia de caracteres
    exclude_reference_link Booliano Sinalizador que indica se informações adicionais fornecidas para campos de referência devem ser ocultadas, como o URI do recurso de referência.
    Valores válidos:
    • Verdadeiro: Oculta informações adicionais fornecidas para campos de referência.
    • Falso: Não oculte informações adicionais fornecidas para campos de referência.

    Padrão: falso
    favoritos Booliano Sinalizador que indica se retornar somente indicadores que são favoritos do usuário que consulta.
    Valores válidos:
    • Verdadeiro: Retorna somente indicadores que são favoritos do usuário que consulta.
    • Falso: Retorna todos os indicadores.

    Padrão: falso
    de Cadeia de caracteres Data mais antiga da qual retornar pontuações. São retornadas pontuações desta data ou posteriores.

    Este parâmetro requer isso include_scoresestá definido como verdadeiro .

    Formato: Padrão ISO-8601
    include_available_agregados Cadeia de caracteres Sinalizador que indica se todos os agregados disponíveis devem ser retornados para um indicador quando nenhum agregado foi aplicado.
    Valores válidos:
    • Verdadeiro: Retorna todos os agregados disponíveis para um indicador quando nenhum agregado foi aplicado.
    • Falso: Não retorna agregados.

    Padrão: falso
    include_available_breakdowns Booliano Sinalizador que indica se todos os detalhamentos disponíveis devem ser retornados para um indicador.
    Valores válidos:
    • Verdadeiro: Retorna todos os detalhamentos disponíveis para um indicador.
    • Falso: Não retorna detalhamentos.

    Padrão: falso
    include_forecast_scores Booliano Sinalizador que indica se o elemento forecast_scores deve ser retornado que contém uma matriz de pares de data/valor que definem os dados de previsão para Hub de análise .

    Este parâmetro requer isso include_scoresestá definido como verdadeiro .

    Valores válidos:
    • Verdadeiro: Retorna o elemento forecast_scores.
    • Falso: Não retorna o elemento forecast_scores.

    Padrão: falso
    include_realtime Booliano Sinalizador que indica se o elemento realtime_enabled deve ser retornado, que indica se as pontuações em tempo real estão habilitadas para o indicador, e o elemento realtime_value que contém o valor da pontuação em tempo real. Este parâmetro não é compatível com indicadores de fórmula.
    Valores válidos:
    • Verdadeiro: Retorna o elemento realtime_enabled.
    • Falso: Não retorna o elemento realtime_enabled.

    Padrão: falso
    include_scores Booliano Sinalizador que indica se as pontuações do indicador devem ser retornadas para todo o intervalo de tempo selecionado no Hub de análise . Se um valor não for especificado, o padrão desse parâmetro será falso e retornará somente o valor de pontuação mais recente.

    Para restringir o intervalo de datas das pontuações retornadas, combine este parâmetro com frome. to.

    Valores válidos:
    • Verdadeiro: Retorna pontuações do indicador para todo o intervalo de tempo selecionado.
    • Falso: Não retorna pontuações do indicador para todo o intervalo de tempo selecionado.

    Padrão: falso
    include_target_color_scheme Booliano Sinalizador que indica se o elemento target_color_scheme deve ser retornado que contém os valores mínimo e máximo e a cor de cada seção do esquema de cores de destino para Hub de análise .
    Valores válidos:
    • Verdadeiro: Retorna o elemento target_color_scheme.
    • Falso: Não retorna o elemento target_color_scheme.

    Padrão: falso
    include_trendline_scores Cadeia de caracteres Sinalizador que indica se o elemento trendline_scores deve ser retornado que contém uma matriz de pares de data/valor que definem Hub de análise linha de tendências.

    Este parâmetro requer isso include_scoresestá definido como verdadeiro .
    chave Booliano Sinalizador que indica se os resultados devem ser retornados somente para os principais indicadores.
    Valores válidos:
    • Verdadeiro: Retorna o elemento trendline_scores.
    • Falso: Não retorna o elemento trendline_scores.

    Padrão: falso
    limite Número Número máximo de pontuações a serem retornadas.
    página Cadeia de caracteres Especifique o número da página. Por exemplo, ao consultar 20 indicadores no Hub de análise com o valor per_page padrão (10), especifique um valor de página de 2 para recuperar o. Hub de análise para 11-20.
    per_page Número Número máximo de indicadores que cada consulta pode retornar em uma página.

    Padrão: 10

    Máximo: 100
    classificado por Cadeia de caracteres Valor a ser usado ao classificar resultados.
    Valores válidos:
    • marcador
    • mudança
    • changeperc
    • data
    • padrão
    • direção
    • duedate
    • frequência
    • Lacuna
    • gapperc
    • grupo
    • indicator_group
    • nome
    • pedido
    • target
    • tendência
    • valor

    Valor: Valor
    classificador Cadeia de caracteres Direção da classificação.
    Valores válidos:
    • asc: Indica crescente
    • Des: Indica decrescente

    Padrão: Decrescente
    etapa Número Valor numérico para ignorar pontuações, com base na frequência do indicador. Por exemplo, especifique um valor de 3 para retornar somente pontuações a cada três dias para um indicador diário ou a cada três semanas para um indicador semanal.
    marcadores Cadeia de caracteres Insira um sys_id de grupo de indicadores para retornar os indicadores nesse grupo. Não use uuidcom este parâmetro.
    target Booliano Sinalizador que indica se os resultados devem ser retornados somente para indicadores que têm uma meta definida no Hub de análise .
    Valores válidos:
    • Verdadeiro: Retorna resultados somente para indicadores que têm uma meta definida.
    • Falso: Retorna resultados para todos os indicadores aplicáveis.

    Padrão: falso
    para Cadeia de caracteres Data mais recente a partir da qual retornar pontuações. São retornadas pontuações desta data ou anteriores.

    Este parâmetro requer isso include_scoresestá definido como verdadeiro .
    uuid Cadeia de caracteres Insira uma lista separada por dois pontos de valores sys_id para especificar quais indicadores, detalhamentos, agregados e domínios consultar. O parâmetro segue este formato:

    <indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id or element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id or element_sys_ids>:<aggregate_sys_id>;<domain_sys_id>

    O parâmetro deve começar com o sys_id de um registro de indicador. Como opção, você pode anexar os valores sys_id de um detalhamento e elemento de detalhamento para agrupar a resposta com base no detalhamento e o sys_id de um agregado para aplicar esse agregado. Você pode usar um detalhamento com um agregado ou usar apenas um.

    Para obter informações sobre como obter os valores sys_id de registros, consulte Identificador de registro exclusivo (sys_id) .

    Nota:
    Se um indicador estiver configurado para usar um Série temporal padrão . todos Hub de análise os valores desse indicador usam essa agregação de série temporal.
    Tabela 2. Retornos
    Tipo Descrição
    Nenhum(a)

    Neste exemplo, o parâmetro uuid especifica o indicador Número de incidentes em aberto e o parâmetro de detalhamento especifica o detalhamento de prioridade. Ambos os parâmetros têm o sys_id dos respectivos registros como valores. A função query() retorna os resultados como um objeto.

    var sc = new SNC.PAScorecard(); //in a scoped app, do not use the SNC namespace
sc.addParam('uuid', 'fb007202d7130100b96d45a3ce6103b4');       // Number of open incidents
sc.addParam('breakdown', '0df47e02d7130100b96d45a3ce610399');  // by Priority
var result = sc.query();  // Query results, which are returned as an object
for (var i = 0; i < result.length; i++)
gs.info(result[i].name + ': ' + result[i].value + ' ' + result[i].unit.display_value);

    PAScorecard - query()

    Execute uma consulta com base nos parâmetros especificados e retorne os resultados como um objeto.

    Antes de chamar este método, configure os parâmetros para o objeto PAScorecard chamando AddParam (parâmetro de cadeia de caracteres, valor de cadeia de caracteres) .

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Objeto O objeto PAScorecard.

    PAScorecard - Resultado()

    Obter o resultado da última consulta como um objeto.

    Este método não executa uma consulta. Para executar uma consulta antes de retornar o resultado, use consulta () .

    Esta função não pode ser executada em um escopo diferente de global.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    Objeto Os resultados da última consulta, retornados como um objeto JS.