1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. List of Values
  4. Activity Functions
  5. Activity Type Lookups

Get all activity types

get

/crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- LookupCode, LookupType, ViewApplicationId and SetId ---for the Activity Functions resource and used to uniquely identify an instance of Activity Functions. The client should not generate the hash key value. Instead, the client should query on the Activity Functions collection resource with a filter on the primary key values in order to navigate to a specific instance of Activity Functions.

    For example: activityFunctionLookups?q=LookupCode=<value1>;LookupType=<value2>;ViewApplicationId=<value3>;SetId=<value4>
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

    • ByActivityFunctionFinder Finds the activity types for an activity function.
      Finder Variables
      • Bind_ActivityFunctionCode; string; The unique code for the active activity type.
      • Bind_CurrentDate; string; The date used to get the active Activity Types based on the current date.
      • Bind_ParentLookupCode; string; The lookup code of the parent lookup.
      • Bind_ParentSetidDetermType; string; The unique identifier for the parent.
      • Bind_ParentSetidDetermValue; string; The unique identifier of the parent set.
      • Bind_RelationshipId; integer; The unique identifier of the relationship.
    • PrimaryKey Finds an activity type that matches the primary key criteria specified.
      Finder Variables
      • LookupCode; string; The unique code for the activity type lookup.
      • LookupType; string; The lookup type of the activity function lookup.
      • SetId; integer; The unique identifier of the set.
      • ViewApplicationId; integer; The unique identifier of the view application of the activity type lookup code.
    • TypeActiveEnabledOrBindCodeFinder Finds an active activity types.
      Finder Variables
      • Bind_CurrentDate; string; The date used to get the active Activity Types based on the current date.
      • Bind_LookupCode; string; The unique code for the active activity type.
  • 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:
    • DisplaySequence; integer; The number indicating the display sequence for the activity type in the application lookup.
    • EnabledFlag; boolean; Indicates whether the activity type is enabled.
    • EndDateActive; string; The last day the activity type is active.
    • LookupCode; string; The unique code for the activity type.
    • LookupType; string; The lookup type for the activity type lookup.
    • Meaning; string; The display value for the activity type lookup.
    • SetId; integer; The unique identifier for the activity type lookup.
    • StartDateActive; string; The date when the activity type is active.
    • Tag; string; The description and classification activity type.
    • ViewApplicationId; integer; The unique identifier of the view application of the activity type lookup.
  • 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 : activityFunctionLookups-activityTypeLookup
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : activityFunctionLookups-activityTypeLookup-item-response
Type: object
Show Source
Nested Schema : Activity Subtypes
Type: array
Title: Activity Subtypes
The activity subtype lookup resource is used to view the activity subtypes for an Activity type and Activity Function. The activity subtypes provide additional detail to track activities.
Show Source
Nested Schema : activityFunctionLookups-activityTypeLookup-activitySubtypeLookup-item-response
Type: object
Show Source
Back to Top