Create a notification in a journey template
post
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications
Request
Path Parameters
-
JourneyId(required): integer(int64)
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=
-
JourneyTaskId(required): integer(int64)
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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
NotifyOwnerFlag: boolean
Maximum Length:
30
Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No. -
NotifyPerformerFlag: boolean
Maximum Length:
30
Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes. -
OwnerExpiryTemplateId: integer
(int64)
Primary key or unique identifier of the expiry notification template for task owner.
-
OwnerForceCompleteTemplateId: integer
(int64)
Primary key or unique identifier of the force completion notification template for task owner.
-
OwnerNotApplicableTemplateId: integer
(int64)
Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.
-
OwnerTemplateId: integer
(int64)
Primary key or unique identifier of the notification template for task owner.
-
PerformerExpiryTemplateId: integer
(int64)
Primary key or unique identifier of the expiry notification template for task performer.
-
PerformerForceCompleteTemplateId: integer
(int64)
Primary key or unique identifier of the force completion notification template for task performer.
-
PerformerNotApplicableTemplateId: integer
(int64)
Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.
-
PerformerTemplateId: integer
(int64)
Primary key or unique identifier of the notification template for task performer.
-
TaskEvent: string
Maximum Length:
30
Code of the task event. Example, task initiated, task updated, task deleted, task completed.
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.
Root Schema : journeys-tasks-notifications-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the notification. -
CreationDate: string
(date-time)
Read Only:
true
Date on which the notification was created. -
JourneyTaskNotificationId: integer
(int64)
Read Only:
true
Unique identifier of the journey task notification. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the notification was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the notification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotifyOwnerFlag: boolean
Maximum Length:
30
Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No. -
NotifyPerformerFlag: boolean
Maximum Length:
30
Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes. -
OwnerExpiryTemplateId: integer
(int64)
Primary key or unique identifier of the expiry notification template for task owner.
-
OwnerForceCompleteTemplateId: integer
(int64)
Primary key or unique identifier of the force completion notification template for task owner.
-
OwnerNotApplicableTemplateId: integer
(int64)
Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.
-
OwnerTemplateId: integer
(int64)
Primary key or unique identifier of the notification template for task owner.
-
PerformerExpiryTemplateId: integer
(int64)
Primary key or unique identifier of the expiry notification template for task performer.
-
PerformerForceCompleteTemplateId: integer
(int64)
Primary key or unique identifier of the force completion notification template for task performer.
-
PerformerNotApplicableTemplateId: integer
(int64)
Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.
-
PerformerTemplateId: integer
(int64)
Primary key or unique identifier of the notification template for task performer.
-
TaskEvent: string
Maximum Length:
30
Code of the task event. Example, task initiated, task updated, task deleted, task completed. -
TaskEventMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the task event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.