Goals (Preview) - Get

Serviço:

Power BI REST APIs

Versão da API:

v1.0

Retorna uma lista de gols de um scorecard.

Escopo necessário

Dataset.Read.All ou Dataset.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals

Com parâmetros opcionais:

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals?$expand={$expand}&$select={$select}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
groupId	path	True	string (uuid)	O identificador exclusivo do workspace
scorecardId	path	True	string (uuid)	O identificador exclusivo do scorecard
$expand	query		string	Aceita uma lista separada por vírgulas de tipos de dados, que será expandida embutida na resposta. Oferece suporte para goalValues e aggregations.
$select	query		string	Permite que os clientes selecionem propriedades específicas do servidor.

Respostas

Nome	Tipo	Description
200 OK	Goals	A lista de gols de scorecard

Exemplos

Example

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/scorecards(bc390256-fa54-4bd8-96a1-2c80df0cf704)/goals

Resposta de exemplo

Código de status:

200

{
  "@odata.context": "http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(e399e1d9-6d43-4ccf-b5c2-e8f93335be44)/goals",
  "value": [
    {
      "id": "7e683d36-fce1-41f3-9151-db65cf095001",
      "name": "Goal2",
      "scorecardId": "e399e1d9-6d43-4ccf-b5c2-e8f93335be44",
      "createdTime": "2021-12-14T17:42:07.805447Z",
      "lastModifiedTime": "2021-12-14T17:42:15.0711664Z",
      "startDate": "2021-12-14T17:42:08Z",
      "notesCount": 0,
      "hasStatusRules": false,
      "permissions": "All",
      "level": 0,
      "rank": 0
    }
  ]
}

Definições

Nome	Description
Goal	Uma meta do Power BI
GoalAggregation	Uma entrada que descreve o estado de várias propriedades de meta do Power BI em um momento específico (horário normalmente atual)
GoalAggregationType	O tipo da propriedade agregada
GoalNote	Uma nota de check-in de valor de meta do Power BI
GoalPermissions	As permissões de meta
Goals	O wrapper de resposta OData para uma coleção de metas do Power BI
Goals.Rules.GoalRulesContainer	Um contêiner para definições JSON de regras de status em uma meta do Power BI
GoalValue	Um check-in de valor de meta do Power BI

Goal

Objeto

Uma meta do Power BI

Nome	Tipo	Description
aggregations	GoalAggregation[]	A lista de propriedades agregadas da meta
completionDate	string (date-time)	O carimbo de data/hora UTC para a data de conclusão da meta. A parte de tempo do carimbo de data/hora é zero.
createdTime	string (date-time)	A hora UTC na criação
datesFormatString	string	datesFormatString
description	string	A descrição da meta
goalValues	GoalValue[]	A lista de check-ins de valor de meta
hasStatusRules	boolean	Se a meta tem regras de status definidas
id	string (uuid)	A ID da meta
lastModifiedTime	string (date-time)	A hora UTC na última modificação
level	integer (int32)	O nível aninhado do gol na hierarquia pai-filho de gols de scorecard
name	string	O nome da meta
notesCount	integer (int32)	notesCount
parentId	string (uuid)	A ID da meta pai, se definida.
permissions	GoalPermissions	As permissões de meta
rank	integer (int64)	A classificação da meta dentro do conjunto ordenado de metas de irmãos
scorecardId	string (uuid)	A ID do scorecard
startDate	string (date-time)	O carimbo de data/hora UTC para a data de início da meta. A parte de tempo do carimbo de data/hora é zero.
statusRules	Goals.Rules.GoalRulesContainer	As regras de status de meta
valuesFormatString	string	valuesFormatString

GoalAggregation

Objeto

Uma entrada que descreve o estado de várias propriedades de meta do Power BI em um momento específico (horário normalmente atual)

Nome	Tipo	Description
calculationTime	string (date-time)	O carimbo de data/hora UTC do cálculo de agregação
goalId	string (uuid)	A ID da meta
id	string	A ID de agregação
maxLastModifiedTime	string (date-time)	O carimbo de data/hora UTC da última modificação na propriedade agregada
scorecardId	string (uuid)	A ID do scorecard
timestamp	string (date-time)	O carimbo de data/hora UTC associado à propriedade agregada. A parte de tempo do carimbo de data/hora é zero.
type	GoalAggregationType	O tipo da propriedade agregada
value	number (double)	O valor numérico da propriedade agregada
valueDisplayString	string	Opcional. A representação de texto alternativo do valor da propriedade agregada.

GoalAggregationType

Enumeração

O tipo da propriedade agregada

Valor	Description
Change	Informações sobre a alteração
Sparkline	Informações sobre o minigráfico
Status	Informações sobre o status da meta
Target	Informações sobre o valor de destino da meta
Value	Informações sobre o valor atual da meta

GoalNote

Objeto

Uma nota de check-in de valor de meta do Power BI

Nome	Tipo	Description
body	string	O texto da anotação
content	string	O conteúdo desta anotação em formato especial
createdTime	string (date-time)	A hora UTC na criação
goalId	string (uuid)	A ID da meta
id	string (uuid)	A ID da anotação de check-in do valor da meta
lastModifiedTime	string (date-time)	A hora UTC na última modificação
scorecardId	string (uuid)	A ID do scorecard
valueTimestamp	string (date-time)	O carimbo de data/hora UTC do check-in de valor de meta ao qual essa anotação pertence. A parte de tempo do carimbo de data/hora é zero.

GoalPermissions

Enumeração

As permissões de meta

Valor	Description
11	O valor atual e as anotações podem ser atualizados.
13	O valor de destino e as anotações podem ser atualizados.
15	O valor atual, o valor de destino e as anotações podem ser atualizados.
19	O valor e o status atuais podem ser atualizados.
21	O valor e o status de destino podem ser atualizados.
23	O valor atual, o valor de destino e o status podem ser atualizados.
25	Anotações e status podem ser atualizados.
27	O valor, as anotações e o status atuais podem ser atualizados.
29	O valor de destino, as anotações e o status podem ser atualizados.
All	Valores, anotações e status podem ser atualizados.
None	Sem acesso.
UpdateCurrentValue	O valor atual pode ser atualizado.
UpdateNotes	As anotações podem ser atualizadas.
UpdateStatus	O status pode ser atualizado.
UpdateTargetValue	O valor de destino pode ser atualizado.
UpdateValues	Os valores atuais e de destino podem ser atualizados.
View	Exibir somente o acesso.

Goals

Objeto

O wrapper de resposta OData para uma coleção de metas do Power BI

Nome	Tipo	Description
@odata.context	string	Contexto OData
value	Goal[]	A coleção de metas

Goals.Rules.GoalRulesContainer

Objeto

Um contêiner para definições JSON de regras de status em uma meta do Power BI

Nome	Tipo	Description
goalObjectId	string (uuid)	A ID da meta
lastModifiedTime	string (date-time)	A hora UTC na última modificação
rules	string	A lista de regras
scorecardObjectId	string (uuid)	A ID do scorecard

GoalValue

Objeto

Um check-in de valor de meta do Power BI

Nome	Tipo	Description
createdTime	string (date-time)	A hora UTC na criação
forecast	number (double)	A previsão de tendência do valor da meta
goalId	string (uuid)	A ID da meta
lastModifiedTime	string (date-time)	A hora UTC na última modificação
notes	GoalNote[]	As notas para a meta
scorecardId	string (uuid)	A ID do scorecard
status	integer (int32)	A ID do status da meta identificação Descrição 0 Não iniciado 1 No caminho certo 2 Em risco 3 Atrás 4 Em Atraso 5 Concluído
target	number (double)	O valor de destino da meta
targetDisplayString	string	A representação textual do destino de meta
timestamp	string (date-time)	O carimbo de data/hora UTC do check-in de valor de meta. A parte de tempo do carimbo de data/hora é zero.
trend	integer (int32)	A tendência de valor de meta
value	number (double)	O valor atual da meta
valueDisplayString	string	A representação textual do valor de meta atual