Jump to

• Request
• Response

Get all nudge plan executions

get

/hcmRestApi/resources/11.13.18.05/nudgePlanExecutions

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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
  
  

  • PrimaryKey Finds all nudge plan executions that match the primary key specified.
    Finder Variables
    • PlanExecutionId; integer; Unique identifier for finding the nudge plan execution.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • EndDate; string; End date of the nudge plan.
  • ExecutionRequestId; integer; Unique identifier of the nudge plan execution request.
  • NudgePlanId; integer; Unique identifier of the nudge plan.
  • PlanExecutionId; integer; Unique identifier of the nudge plan execution.
  • PlanName; string; Name of the nudge plan.
  • RunType; string; Run type of the nudge plan execution.
  • StartDate; string; Start date of the nudge plan execution.
  • Status; string; Status of the nudge plan execution.
• totalResults: boolean
  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

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/nudgePlanExecutions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "isCompactViewByDefault":true
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object nudgePlanExecutions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/nudgePlanExecutions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : nudgePlanExecutions-item-response

Type: object

Show Source

• EndDate: string (date-time)
  End date of the nudge plan.
• ExecutionRequestId: integer (int64)
  Unique identifier of the nudge plan execution request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• nudgeCounts: array Nudge Counts
  Title: Nudge Counts

  The nudgeCounts resource provides the count of nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.
• NudgePlanId: integer (int64)
  Unique identifier of the nudge plan.
• nudges: array Nudges
  Title: Nudges

  The nudges resource provides all nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.
• PlanExecutionId: integer (int64)
  Unique identifier of the nudge plan execution.
• PlanName: string
  Read Only: true

  Maximum Length: 120

  Name of the nudge plan.
• RunType: string
  Maximum Length: 30

  Run type of the nudge plan execution.
• StartDate: string (date-time)
  Start date of the nudge plan execution.
• Status: string
  Maximum Length: 30

  Status of the nudge plan execution.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the nudge plan execution.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the nudge plan execution.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PlanExecutionId":{
            "type":"integer",
            "description":"Unique identifier of the nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "NudgePlanId":{
            "type":"integer",
            "description":"Unique identifier of the nudge plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "nudgeCounts":{
            "title":"Nudge Counts",
            "type":"array",
            "description":"The nudgeCounts resource provides the count of nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.",
            "items":{
                "$ref":"#/components/schemas/nudgePlanExecutions-nudgeCounts-item-response"
            }
        },
        "RunType":{
            "maxLength":30,
            "type":"string",
            "description":"Run type of the nudge plan execution.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExecutionRequestId":{
            "type":"integer",
            "description":"Unique identifier of the nudge plan execution request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PlanName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the nudge plan.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "nudges":{
            "title":"Nudges",
            "type":"array",
            "description":"The nudges resource provides all nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.",
            "items":{
                "$ref":"#/components/schemas/nudgePlanExecutions-nudges-item-response"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the nudge plan.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object nudgePlanExecutions-nudgeCounts-item-response

{
    "title":"Nudge Counts",
    "type":"array",
    "description":"The nudgeCounts resource provides the count of nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.",
    "items":{
        "$ref":"#/components/schemas/nudgePlanExecutions-nudgeCounts-item-response"
    }
}

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

• Array of: object nudgePlanExecutions-nudges-item-response

{
    "title":"Nudges",
    "type":"array",
    "description":"The nudges resource provides all nudges executed in the nudge plan. It's a child of the nudgePlanExecutions resource.",
    "items":{
        "$ref":"#/components/schemas/nudgePlanExecutions-nudges-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : nudgePlanExecutions-nudgeCounts-item-response

Type: object

Show Source

• ErrorMessage: string
  Maximum Length: 4000

  Error message for nudge plan execution.
• ErrorStackTrace: string (byte)
  Error stack trace for nudge plan execution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NudgeCount: integer (int64)
  Nudge count in a nudge plan execution.
• NudgeName: string
  Read Only: true

  Maximum Length: 150

  Name of the nudge plan in a nudge plan execution.
• PlanExecutionId: integer (int64)
  Unique identifier of the nudge count in the nudge plan execution.
• PlanExecutionStatId: integer (int64)
  Unique identifier of the nudge plan execution status.
• PlanNudgeId: integer (int64)
  Unique identifier of the nudge plan in a nudge plan execution count.
• Status: string
  Maximum Length: 30

  Status of the nudge count in a nudge plan execution.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the nudge count in a nudge plan execution.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorStackTrace":{
            "type":"string",
            "description":"Error stack trace for nudge plan execution.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PlanExecutionId":{
            "type":"integer",
            "description":"Unique identifier of the nudge count in the nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NudgeCount":{
            "type":"integer",
            "description":"Nudge count in a nudge plan execution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanExecutionStatId":{
            "type":"integer",
            "description":"Unique identifier of the nudge plan execution status.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PlanNudgeId":{
            "type":"integer",
            "description":"Unique identifier of the nudge plan in a nudge plan execution count.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Error message for nudge plan execution.",
            "nullable":true,
            "x-queryable":true
        },
        "NudgeName":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the nudge plan in a nudge plan execution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : nudgePlanExecutions-nudges-item-response

Type: object

Show Source

• AssigneeName: string
  Read Only: true

  Maximum Length: 2000

  Name of the assignee of a nudge in a nudge plan execution.
• AssigneePersonId: integer (int64)
  Person identifier of the assignee of a nudge in a nudge plan execution.
• AssignmentId: integer (int64)
  Assignment identifier of the assignee of a nudge in a nudge plan execution.
• channels: array Channels
  Title: Channels

  The channels resource provides all the channels through which a nudge is triggered. It's a child of the nudges resource.
• DisplayName: string
  Read Only: true

  Maximum Length: 240

  Display name of the nudge in a nudge plan execution.
• FirstPlanExecutionId: integer (int64)
  Unique identifier of the first nudge plan execution.
• LastPlanExecutionId: integer (int64)
  Unique identifier of the last nudge plan execution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NudgeId: integer (int64)
  Unique identifier of the nudge in a nudge plan execution.
• NudgeKey: string
  Maximum Length: 240

  Unique key of the nudge in a nudge plan execution.
• NudgeName: string
  Read Only: true

  Maximum Length: 150

  Name of the nudge in a nudge plan execution.
• NudgePlanId: integer (int64)
  Unique identifier of the nudge plan.
• NudgeTypeCode: string
  Maximum Length: 80

  Nudge type code in a nudge plan execution.
• NudgeTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Nudge type meaning in a nudge plan execution.
• PlanNudgeId: integer (int64)
  Unique identifier of the nudge plan in a nudge plan execution.
• ProductCode: string
  Read Only: true

  Maximum Length: 30

  Product code of the nudge.

{
    "type":"object",
    "properties":{
        "AssigneeName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the assignee of a nudge in a nudge plan execution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NudgeTypeCode":{
            "maxLength":80,
            "type":"string",
            "description":"Nudge type code in a nudge plan execution.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductCode":{
            "maxLength":30,
            "type":"string",
            "description":"Product code of the nudge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NudgeId":{
            "type":"integer",
            "description":"Unique identifier of the nudge in a nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssigneePersonId":{
            "type":"integer",
            "description":"Person identifier of the assignee of a nudge in a nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanNudgeId":{
            "type":"integer",
            "description":"Unique identifier of the nudge plan in a nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NudgeName":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the nudge in a nudge plan execution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NudgePlanId":{
            "type":"integer",
            "description":"Unique identifier of the nudge plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstPlanExecutionId":{
            "type":"integer",
            "description":"Unique identifier of the first nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "channels":{
            "title":"Channels",
            "type":"array",
            "description":"The channels resource provides all the channels through which a nudge is triggered. It's a child of the nudges resource.",
            "items":{
                "$ref":"#/components/schemas/nudgePlanExecutions-nudges-channels-item-response"
            }
        },
        "NudgeKey":{
            "maxLength":240,
            "type":"string",
            "description":"Unique key of the nudge in a nudge plan execution.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the nudge in a nudge plan execution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastPlanExecutionId":{
            "type":"integer",
            "description":"Unique identifier of the last nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment identifier of the assignee of a nudge in a nudge plan execution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NudgeTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Nudge type meaning in a nudge plan execution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object nudgePlanExecutions-nudges-channels-item-response

{
    "title":"Channels",
    "type":"array",
    "description":"The channels resource provides all the channels through which a nudge is triggered. It's a child of the nudges resource.",
    "items":{
        "$ref":"#/components/schemas/nudgePlanExecutions-nudges-channels-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : nudgePlanExecutions-nudges-channels-item-response

Type: object

Show Source

• ChannelType: string
  Maximum Length: 30

  Type of the channel.
• ChannelTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the channel type.
• EndDate: string (date)
  Read Only: true

  End date of the channel in a nudge plan execution.
• ErrorDetails: string
  Maximum Length: 4000

  Error details of the nudge channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NudgeChannelDetailId: integer (int64)
  Unique identifier of the nudge channel.
• NudgeId: integer (int64)
  Unique identifier of the nudge.
• RecipientPersonId: integer (int64)
  Person identifier of recipient of a nudge in a nudge plan execution.
• RecipientPersonName: string
  Read Only: true

  Maximum Length: 240

  Person name of recipient of a nudge in a nudge plan execution.
• RecipientType: string
  Maximum Length: 30

  Recipient type of a nudge in a nudge plan execution.
• RecipientTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Recipient type meaning of a nudge in a nudge plan execution.
• StartDate: string (date)
  Read Only: true

  Start date of the channel in a nudge plan execution.
• Status: string
  Maximum Length: 30

  Status of the nudge channel in a nudge plan execution.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the channel status of a nudge in a nudge plan execution.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the nudge channel in a nudge plan execution.",
            "nullable":false,
            "x-queryable":true
        },
        "RecipientTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Recipient type meaning of a nudge in a nudge plan execution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NudgeId":{
            "type":"integer",
            "description":"Unique identifier of the nudge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorDetails":{
            "maxLength":4000,
            "type":"string",
            "description":"Error details of the nudge channel.",
            "nullable":true,
            "x-queryable":true
        },
        "RecipientType":{
            "maxLength":30,
            "type":"string",
            "description":"Recipient type of a nudge in a nudge plan execution.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the channel in a nudge plan execution.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientPersonId":{
            "type":"integer",
            "description":"Person identifier of recipient of a nudge in a nudge plan execution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the channel in a nudge plan execution.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the channel status of a nudge in a nudge plan execution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the channel type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NudgeChannelDetailId":{
            "type":"integer",
            "description":"Unique identifier of the nudge channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChannelType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "RecipientPersonName":{
            "maxLength":240,
            "type":"string",
            "description":"Person name of recipient of a nudge in a nudge plan execution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

findByAdvancedSearchQuery

Operation: /hcmRestApi/resources/11.13.18.05/nudgePlanExecutions/action/findByAdvancedSearchQuery

Finds nudge plans execution based on the search criteria.

Back to Top