Это KPI присвоенные пользователю. Это определяет, на основе каких KPI пользователь может вводить данные, и какие KPIs пользователь может анализировать. Также здесь задается цель KPI пользователя, если у пользователя есть цель, которая отличается от цели KPI по умолчанию.
Объект KPI пользователя
Объект имеет следующие свойства:
| Название | Тип | Только для чтения | Обязательный | Макс. длина | Комментарии |
|---|---|---|---|---|---|
| id | integer | нет | да | Идентификатор KPI для присвоения пользователю. | |
| user_id | integer | да | нет | Идентификатор пользователя, которому присвоен KPI | |
| user_target | decimal | нет | нет | Цель пользователя задается только при условии, что KPI имеет цель | |
| created_at | datetime | да | нет | Дата и время создания элемента в формате UTC | |
| updated_at | datetime | да | нет | Дата и время последнего обновления элемента в формате UTC |
Пример JSON
{
"id": 111,
"user_id": 222,
"user_target": 100,
"created_at": "2012-10-17T13:23:00",
"updated_at": "2012-10-17T13:23:00"
}
Пример XML
<UserKPI xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<id>111</id>
<user_id>222</user_id>
<user_target>100</user_target>
<created_at>2012-10-17T13:23:00</created_at>
<updated_at>2012-10-17T13:23:00</updated_at>
</UserKPI>
Получить все KPI пользователя
GET /api/users/{user_id}/kpis
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/kpis
-v -u {token}
Пример ответа
Status: 200 OK
[
{
"id": 111,
"user_id": 222,
"user_target": 100,
"created_at": "2012-10-17T13:23:00",
"updated_at": "2012-10-17T13:23:00"
},
{
"id": 112,
"user_id": 223,
"user_target": 200,
"created_at": "2012-10-17T13:23:00",
"updated_at": "2012-10-17T13:23:00"
}
]
Получить KPI пользователя
GET /api/users/{user_id}/kpis/{id}
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/kpis/{id}
-v -u {token}
Пример ответа
Status: 200 OK
{
"id": 111,
"user_id": 222,
"user_target": 100,
"created_at": "2012-10-17T13:23:00",
"updated_at": "2012-10-17T13:23:00"
}
Добавить KPI пользователя
POST /api/users/{user_id}/kpis
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/kpis
-H "Content-Type: application/json"
-d '{"id": "111", "user_target": 100}'
-v -u {token} -X POST
Пример ответа
Status: 201 Created
Location: https://app.waytobi.com/api/users/{user_id}/kpis/{id}
{
"id": 111,
"user_id": 222,
"user_target": 100,
"created_at": "2012-10-17T13:23:00",
"updated_at": "2012-10-17T13:23:00"
}
Обновить KPI пользователя
PUT /api/users/{user_id}/kpis/{id}
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/kpis/{id}
-H "Content-Type: application/json"
-d '{"user_target": 100}'
-v -u {token} -X PUT
Пример ответа
Status: 200 OK
{
"id": 111,
"user_id": 222,
"user_target": 100,
"created_at": "2012-10-17T13:23:00",
"updated_at": "2012-10-17T13:23:00"
}
Удалить KPI пользователя
DELETE /api/users/{user_id}/kpis/{id}
Используя curl
curl https://app.waytobi.com/api/users/{user_id}/kpis/{id}
-v -u {token}
Пример ответа
Status: 200 OK