Get a list of KM KPI's schema

List of KPI's schema

SecurityBearerAuth or ApiKeyAuth

Request

path Parameters

km_id

required

string

Example: open-purchase-requisition.purchase-requisition-km

query Parameters

page	integer >= 0 Default: 0 The page number of the result, starting by 0 (first page)
pageSize	integer >= 1 Default: 50 The number of items returned in a page.
sort	string Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with "+" to apply ASC order or "-" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error. Example: sort=field1

Responses

200

List of KPI's

400

Bad Request.

401

Unauthorized access.

403

Forbidden.

404

The specified resource was not found

429

Too Many Requests.

500

Internal Server Error.

503

Service Unavailable.

get/api/knowledge-models/{km_id}/kpis

Request samples

curl
JavaScript
Java
Python
PHP

Response samples

application/json

{"content": [{"id": "AVG_EVENTS_PER_CASE",
"name": "Average events per case",
"description": "An average events per case",
"format": "#.###",
"unit": "euros",
"direction": "Up, Down, None",
"target": "any value",
"parameters": [{"id": "parameter_1",
"name": "My First Parameter",
"value": "1"
},
{"id": "parameter_2",
"name": "My Second Parameter",
"value": "a"
},
{"id": "parameter_3",
"name": "My Third Parameter",
"value": "5"
}
]
}
],
"page": 0,
"pageSize": 50,
"total": 1,
"sort": "+id"
}