viewScMetricData
Este método possibilita recuperar:
- Dados de um indicador associado ao scorecard;
Se o usuário não tiver permissão para visualizar o indicador do Scorecard, o web service não retornará os dados do indicador. Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
Classe Java | |
---|---|
Requisição | web/wwwroot/ws/java/strategy/ViewScMetricDataRequestType.java |
Retorno | web/wwwroot/ws/java/strategy/ViewScMetricDataResponseType.java |
Requisição:
Identificador | Requerido | Descrição |
---|---|---|
idscmetric | X | Identificador do indicador do Scorecard |
Estrutura da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:strategy">
<soapenv:Header/>
<soapenv:Body>
<urn:viewScMetricData>
<urn:idscmetric>?</urn:idscmetric>
</urn:viewScMetricData>
</soapenv:Body>
</soapenv:Envelope>
Retorno:
Identificador | Descrição |
---|---|
return | SUCESSO: Retorna um vetor com os metadados: ▪ IDSCORECARD: String; Identificador do Scorecard. ▪ IDSCMETRIC: String; Identificador do indicador do Scorecard. ▪ NMCONFIGVIEW: String; Nome do perfil de visualização do indicador. ▪ NMMETRIC: String; Nome do indicador. ▪ NMSCOREITEMOWNER: String; Elemento superior do indicador. ▪ FGFREQUENCY: String; Frequência do indicador. (1 - Anual; 2 - Semestral; 3 - Quadrimestral; 4 - Trimestral; 5 - Bimestral; 6 - Mensal; 7 - Quinzenal; 8 - Semanal; 9 - Diário; 10 - Por Evento) ▪ FGRANGECONFIG: String; Configuração da faixa do indicador. ▪ NMMETRICTYPE: String; Nome do tipo do indicador. ▪ NMOWNER: String; Responsáveis pelo indicador. ▪ FGDUEMEASURE: String; Situação do vencimento do indicador. (1 - Em dia; 2 - Em atraso) ▪ IDMEASUNITY: String; Unidade de medida do indicador. ▪ SUBMETRICS: Matriz; Subindicadores do indicador do scorecard. • SUBMETRIC: Subindicador do scorecard. o IDSCORECARD: String; Identificador do Scorecard. o IDSCMETRIC: String; Identificador do indicador do Scorecard. o NMMETRIC: String; Nome do indicador. o FGFREQUENCY: String; Frequência do indicador. (1 - Anual; 2 - Semestral; 3 - Quadrimestral; 4 - Trimestral; 5 - Bimestral; 6 - Mensal; 7 - Quinzenal; 8 - Semanal; 9 - Diário; 10 - Por Evento) FALHA: Mensagem com o erro ocorrido. |
error | Retorna o código de erro: 1 - Parâmetro IDSCMETRIC não informado. 2 - IDSCMETRIC não encontrado. 3 - O usuário conectado não possui permissão para visualizar o indicador. 4 - Não foi possível recuperar os dados do indicador, pois ele está inativo. 5 - Não foi possível recuperar os dados do indicador, pois ele está em uma revisão de Scorecard obsoleta. |