Get all communication and event mappings.
patch
/fscmRestApi/resources/11.13.18.05/communicationTemplateSetups/{CommTemplateSetupId}/child/commEventMappings/{CommEventId}
Request
Path Parameters
-
CommEventId(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=
-
CommTemplateSetupId(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
-
CommChannelTypeCode: string
Title:
Communication Channel Type Code
Maximum Length:30
Code for the communication channel type. -
commSchedulers: array
Communication Scheduler
Title:
Communication Scheduler
The list of schedules for a specific communication template in relation to an event. -
SendImmediateFlag: boolean
Maximum Length:
1
Indicates if the communication must be sent immediately.
Nested Schema : Communication Scheduler
Type:
array
Title:
Communication Scheduler
The list of schedules for a specific communication template in relation to an event.
Show Source
Nested Schema : communicationTemplateSetups-commEventMappings-commSchedulers-item-patch-request
Type:
Show Source
object
-
CommChannelTypeCode: string
Title:
Communication Channel Type Code
Maximum Length:30
Code of communication channel type -
IncrementValue: integer
(int64)
Title:
Increment Value
Numeric value of time used to calculate the schedule date for a communication. -
PivotDateAttribute: string
Title:
Pivot Date Attribute
Maximum Length:80
The date attribute from event payload for pivot date. -
PivotDirectionCode: string
Title:
Pivot Direction
Maximum Length:30
The direction of the pivot. Example of pivot directions are after and before. -
TimeUnitCode: string
Title:
Time Unit
Maximum Length:30
Unit of Time used to calculate the schedule date for the communication. For example, minutes, hours, or days.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : communicationTemplateSetups-commEventMappings-item-response
Type:
Show Source
object
-
CommChannelTypeCode: string
Title:
Communication Channel Type Code
Maximum Length:30
Code for the communication channel type. -
CommChannelTypeMeaning: string
Title:
Communication Channel Type Code Meaning
Read Only:true
Maximum Length:80
The meaning of the communication channel type code. Examples of channels are email and SMS. -
CommEventId: integer
(int64)
Title:
Communication Event ID
Read Only:true
The unique identifier for communication event mapping. -
commSchedulers: array
Communication Scheduler
Title:
Communication Scheduler
The list of schedules for a specific communication template in relation to an event. -
EventCode: string
Title:
Event Code
Maximum Length:30
The unique code for the event, such as ADMINADDENRLL. -
EventDescription: string
Title:
Event Description
Read Only:true
Maximum Length:240
The description of an event that triggers a communication. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for an event. -
EventName: string
Title:
Event
Read Only:true
Maximum Length:50
The name of an event, such as Admissions Application Submission. -
EventTypeCode: string
Title:
Event Type
Read Only:true
Maximum Length:30
The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeededDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Predefined Data Indicator -
SendImmediateFlag: boolean
Maximum Length:
1
Indicates if the communication must be sent immediately.
Nested Schema : Communication Scheduler
Type:
array
Title:
Communication Scheduler
The list of schedules for a specific communication template in relation to an event.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : communicationTemplateSetups-commEventMappings-commSchedulers-item-response
Type:
Show Source
object
-
CommChannelTypeCode: string
Title:
Communication Channel Type Code
Maximum Length:30
Code of communication channel type -
CommChannelTypeMeaning: string
Title:
Communication Channel Type Code Meaning
Read Only:true
Maximum Length:80
The meaning of the communication channel type code. Examples of channels are email and SMS. -
CommSchedulerId: integer
(int64)
Title:
Communication Scheduler ID
Read Only:true
The unique identifier of the communication schedule. -
IncrementValue: integer
(int64)
Title:
Increment Value
Numeric value of time used to calculate the schedule date for a communication. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PivotDateAttribute: string
Title:
Pivot Date Attribute
Maximum Length:80
The date attribute from event payload for pivot date. -
PivotDirectionCode: string
Title:
Pivot Direction
Maximum Length:30
The direction of the pivot. Example of pivot directions are after and before. -
PivotDirectionMeaning: string
Title:
Pivot Direction Code Meaning
Read Only:true
Maximum Length:80
The meaning of the pivot direction code type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE. -
SeededDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Predefined Data Indicator -
TimeUnitCode: string
Title:
Time Unit
Maximum Length:30
Unit of Time used to calculate the schedule date for the communication. For example, minutes, hours, or days. -
TimeUnitMeaning: string
Title:
Time Unit Code Meaning
Read Only:true
Maximum Length:80
The meaning of the time unit type. A list of accepted values is defined in the lookup type ORA_HEY_COMM_TIME_UNIT_TYPE.
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.
Links
- CommChannelTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_COMM_CHANNEL
The following properties are defined on the LOV link relation:- Source Attribute: CommChannelTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EventSetupLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: EventCode; Target Attribute: EventCode
- Display Attribute: EventName
- commSchedulers
-
Parameters:
- CommEventId:
$request.path.CommEventId
- CommTemplateSetupId:
$request.path.CommTemplateSetupId
The list of schedules for a specific communication template in relation to an event. - CommEventId: