Get all KPIs
get
/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Find a KPI using the primary key
Finder Variables- KPIId; integer; The unique identifier of the key performance indicator.
- RowFinder Find all KPIs by the KPI number.
Finder Variables- KPINumber; string; The alternate key identifier of a key performance indicator.
- PrimaryKey Find a KPI using the primary key
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ConflictId; integer; Conflict ID
- CreatedBy; string; Created By
- CreationDate; string; Creation Date
- IsResourceContextFlag; boolean; User Context
- IsSeededFlag; boolean; Seeded
- KPIAggregationCode; string; The code of aggregation used for KPI calculation.
- KPIAggregationFact; string; The attribute on the source object used for aggregations.
- KPICategory; string; The attribute on the source object used for category based breakdown of scores.
- KPICategoryType; string; The KPI category type.
- KPICondition; string; The condition on the source object used for KPI calculation.
- KPICreditRecipient; string; The attribute on the source object that indicates the credit recipient for the KPI.
- KPICreditTime; string; The attribute on the source object that indicates the qualifying time for the KPI.
- KPIDenomAggregationCode; string; The calculation type used for calculating the denominator value of the KPI such as Sum or Count.
- KPIDenomAggregationFact; string; The field on source object used to calculate the sum aggregation for KPI denominator value.
- KPIDenomCreditTime; string; The date filter used for calculating denominator value of the KPI.
- KPIDenomRuleCondition; string; The JSON rule condition used for calculating denominator value of the KPI.
- KPIDescription; string; Description
- KPIHistoryEnabledFlag; boolean; Enable Activity History
- KPIId; integer; KPI ID
- KPIName; string; Name
- KPINumber; string; KPI Number
- KPINumerAggregationCode; string; The calculation type used to calculate the numerator value of the KPI such as Sum or Count.
- KPINumerAggregationFact; string; The field on source object used for calculating sum aggregation for KPI numerator value.
- KPINumerCreditTime; string; The date filter used to calculate the numerator value of the KPI.
- KPINumerRuleCondition; string; The JSON rule condition used to calculate the numerator value of the KPI.
- KPIObject; string; KPI Object
- KPIRuleCondition; string; The attribute for the KPI condition in Rule JSON format.
- KPIStatusCode; string; The status code of the KPI.
- LastUpdateDate; string; Last Updated Date
- LastUpdateLogin; string; Last Update Login
- LastUpdatedBy; string; Last Updated By
- ObjectVersionNumber; integer; Object Version Number
- UOMCode; string; UOM Code
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : keyPerformanceIndicators
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : keyPerformanceIndicators-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
Conflict ID -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Creation Date -
IsResourceContextFlag: boolean
Title:
User Context
Maximum Length:1
User Context -
IsSeededFlag: boolean
Title:
Seeded
Read Only:true
Maximum Length:1
Default Value:false
Seeded -
KPIAggregationCode: string
Title:
Calculation Type
Maximum Length:200
The code of aggregation used for KPI calculation. -
KPIAggregationFact: string
Title:
Sum Attribute
Maximum Length:40
The attribute on the source object used for aggregations. -
KPICategory: string
Title:
Breakup Category
Maximum Length:40
The attribute on the source object used for category based breakdown of scores. -
KPICategoryType: string
Maximum Length:
40
The KPI category type. -
KPICondition: string
Title:
Filter Condition
Maximum Length:4000
The condition on the source object used for KPI calculation. -
KPICreditRecipient: string
Title:
Credit Recipient
Maximum Length:100
The attribute on the source object that indicates the credit recipient for the KPI. -
KPICreditTime: string
Title:
Credit Date
Maximum Length:100
The attribute on the source object that indicates the qualifying time for the KPI. -
KPIDenomAggregationCode: string
Title:
Denominator Calculation Type
Maximum Length:200
The calculation type used for calculating the denominator value of the KPI such as Sum or Count. -
KPIDenomAggregationFact: string
Title:
Denominator Sum Attribute
Maximum Length:40
The field on source object used to calculate the sum aggregation for KPI denominator value. -
KPIDenomCreditTime: string
Title:
Denominator Credit Time
Maximum Length:100
The date filter used for calculating denominator value of the KPI. -
KPIDenomRuleCondition: string
Title:
Denominator Rule Condition
Maximum Length:4000
The JSON rule condition used for calculating denominator value of the KPI. -
KPIDescription: string
Title:
Description
Maximum Length:3000
Description -
KPIHistoryEnabledFlag: boolean
Title:
Enable Activity History
Maximum Length:1
Default Value:true
Enable Activity History -
KPIHistoryMetadata: array
KPI History Metadata
Title:
KPI History Metadata
The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata. -
KPIId: integer
(int64)
Title:
KPI ID
KPI ID -
KPIName: string
Title:
Name
Maximum Length:275
Name -
KPINumber: string
Title:
KPI Number
Maximum Length:64
KPI Number -
KPINumerAggregationCode: string
Title:
Numerator Calculation Type
Maximum Length:200
The calculation type used to calculate the numerator value of the KPI such as Sum or Count. -
KPINumerAggregationFact: string
Title:
Numerator Sum Attribute
Maximum Length:40
The field on source object used for calculating sum aggregation for KPI numerator value. -
KPINumerCreditTime: string
Title:
Numerator Credit Time
Maximum Length:100
The date filter used to calculate the numerator value of the KPI. -
KPINumerRuleCondition: string
Title:
Numerator Rule Condition
Maximum Length:4000
The JSON rule condition used to calculate the numerator value of the KPI. -
KPIObject: string
Title:
KPI Object
Maximum Length:40
KPI Object -
KPIRuleCondition: string
Title:
KPI Condition Rule JSON
Maximum Length:4000
The attribute for the KPI condition in Rule JSON format. -
KPIStatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_DRAFT
The status code of the KPI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Last Updated Date -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Last Updated By -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Last Update Login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object Version Number -
UOMCode: string
Maximum Length:
40
UOM Code
Nested Schema : KPI History Metadata
Type:
array
Title:
KPI History Metadata
The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : keyPerformanceIndicators-KPIHistoryMetadata-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
Conflict ID -
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
KPIEventId: integer
(int64)
The unique identifier of the KPI event.
-
KPIEventName: string
Maximum Length:
200
The name of the KPI event. -
KPIId: integer
(int64)
The unique identifier of the KPI.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated Date -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated By -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Last Update Login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object Version Number -
StaticText: string
Maximum Length:
4000
The KPI history static text.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.