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

Get all activity objectives

get

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives

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
  • 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:

    • ActivityObjectiveAltKeyFinder: Finds the activity objective using an alternate key.
      Finder Variables:
      • ActivityObjective; string; The objective for the activity.
      • ActyActivityNumber; string; The alternate key identifier for the activity objective.
    • ActivityObjectivesViewAltKey: Finds an activity objective with the alternate key.
      Finder Variables:
      • ObjectiveId; integer; The unique identifier of the objective.
    • PrimaryKey: Finds the Activity Objective with the specified primary key identifier.
      Finder Variables:
      • ObjectiveId; integer; The unique identifier of the objective.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ActivityId; integer; The unique identifier of the parent activity.
    • ActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
    • ActivityObjective; string; The objective for the activity.
    • ActyActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
    • AttributeCategory; string; The attribute category associated with the activity.
    • CompletedFlag; boolean; Indicates if the activity objective is completed. If True, the activity is completed.
    • ConflictId; integer; The unique identifier for the conflict in the activity objectives.
    • CorpCurrencyCode; string; The corporate currency code associated with the activity contact. 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.
    • CreatedBy; string; The user who created the activity objective.
    • CreationDate; string; The date and time when the activity objective was created.
    • CurcyConvRateType; string; The currency conversion rate type associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • 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.
    • LastUpdateDate; string; The date and time when the activity objective was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the activity objective.
    • LastUpdatedBy; string; The user who last updated the activity objective.
    • ObjectiveCode; string; The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.
    • ObjectiveFreefmtText; string; The text area to describe the objective of the activity.
    • ObjectiveId; integer; The unique identifier of the objective.
    • RecurSeriesId; integer; The unique identifier for the series that links instances of a series together.
  • 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
  • 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 : activities-ActivityObjectives
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : activities-ActivityObjectives-item-response
Type: object
Show Source
  • Title: Activity ID
    The unique identifier of the parent activity.
  • Maximum Length: 64
    The unique number of the activity. The number can also be generated from an external source.
  • Maximum Length: 255
    The objective for the activity.
  • Title: Activity Number
    Maximum Length: 64
    The unique number of the activity. The number can also be generated from an external source.
  • Maximum Length: 30
    The attribute category associated with the activity.
  • Title: Complete
    Maximum Length: 1
    Indicates if the activity objective is completed. If True, the activity is completed.
  • Default Value: 0
    The unique identifier for the conflict in the activity objectives.
  • Maximum Length: 15
    The corporate currency code associated with the activity contact. 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.
  • Read Only: true
    Maximum Length: 64
    The user who created the activity objective.
  • Read Only: true
    The date and time when the activity objective was created.
  • Maximum Length: 30
    The currency conversion rate type associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Maximum Length: 15
    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.
  • Read Only: true
    The date and time when the activity objective was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the activity objective.
  • Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the activity objective.
  • Links
  • Title: Objective
    Maximum Length: 30
    The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.
  • Title: Objective Text
    Maximum Length: 80
    The text area to describe the objective of the activity.
  • Title: Objective ID
    The unique identifier of the objective.
  • The unique identifier for the series that links instances of a series together.
Back to Top

Examples

The following example shows how to get all activity objectives by submitting a GET request on the REST resource using cURL.

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives

Example of Response Body

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

{
"items": [1]
0:  {
"ActivityId": 300100091331227
"ObjectiveCode": "DEMO_PRODUCT"
"ObjectiveFreefmtText": "NEW_OBJ1235"
"ObjectiveId": 300100091331231
"AttributeCategory": null
"CreationDate": "2016-08-24T00:02:57-07:00"
"CreatedBy": "SALES_ADMIN"
"LastUpdateDate": "2016-08-24T00:21:53-07:00"
"LastUpdatedBy": "SALES_ADMIN"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"ObjectVersionNumber": 2
"ConflictId": 0
"CompletedFlag": false
"ActivityNumber": null
"RecurSeriesId": null
"ObjectiveCompletedFlag": "false"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "EUR"
"links": [5]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231"
"name": "ActivityObjectives"
"kind": "item"
}-
1:  {
"rel": "canonical"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231"
"name": "ActivityObjectives"
"kind": "item"
}-
2:  {
"rel": "parent"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267"
"name": "activities"
"kind": "item"
}-
3:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231/lov/ObjectiveLookup"
"name": "ObjectiveLookup"
"kind": "collection"
}-
4:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231/lov/RatedCurrenciesVA"
"name": "RatedCurrenciesVA"
"kind": "collection"
}-
-
}-
-
"count": 1
"hasMore": false
"limit": 25
"offset": 0
"links": [1]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives"
"name": "ActivityObjectives"
"kind": "collection"
}-
-
}
Back to Top