1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Nudge Plan Executions

Get a nudge plan execution

get

/hcmRestApi/resources/11.13.18.05/nudgePlanExecutions/{PlanExecutionId}

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 : nudgePlanExecutions-item-response
Type: object
Show Source
Nested Schema : Nudge Counts
Type: array
Title: Nudge Counts
The nudgeCounts resource provides the count of nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.
Show Source
Nested Schema : Nudges
Type: array
Title: Nudges
The nudges resource provides all nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.
Show Source
Nested Schema : nudgePlanExecutions-nudgeCounts-item-response
Type: object
Show Source
Nested Schema : nudgePlanExecutions-nudges-item-response
Type: object
Show Source
Nested Schema : Channels
Type: array
Title: Channels
The channels resource provides all the channels through which a nudge is triggered. It's a child of the nudges resource.
Show Source
Nested Schema : nudgePlanExecutions-nudges-channels-item-response
Type: object
Show Source
Links
findByAdvancedSearchForNudgeExecutionDetail
Parameters:
  • PlanExecutionId: $request.path.PlanExecutionId
Finds nudge plan execution detail based on the search criteria.
findByAdvancedSearchForNudgeExecutionSummary
Parameters:
  • PlanExecutionId: $request.path.PlanExecutionId
Finds nudge plan execution summary based on the search criteria.
nudgeCounts
Parameters:
  • PlanExecutionId: $request.path.PlanExecutionId
The nudgeCounts resource provides the count of nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.
nudges
Parameters:
  • PlanExecutionId: $request.path.PlanExecutionId
The nudges resource provides all nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.
Back to Top