Scorecards (Preview) - Get

Служба:: Power BI REST APIs

Версия API:: v1.0

Возвращает список систем показателей из рабочей области.

Требуемая область

Dataset.Read.All или Dataset.ReadWrite.All

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

С использованием необязательных параметров:

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/scorecards?$top={$top}

Параметры URI

Имя	В	Обязательно	Тип	Описание
groupId	path	True	string (uuid)	Уникальный идентификатор рабочей области
$top	query		integer (int32)	Возвращает только первые результаты n.

Ответы

Имя	Тип	Описание
200 OK	Scorecards	Список с картами показателей

Примеры

Example

Образец запроса

GET https://api.powerbi.com/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/scorecards?$top=30

Пример ответа

Код состояния:: 200

{
  "@odata.context": "http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards",
  "@odata.count": 1,
  "value": [
    {
      "id": "0059003b-fcd4-45e4-92ea-cafa1ab4938a",
      "name": "Scorecard1",
      "createdTime": "2021-12-10T22:02:51.9130363Z",
      "lastModifiedTime": "2021-12-10T22:03:08.8193962Z",
      "provisioningStatus": "Completed",
      "groupId": "bc390256-fa54-4bd8-96a1-2c80df0cf704",
      "datasetId": "efe32352-b00d-488f-8d7d-049a6f2c93b8",
      "reportId": "f69e63a2-e241-4cf4-a4b3-97f476a425bd",
      "permissions": "ReadWrite",
      "columnSettings": [
        {
          "columnId": 0,
          "show": true
        },
        {
          "columnId": 1,
          "show": true
        },
        {
          "columnId": 2,
          "show": true
        },
        {
          "columnId": 3,
          "show": true
        },
        {
          "columnId": 4,
          "show": true
        },
        {
          "columnId": 5,
          "show": true
        },
        {
          "columnId": 6,
          "show": true
        }
      ]
    }
  ]
}

Определения

Имя	Описание
Goal	Цель Power BI
GoalAggregation	Запись, описывающая состояние различных свойств цели Power BI в определенное время (обычно текущее время).
GoalAggregationType	Тип агрегированного свойства
GoalNote	Заметка о значении цели Power BI
GoalPermissions	Разрешения цели
Goals.Rules.GoalRulesContainer	Контейнер для определений json правил состояния для цели Power BI
GoalValue	Возврат значения цели Power BI
Scorecard	Системная карта показателей Power BI
ScorecardColumnId	Идентификатор одного из столбцов на странице веб-интерфейса системы показателей или системы показателей
ScorecardColumnSetting	Запись, определяющая параметры отображения столбцов в системе показателей Power BI
ScorecardPermission	Разрешения системы показателей
Scorecards	Оболочка ответа OData для коллекции систем показателей Power BI

Goal

Object

Цель Power BI

Имя	Тип	Описание
aggregations	GoalAggregation[]	Список агрегированных свойств цели
completionDate	string (date-time)	Метка времени UTC для даты завершения цели. Часть времени метки времени равна нулю.
createdTime	string (date-time)	Время создания в формате UTC
datesFormatString	string	dateFormatString
description	string	Описание цели
goalValues	GoalValue[]	Список контрольных значений цели
hasStatusRules	boolean	Определяется ли цель правилами состояния
id	string (uuid)	Идентификатор цели
lastModifiedTime	string (date-time)	Время в формате UTC в последнее изменение
level	integer (int32)	Вложенный уровень цели в иерархии родительских дочерних показателей целей системы показателей
name	string	Имя цели
notesCount	integer (int32)	notesCount
parentId	string (uuid)	Идентификатор родительской цели, если определен.
permissions	GoalPermissions	Разрешения цели
rank	integer (int64)	Ранг цели в упорядоченный набор целей с братьями и сестрами
scorecardId	string (uuid)	Идентификатор системы показателей
startDate	string (date-time)	Метка времени UTC для даты начала цели. Часть времени метки времени равна нулю.
statusRules	Goals.Rules.GoalRulesContainer	Правила состояния цели
valuesFormatString	string	valuesFormatString

GoalAggregation

Object

Запись, описывающая состояние различных свойств цели Power BI в определенное время (обычно текущее время).

Имя	Тип	Описание
calculationTime	string (date-time)	Метка времени UTC вычисления агрегирования
goalId	string (uuid)	Идентификатор цели
id	string	Идентификатор агрегирования
maxLastModifiedTime	string (date-time)	Метка времени в формате UTC последнего изменения в агрегированном свойстве
scorecardId	string (uuid)	Идентификатор системы показателей
timestamp	string (date-time)	Метка времени UTC, связанная с агрегированным свойством. Часть времени метки времени равна нулю.
type	GoalAggregationType	Тип агрегированного свойства
value	number (double)	Числовое значение агрегированного свойства
valueDisplayString	string	Необязательный. Альтернативное текстовое представление значения агрегированного свойства.

GoalAggregationType

Перечисление

Тип агрегированного свойства

Значение	Описание
Change	Сведения об изменении
Sparkline	Сведения о спарклайне
Status	Сведения о состоянии цели
Target	Сведения о целевом значении цели
Value	Сведения о текущем значении цели

GoalNote

Object

Заметка о значении цели Power BI

Имя	Тип	Описание
body	string	Текст заметки
content	string	Содержимое этой заметки в специальном формате
createdTime	string (date-time)	Время создания в формате UTC
goalId	string (uuid)	Идентификатор цели
id	string (uuid)	Идентификатор заметки о значении цели
lastModifiedTime	string (date-time)	Время в формате UTC в последнее изменение
scorecardId	string (uuid)	Идентификатор системы показателей
valueTimestamp	string (date-time)	Метка времени UTC для проверки значения цели, к которой относится эта заметка. Часть времени метки времени равна нулю.

GoalPermissions

Перечисление

Разрешения цели

Значение	Описание
11	Текущее значение и заметки можно обновить.
13	Можно обновить целевое значение и заметки.
15	Текущее значение, целевое значение и заметки можно обновить.
19	Текущее значение и состояние можно обновить.
21	Можно обновить целевое значение и состояние.
23	Текущее значение, целевое значение и состояние можно обновить.
25	Заметки и состояние можно обновить.
27	Текущее значение, заметки и состояние можно обновить.
29	Можно обновить целевое значение, заметки и состояние.
All	Можно обновить значения, заметки и состояние.
None	Нет доступа.
UpdateCurrentValue	Текущее значение можно обновить.
UpdateNotes	Заметки можно обновить.
UpdateStatus	Состояние можно обновить.
UpdateTargetValue	Целевое значение можно обновить.
UpdateValues	Текущие и целевые значения можно обновить.
View	Просмотр только доступа.

Goals.Rules.GoalRulesContainer

Object

Контейнер для определений json правил состояния для цели Power BI

Имя	Тип	Описание
goalObjectId	string (uuid)	Идентификатор цели
lastModifiedTime	string (date-time)	Время в формате UTC в последнее изменение
rules	string	Список правил
scorecardObjectId	string (uuid)	Идентификатор системы показателей

GoalValue

Object

Возврат значения цели Power BI

Имя

Тип

Описание

createdTime

string (date-time)

Время создания в формате UTC

forecast

number (double)

Прогноз тренда целевой стоимости

goalId

string (uuid)

Идентификатор цели

lastModifiedTime

string (date-time)

Время в формате UTC в последнее изменение

notes

GoalNote[]

Заметки о цели

scorecardId

string (uuid)

Идентификатор системы показателей

status

integer (int32)

Идентификатор состояния цели

ИДЕНТИФИКАТОР	Описание
0	Не запущено
1	На трассе
2	Риск
3	Позади
4	Просроченный
5	Завершённый

target

number (double)

Целевое значение цели

targetDisplayString

string

Текстовое представление целевого объекта цели

timestamp

string (date-time)

Метка времени UTC для проверки значения цели. Часть времени метки времени равна нулю.

trend

integer (int32)

Тенденция к значению цели

value

number (double)

Текущее значение цели

valueDisplayString

string

Текстовое представление текущего значения цели

Scorecard

Object

Системная карта показателей Power BI

Имя	Тип	Default value	Описание
columnSettings	ScorecardColumnSetting[]		Параметры отображения столбцов в системе показателей
createdTime	string (date-time)		Время создания в формате UTC
datasetId	string (uuid)		Идентификатор набора данных, связанного с системой показателей
description	string		Описание системы показателей
goals	Goal[]		Цели системы показателей
groupId	string (uuid)		Идентификатор рабочей области
id	string (uuid)		Идентификатор системы показателей
lastModifiedTime	string (date-time)		Время в формате UTC в последнее изменение
name	string		Имя системы показателей
permissions	ScorecardPermission		Разрешения системы показателей
provisioningStatus	enum: Completed Deleted Deprovisioning Failed Initialized	Initialized	Состояние подготовки системы показателей.
reportId	string (uuid)		Идентификатор внутреннего отчета, связанного с системой показателей

ScorecardColumnId

Перечисление

Идентификатор одного из столбцов на странице веб-интерфейса системы показателей или системы показателей

Значение	Описание
0	Имя
1	Владелец
2	Состояние
3	Ценность
4	Ход выполнения
5	Дата выполнения
6	Примечания.

ScorecardColumnSetting

Object

Запись, определяющая параметры отображения столбцов в системе показателей Power BI

Имя	Тип	Описание
columnId	ScorecardColumnId (int32)	Идентификатор одного из столбцов на странице веб-интерфейса системы показателей или системы показателей
show	boolean	Должен ли столбец отображаться на системе показателей

ScorecardPermission

Перечисление

Разрешения системы показателей

Значение	Описание
None	Нет доступа
Read	Доступ на чтение
ReadWrite	Доступ на чтение и запись
Write	Доступ на запись

Scorecards

Object

Оболочка ответа OData для коллекции систем показателей Power BI

Имя	Тип	Описание
@odata.context	string	Контекст OData
@odata.count	integer
@odata.nextLink	string	Ссылка на следующие результаты страницы.
value	Scorecard[]	Коллекция систем показателей