1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. KPI

Get a KPI

get

/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : keyPerformanceIndicators-item-response
Type: object
Show Source
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 : keyPerformanceIndicators-KPIHistoryMetadata-item-response
Type: object
Show Source
Links
KPIAggregationVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_KPI_CALC_TYPE%2CBindLookupCode%3D{KPIAggregationCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: KPIAggregationCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
KPIHistoryMetadata
Parameters:
  • KPINumber: $request.path.KPINumber
The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.
KPIStatusVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_KPI_STATUS%2CBindLookupCode%3D{KPIStatusCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: KPIStatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
KPIUOMVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_UNIT_OF_MEASURE%2CBindLookupCode%3D{UOMCode}
The following properties are defined on the LOV link relation:
  • Source Attribute: UOMCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
Back to Top

Examples

The following example shows how to get a KPI by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S' -X GET

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "KPIId": 100100144204795,
    "KPINumber": "SEED_6_S",
    "KPIName": "Appointments Completed",
    "KPIDescription": "Measures the number of appointments completed.",
    "KPIObject": "Activity",
    "IsSeededFlag": true,
    "IsResourceContextFlag": null,
    "UOMCode": "QUANTITY",
    "KPICategoryType": "ZMM_ACTIVITY_TYPE",
    "KPICategory": "ActivityTypeCode",
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "CreationDate": "2020-03-16T17:26:43.422+00:00",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateDate": "2023-04-04T13:44:19.324+00:00",
    "LastUpdateLogin": "-1",
    "ObjectVersionNumber": 1,
    "ConflictId": 0,
    "KPICreditRecipient": "OwnerId",
    "KPICreditTime": "ActivityEndDate",
    "KPICondition": "ActivityFunctionCode = 'APPOINTMENT'",
    "KPIRuleCondition": "{\"objectName\":\"activities\",\"rule\":{\"conditions\":{\"allOf\":[{\"attribute\":\"ActivityFunctionCode\",\"operator\":\"EQUALS\",\"value\":\"APPOINTMENT\"}]}}}",
    "KPIAggregationCode": "ORA_COUNT",
    "KPIAggregationFact": null,
    "KPIStatusCode": "ORA_DRAFT",
    "KPINumerCreditTime": null,
    "KPINumerRuleCondition": null,
    "KPINumerAggregationCode": null,
    "KPINumerAggregationFact": null,
    "KPIDenomCreditTime": null,
    "KPIDenomRuleCondition": null,
    "KPIDenomAggregationCode": null,
    "KPIDenomAggregationFact": null,
    "KPIHistoryEnabledFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S",
            "name": "keyPerformanceIndicators",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S",
            "name": "keyPerformanceIndicators",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S/lov/KPIUOMVA",
            "name": "KPIUOMVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S/lov/KPIObjectsVA",
            "name": "KPIObjectsVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S/lov/KPIStatusVA",
            "name": "KPIStatusVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S/lov/KPIAggregationVA",
            "name": "KPIAggregationVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S/lov/KPIObjectAttrCreditRecipientVA",
            "name": "KPIObjectAttrCreditRecipientVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/SEED_6_S/child/KPIHistoryMetadata",
            "name": "KPIHistoryMetadata",
            "kind": "collection"
        }
    ]
}
Back to Top