PAScorecard - com escopo

A API PAScorecard permite que você busque dados sobre indicadores e seus registros associados, como detalhamentos.

Esta API requer a aplicação Performance Analytics (com.snc.pa.analytics_center) e é executada no namespace SNC.

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 query() 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 de gráfico organizadas conforme definido pelo detalhamento. Por exemplo, o sys_id de um detalhamento de prioridade para retornar informações do gráfico de tarefas separadas para cada valor de prioridade, como o número de incidentes em aberto / Prioridade / 2 - Alto.
relação_detalhamento	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 o parâmetro include_available_breakdowns como 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, não a lógica OR.
tela	Cadeia de caracteres	Sinalizador que indica o tipo de indicadores a serem retornados. Valores válidos: verdadeiro: retorna somente os indicadores exibidos no Hub de análise . all: 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 de opção. Com base neste 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. all retorna valores reais e de exibição. Padrão: falso
elementos_filtro	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
link_de_referência_de_exclusão	Booliano	Sinalizador que indica se as informações adicionais fornecidas para campos de referência devem ser ocultadas, como o URI para o recurso de referência. Valores válidos: verdadeiro: oculta as informações adicionais fornecidas para os campos de referência. falso: não oculta informações adicionais fornecidas para campos de referência. Padrão: falso
favoritos	Booliano	Sinalizador que indica se devem ser retornados somente indicadores que são favoritos do usuário de consulta. Valores válidos: verdadeiro: retorna somente indicadores que são favoritos do usuário que faz a consulta. falso: retorna todos os indicadores. Padrão: falso
de	Cadeia de caracteres	Data mais antiga para retornar pontuações. Somente pontuações a partir desta data ou posterior são retornadas. Este parâmetro requer que include_scores esteja definido como verdadeiro. Formato: padrão ISO-8601
include_available_aggregates	Cadeia de caracteres	Sinalizador que indica se todos os agregados disponíveis devem ser retornados para um indicador quando nenhum agregado tiver sido 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 para um indicador devem ser retornados. 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 deve retornar o elemento previsão_scores que contém uma matriz de pares de data-valor que definem os dados de previsão para o Hub de análise . Este parâmetro requer que include_scores esteja definido como verdadeiro. Valores válidos: verdadeiro: retorna o elemento previsão_scores. falso: não retorna o elemento previsão_scores. Padrão: falso
include_realtime	Booliano	Sinalizador que indica se deve retornar o elemento realtime_enabled 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 deste parâmetro será falso e retornará somente o valor de pontuação mais recente. Para restringir o intervalo de datas das pontuações que são retornadas, combine este parâmetro com from e 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 deve retornar o elemento target_color_scheme que contém os valores mínimo e máximo e a cor de cada seção do esquema de cores de destino para o 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_pontuações	Cadeia de caracteres	Sinalizador que indica se deve retornar o elemento "trendline_scores" que contém uma matriz de pares de data-valor que definem a linha de tendência Hub de análise . Este parâmetro requer que include_scores esteja definido como verdadeiro.
chave	Booliano	Sinalizador que indica se os resultados devem ser retornados somente para indicadores-chave. 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.
por_página	Número	Número máximo de indicadores que cada consulta pode retornar em uma página. Padrão: 10 Máximo: 100
classificarpor	Cadeia de caracteres	Valor a ser usado ao classificar resultados. Valores válidos: marcador mudança mudançaperc data padrão direção vencimento frequência Lacuna lacuna grupo indicador_grupo nome pedido target tendência valor Padrão: valor
dirclassificação	Cadeia de caracteres	Direção de classificação. Valores válidos: asc: denota crescente des: denota 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 desse grupo. Não use uuid com este parâmetro.
target	Booliano	Sinalizador que indica se os resultados devem ser retornados somente para indicadores que têm um destino definido no Hub de análise . Valores válidos: verdadeiro: retorna somente resultados para indicadores que têm um destino definido. falso: retorna resultados para todos os indicadores aplicáveis. Padrão: falso
para	Cadeia de caracteres	Data mais recente a partir da qual as pontuações serão retornadas. Somente pontuações a partir desta data ou anterior são retornadas. Este parâmetro requer que include_scores esteja definido como verdadeiro.
uuid	Cadeia de caracteres	Insira uma lista separada por dois pontos de valores de sys_id para especificar quais indicadores, detalhamentos, agregados e domínios serão consultados. 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. Opcionalmente, você pode anexar os valores de 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 de sys_id de registros, consulte Identificador de registro exclusivo (sys_id). Nota: Se um indicador estiver configurado para usar uma série temporal Padrão, todos os valores Hub de análise desse indicador usarão 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 seus 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 - consulta ()

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(String parameter, String value).

Tabela 3. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 4. Retorna

Tipo	Descrição
Objeto	O objeto PAScorecard.

PAScorecard - resultado ()

Obtenha 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 query().

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.