Create an event in a journey template
post
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events
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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Category: string
Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.
-
Description: string
Description of the task.
-
EventDate: string
Date of the event.
-
EventOffset: integer
Offset duration of the event.
-
EventURL: string
URL of the event.
-
ImageURL: string
URL of the event background image.
-
Sequence: integer
(int32)
Task display ordering sequence. Default is 1.
-
Title: string
Title of the event.
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-events-item-response
Type:
Show Source
object
-
Category: string
Category code for the event. Values are from ORA_PER_ONB_CONTENT_SBTYP_EVNT lookup. For example, Insight.
-
CategoryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the event category meaning. For example, Insight. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the event. -
CreationDate: string
(date-time)
Read Only:
true
Date the event was created. -
Description: string
Description of the task.
-
EventDate: string
Date of the event.
-
EventOffset: integer
Offset duration of the event.
-
EventURL: string
URL of the event.
-
ImageURL: string
URL of the event background image.
-
JourneyEventId: integer
(int64)
Read Only:
true
Unique identifier of the journey event. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the event was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sequence: integer
(int32)
Task display ordering sequence. Default is 1.
-
Title: string
Title of the 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.