Записи KPI

В зависимости от частоты ввода, пользователь добавляет эти записи данных KPI за определенную дату. Групповые элементы пользователя связаны с записью KPI при добавлении новой записи. Записи KPI удаляются навсегда.

Объект записи KPI

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

Пример JSON

{
  "id":         12345,
  "user_id":    1234,
  "kpi_id":     5678,
  "entry_date": "2012-06-25",
  "actual":     50.0000,
  "target":     110.0000,
  "notes":      "This is a note",
  "created_at": "2012-11-30T11:20:00",
  "updated_at": "2013-02-15T16:01:00"
}

Пример XML

<KPIEntry xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models" 
        xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>12345</id>
  <user_id>1234</user_id>
  <kpi_id>5678</kpi_id>
  <entry_date>2012-06-25</entry_date>
  <actual>50.0000</actual>
  <target>110.0000</target>
  <notes>This is a note</notes>
  <created_at>2013-02-21T10:12:00</created_at>
  <updated_at>2013-02-21T10:12:00</updated_at>
</KPIEntry>

Получить все записи KPI

Записи KPI фильтруются на основе строки поискового запроса. Все критерии поиска являются необязательными, а dateFrom и dateTo по умолчанию будут соответствовать сегодняшней дате, если не будут отправлены. Действие вернет максимум 500 записей на страницу. Если в наборе результатов есть количество строк, которое вы установили &rows=200, вы обязаны проверить следующую страницу, чтобы увидеть, есть ли еще - вы делаете это, добавляя &page=2 к запросу, затем &page=3 и так далее.

GET /api/kpientries?userid=123&kpiid=456&dateFrom=YYYY-MM-DD&dateTo=YYYY-MM-DD&rows=200&page=2

Используя curl

curl https://app.waytobi.com/api/kpientries?userid=123&kpiid=456&dateFrom=2012-01-01&dateTo=2012-02-01
  -v -u {token}

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

Status: 200 OK
[
  {
    "id":         12345,
    "user_id":    1234,
    "kpi_id":     5678,
    "entry_date": "2012-06-25",
    "actual":     50.0000,
    "target":     110.0000,
    "notes":      "This is a note",
    "created_at": "2012-11-30T11:20:00",
    "updated_at": "2013-02-15T16:01:00"
  },
  {
    "id":         12346,
    "user_id":    1235,
    "kpi_id":     5679,
    "entry_date": "2012-08-25",
    "actual":     55.0000,
    "target":     10.0000,
    "notes":      "This is a note",
    "created_at": "2012-11-30T11:20:00",
    "updated_at": "2013-02-15T16:01:00"
  }
]

Получить запись KPI

GET /api/kpientries/{id}

Используя curl

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

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

Status: 200 OK
{
  "id":         12345,
  "user_id":    1234,
  "kpi_id":     5678,
  "entry_date": "2012-06-25",
  "actual":     50.0000,
  "target":     110.0000,
  "notes":      "This is a note",
  "created_at": "2012-11-30T11:20:00",
  "updated_at": "2013-02-15T16:01:00"
}

Добавить запись KPI

Для простоты использования вы можете передать адрес электронной почты пользователя вместо user_id, используя имя свойства email.

POST /api/kpientries

Используя curl

curl https://app.waytobi.com/api/kpientries
  -H "Content-Type: application/json" 
  -d '{"user_id": 1234, "kpi_id": 5678, "entry_date": "2012-06-25", "actual": 50.0000, 
       "target": 110.0000, "notes": "This is a note"}'
  -v -u {token} -X POST

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

Status: 201 Created
Location: https://app.waytobi.com/api/kpientries/{id}
{
  "id":         12345,
  "user_id":    1234,
  "kpi_id":     5678,
  "entry_date": "2012-06-25",
  "actual":     50.0000,
  "target":     110.0000,
  "notes":      "This is a note",
  "created_at": "2012-11-30T11:20:00",
  "updated_at": "2013-02-15T16:01:00"
}

Обновить запись KPI

PUT /api/kpientries/{id}

Используя curl

curl https://app.waytobi.com/api/kpientries/{id}
  -H "Content-Type: application/json" 
  -d '{"user_id": 1234, "kpi_id": 5678, "entry_date": "2012-06-25", "actual": 50.0000, 
       "target": 110.0000, "notes": "This is a note"}'
  -v -u {token} -X PUT

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

Status: 200 OK
{
  "id":         12345,
  "user_id":    1234,
  "kpi_id":     5678,
  "entry_date": "2012-06-25",
  "actual":     50.0000,
  "target":     110.0000,
  "notes":      "This is a note",
  "created_at": "2012-11-30T11:20:00",
  "updated_at": "2013-02-15T16:01:00"
}

Удалить запись KPI

DELETE /api/kpientries/{id}

Используя curl

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

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

Status: 200 OK