KPI
keyPerformanceIndicators Based on latest (2026.09)
Create, change, delete and look up KPI, with KPI history metadata.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
KPINumber- Required on create
KPIName- At a glance
- 33 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators?fields=ConflictId,CreatedBy,CreationDate,IsResourceContextFlag,IsSeededFlag&limit=25&onlyData=true
{
"items": [
{
"ConflictId": 0,
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"IsResourceContextFlag": false,
"IsSeededFlag": false
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 33
| Attribute | Type | Use |
|---|---|---|
ConflictId | number · default 0 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
IsResourceContextFlag | yes/no · max 1 | Optional on createSearchable |
IsSeededFlag | yes/no · max 1 · default false | Read-onlySearchable |
KPIAggregationCode | text · max 200 | Optional on createSearchable |
KPIAggregationFact | text · max 40 | Optional on createUpdatableSearchable |
KPICategory | text · max 40 | Optional on createUpdatableSearchable |
KPICategoryType | text · max 40 | Optional on createUpdatableSearchable |
KPICondition | text · max 4000 | Optional on createUpdatableSearchable |
KPICreditRecipient | text · max 100 | Optional on createUpdatableSearchable |
KPICreditTime | text · max 100 | Optional on createUpdatableSearchable |
KPIDenomAggregationCode | text · max 200 | Optional on createUpdatableSearchable |
KPIDenomAggregationFact | text · max 40 | Optional on createUpdatableSearchable |
KPIDenomCreditTime | text · max 100 | Optional on createUpdatableSearchable |
KPIDenomRuleCondition | text · max 4000 | Optional on createUpdatableSearchable |
KPIDescription | text · max 3000 | Optional on createUpdatableSearchable |
KPIHistoryEnabledFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
KPIId | number | Optional on createSearchable |
KPIName | text · max 275 | Required on createUpdatableSearchable |
KPINumber | text · max 64 | Optional on createSearchable |
KPINumerAggregationCode | text · max 200 | Optional on createUpdatableSearchable |
KPINumerAggregationFact | text · max 40 | Optional on createUpdatableSearchable |
KPINumerCreditTime | text · max 100 | Optional on createUpdatableSearchable |
KPINumerRuleCondition | text · max 4000 | Optional on createUpdatableSearchable |
KPIObject | text · max 40 | Optional on createSearchable |
KPIRuleCondition | text · max 4000 | Optional on createUpdatableSearchable |
KPIStatusCode | text · max 30 · default ORA_DRAFT | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ObjectVersionNumber | number | Read-onlySearchable |
UOMCode | text · max 40 | Optional on createSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
RowFinder·KPINumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/<name>. Add them to a GET with expand.
KPIHistoryMetadataGET · POST · PATCH · DELETE KPI History Metadata · 11 fieldsConflictIdCreatedByCreationDateKPIEventIdKPIEventNameKPIIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberStaticText
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/keyPerformanceIndicatorsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
RowFinderfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:ConflictId, notconflictid. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.