Единицы измерения KPI

Единицы измерения KPI используются для описания и настройки того, как отображаются значения данных KPI пользователю. Например, £3.99, 123% и т.д.

Объект единиц измерения KPI

Объект имеет следующие свойства:

Название Тип Только для чтения Обязательный Макс. длина Комментарии
id integer да нет   Автоматически генерируется для единицы измерения KPI
name string нет да 15 Название единицы измерения KPI
template string нет да 15 Формат отображения должен быть допустимым числовым форматом, например. £%s или %s% (где %s - форматированное значение)
language_id integer нет да   Идентификатор языка формата
float boolean нет да   Для определения, является ли значение десятичным.

Пример JSON

{
  "id":             4,
  "name":           "12.34%",
  "template":       "%s%",
  "language_id":     1,
  "float":           true
}

Пример XML

<KPIFormat xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models" 
          xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>4</id>
  <name>12.34%</name>
  <template>%s%</template>
  <float>true</float>
</KPIFormat>

 

Получить все единицы измерения KPI

GET /api/kpiformats

Используя curl

curl https://app.waytobi.com/api/kpiformats
  -v -u {token}

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

Status: 200 OK
[
  {
   "id": 4,
   "name": "12.34%",
   "template": "%s%",
   "language_id": 1,
   "float": true
  },
  {
   "id": 5,
   "name": "$1,234.56",
   "template": "$%s",
   "language_id": 1,
   "float": true
  }
]

 

Получить единицу измерения KPI

GET /api/kpiformats/{id}

Используя curl

curl https://app.waytobi.com/api/kpiformats/{id}
  -v -u {token}

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

Status: 200 OK
{
  "id": 4,
  "name": "12.34%",
  "template": "%s%",
  "language_id": 1,
  "float": true
}

Не можете найти ответ?

Ищете что-то конкретное? Попробуйте посмотреть различные папки и категории соответсвующие вашему запросу на предмет необходимой информации.

Связаться с нами