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

Get an objective

get

/crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}

Request

Path Parameters
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 : salesObjectives-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Initiatives
Type: array
Title: Initiatives
The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.
Show Source
Nested Schema : Objective Splits
Type: array
Title: Objective Splits
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : salesObjectives-AttachmentsVO-item-response
Type: object
Show Source
Nested Schema : salesObjectives-Initiatives-item-response
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : salesObjectives-Initiatives-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : salesObjectives-Initiatives-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : salesObjectives-Initiatives-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : salesObjectives-Initiatives-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : salesObjectives-SalesObjectiveSplits-item-response
Type: object
Show Source
Nested Schema : salesObjectives-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : salesObjectives-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : salesObjectives-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : salesObjectives-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
AttachmentsVO
Parameters:
  • ObjectiveId: $request.path.ObjectiveId
The attachments resource is used to view, create, and update attachments.
Initiatives
Parameters:
  • ObjectiveId: $request.path.ObjectiveId
The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.
LovSalesObjectiveTypeVO
Parameters:
  • finder: SalesObjectiveTypeFinder%3BBindObjectiveTypeCode%3D{ObjectiveTypeCode}
Sales Objective Types
ProductGroupViewAccessor
Parameters:
  • finder: ProductGroupList
Name for Product Group detail base public view object.
RatedCurrenciesVO
The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
SalesGLEndPeriodPickTimeListToViewAccessor
Parameters:
  • finder: EndPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
The End Period resource lets you view all end periods.
SalesGLStartPeriodPickerTimeListViewAccessor
Parameters:
  • finder: StartPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
The start period resource lets you view the start periods.
SalesObjectiveGLPeriodTypeViewAccessor
The Period Type resource lets you view all available period types.
SalesObjectiveSplits
Parameters:
  • ObjectiveId: $request.path.ObjectiveId
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.
smartActions
Parameters:
  • ObjectiveId: $request.path.ObjectiveId
This VO stores the endpoint and security details for every user action.
Back to Top

Examples

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

cURL Command

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

Example of Response Body

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

{
"ActualValue": null,
"BusinessPlanId": 300100089934422,
"CreatedBy": "CHANNEL_SALES_MGR",
"CreationDate": "2016-06-06T20:36:45-07:00",
"CurrencyCode": "USD",
"Description": null,
"EndPeriodName": "12-15",
"LastUpdateDate": "2016-06-06T20:37:44-07:00",
"LastUpdateLogin": "34A6975B399FB98DE0532AB0F20A0E96",
"LastUpdatedBy": "CHANNEL_SALES_MGR",
"Name": "AutoBO_05e70605485",
"ObjectiveId": 300100089934429,
"ObjectiveTypeCode": "Amount",
"PeriodTypeCode": "YEAR",
"StartPeriodName": "01-15",
"TargetValue": null,
"ObjectiveNumber": "CDRM_2004",
"OrigCreationDate": "2016-06-06T20:36:45-07:00",
"UnitOfMeasureCode": "AMOUNT",
"ObjectiveTypeName": "Amount",
"UnitOfMeasureName": "Amount",
"PeriodTypeName": "Year",
"BusinessPlanName": "AutoBP_9d570536477",
"BusinessPlanNumber": "CDRM_12029",
"StartDisplayPeriodName": "2015",
"EndDisplayPeriodName": "2015",
"UpdateFlag": true,
"DeleteFlag": true,
"links":[{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100089934429",…]
}
Back to Top