KPI Relationships
Subcategories: Attachments, Notes
The KPI relationships resource is used to view, create, update, replace, and delete KPI relationships. A KPI relationship is an intersection between a KPI library and an account, a business plan, or an objective.
|
Resource Plural Label |
KPI Relationships |
|
Resource Name |
__ORACO__KPIRelationship_c |
Get All KPI Relationships
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__KPIRelationship_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a KPI relationship with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a KPI Relationship
Request: POST
URI: crmRestApi/resources/11.13.18.05/__ORACO__KPIRelationship_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a KPI Relationship
Request: POST
URI: crmRestApi/resources/11.13.18.05/__ORACO__KPIRelationship_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the KPI relationship. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a KPI Relationship
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__KPIRelationship_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the KPI relationship. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a KPI Relationship
Request: PATCH
URI: crmRestApi/resources/11.13.18.05/__ORACO__KPIRelationship_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the KPI relationship. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a KPI Relationship
Request: DELETE
URI: crmRestApi/resources/11.13.18.05/__ORACO__KPIRelationship_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the KPI relationship. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
FK_LOVVA_For___ORACO__OraZcxOwner_c |
ResourceProfileId |
__ORACO__OraZcxOwner_Id_c |
|
LOVVA_For___ORACO__OraZcxOwner_c |
PartyName |
__ORACO__OraZcxOwner_c |
|
FK_LOVVA_For___ORACO__BusinessPlan_c |
Id |
__ORACO__BusinessPlan_Id_c |
|
LOVVA_For___ORACO__BusinessPlan_c |
RecordName |
__ORACO__BusinessPlan_c |
|
FK_LOVVA_For___ORACO__Objective_c |
BusinessPlanId |
__ORACO__Objective_Id_c |
|
LOVVA_For___ORACO__Objective_c |
Name |
__ORACO__Objective_c |
|
FK_LOVVA_For___ORACO__Account_c |
OrganizationProfileId |
__ORACO__Account_Id_c |
|
LOVVA_For___ORACO__Account_c |
OrganizationName |
__ORACO__Account_c |
|
FK_LOVVA_For___ORACO__KPILibrary_c |
Id |
__ORACO__KPILibrary_Id_c |
|
LOVVA_For___ORACO__KPILibrary_c |
RecordName |
__ORACO__KPILibrary_c |
|
LOVVA_For___ORACO__Type_c |
LookupCode |
__ORACO__Type_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
number |
The unique identifier of the KPI relationship. UI Label: Record ID |
|
RecordName |
string |
The name of the KPI relationship. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the KPI relationship. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the KPI relationship was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the KPI relationship. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the KPI relationship was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the KPI relationship. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login of the user who last updated the KPI relationship. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the KPI relationship. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
__ORACO__OraZcxOwner_Id_c |
number |
The unique identifier of a resource associated with a KPI relationship. UI Label: Owner |
|
__ORACO__OraZcxOwner_c |
string |
The name of a resource associated with a particular KPI relationship. Properties: The maximum length is 1500. UI Label: Owner |
|
__ORACO__BusinessPlan_Id_c |
number |
The unique identifier of the business plan. UI Label: Business Plan |
|
__ORACO__BusinessPlan_c |
string |
The name of the business plan. Properties: The maximum length is 1500. UI Label: Business Plan |
|
__ORACO__Objective_Id_c |
number |
The unique identifier of the objective. UI Label: Objective |
|
__ORACO__Objective_c |
string |
The name of the objective. Properties: The maximum length is 1500. UI Label: Objective |
|
__ORACO__Account_Id_c |
number |
The unique identifier of the account. UI Label: Account |
|
__ORACO__Account_c |
string |
The name of the account. Properties: The maximum length is 1500. UI Label: Account |
|
__ORACO__KPILibrary_Id_c |
number |
The unique identifier of the KPI library. UI Label: KPI Library |
|
__ORACO__KPILibrary_c |
string |
The name of the KPI library. Properties: The maximum length is 1500. UI Label: KPI Library |
|
__ORACO__Description_c |
string |
A brief description of the KPI relationship. Properties: The maximum length is 80. UI Label: Description |
|
__ORACO__TargetValue_c |
integer |
The target value of the KPI relationship. UI Label: Target |
|
__ORACO__ActualValue_c |
integer |
The attainment value of the KPI relationship. UI Label: Attainment |
|
__ORACO__UnitOfMeasureName_c |
string |
The unit of measurement used by the KPI relationship. Properties: The maximum length is 80. UI Label: Unit Of Measure |
|
__ORACO__UnitOfMeasureCode_c |
string |
The code indicating the unit of measurement used by the KPI relationship. Properties: The maximum length is 80. UI Label: Unit Of Measure Code |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |
|
__ORACO__Type_c |
string |
The type of KPI relationship Properties: The maximum length is 1500. UI Label: Type |