Категории KPI

KPI организованы в категории для помощи администраторам в управлении и присвоении KPI.

Объект Категории KPI

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

Название Тип Только для чтения Обязательный Макс. длина Комментарии
id integer да нет   Автоматически генерируется для категории KPI
name string нет да 50 Название категории KPI

Пример JSON

{
  "id":         111,
  "name":       "Kpi Category"
}

Пример XML

<KPICategory xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models" 
             xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>111</id>
  <name>Kpi Category</name>
</KPICategory>

 

Получить все категории KPI

GET /api/kpicategories

Используя curl

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

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

Status: 200 OK
[
  {
    "id":         111,
    "name":       "Kpi Category"
  },
  {
    "id":         222,
    "name":       "Sales KPIs"
  }
]

 

Получить категорию KPI

GET /api/kpicategories/{id}

Используя curl

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

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

Status: 200 OK
{
  "id":         1234,
  "name":       "Kpi Category"
}

 

Добавить категорию KPI

POST /api/kpicategories

Используя curl

curl https://app.waytobi.com/api/kpicategories
  -H "Content-Type: application/json" 
  -d '{"name": "Kpi Category"}'
  -v -u {token} -X POST

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

Status: 201 Created
Location: https://app.waytobi.com/api/kpicategories/{id}
{
  "id":         1234,
  "name":       "Kpi Category"
}

 

Обновить категорию KPI

PUT /api/kpicategories/{id}

Используя curl

curl https://app.waytobi.com/api/kpicategories/{id}
  -H "Content-Type: application/json" 
  -d '{"name": "Kpi Category"}'
  -v -u {token} -X PUT

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

Status: 200 OK
{
  "id":1,
  "name":"Kpi Category",
}

 

Удалить категорию KPI

DELETE /api/kpicategories/{id}

Используя curl

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

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

Status: 200 OK
 

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

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

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