Create an event setup
post
/fscmRestApi/resources/11.13.18.05/eventSetups
Request
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
-
ActiveFlag(required): boolean
Title:
Active
Maximum Length:1
Indicates whether the event is active or inactive. -
EventCode(required): string
Title:
Event Code
Maximum Length:30
The unique code for the event, such as ADMINADDENRLL. -
EventDescription(required): string
Title:
Event Description
Maximum Length:240
The description of the event. -
EventName(required): string
Title:
Event Name
Maximum Length:50
The name of the event, such as Add Enrollment. -
EventPayloadFormat: string
(byte)
Title:
Event Payload Format
The format of the event payload that the subscribers will receive. -
EventPayloadTypeCode: string
Title:
Event Payload Type Code
Maximum Length:30
The code of payload type which the event expects. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_PAYLOAD_FORMAT. -
eventSubscribers: array
Event Subscribers
Title:
Event Subscribers
The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event. -
EventTypeCode(required): string
Title:
Event Type
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. -
ExternalFlag: boolean
Title:
External Source
Maximum Length:1
Indicates if the event originated from an external source. For example, a grade posted event that originated from an external learning management system. -
mappedEventCategories: array
Event Categories
Title:
Event Categories
The event categories resource lists all the categories of an event. -
PayloadAttributes: string
Title:
Payload Attributes
The attributes of payload expected for the event. -
SystemDefinedFlag: boolean
Title:
Application Defined Indicator
Maximum Length:1
Default Value:false
Indicates whether the event is system-defined or not.
Nested Schema : Event Subscribers
Type:
array
Title:
Event Subscribers
The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event.
Show Source
Nested Schema : Event Categories
Type:
array
Title:
Event Categories
The event categories resource lists all the categories of an event.
Show Source
Nested Schema : eventSetups-eventSubscribers-item-post-request
Type:
Show Source
object
-
eventSubscriberTimingRules: array
Event Subscriber Timing Rules
Title:
Event Subscriber Timing Rules
The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date. -
TargetCode(required): string
Title:
Target Code
Maximum Length:30
The code for the target referenced in the target configuration data. -
TargetId(required): integer
(int64)
Title:
Target ID
The identifier for the subscriber in the target configuration data.
Nested Schema : Event Subscriber Timing Rules
Type:
array
Title:
Event Subscriber Timing Rules
The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
TimingRuleCount: integer
(int32)
Title:
Timing Rule Count
The counter to keep track of how many times a particular rule has been triggered. -
TimingRuleTypeCode: string
Title:
Timing Rule Type Code
Maximum Length:30
The code that indicates the timing rule type, for example, ORA_HEY_DAYS and ORA_HEY_MONTHS. A list of accepted values is defined in the lookup type ORA_HEY_PERIOD_TYPE. -
TransactionCode: string
Title:
Transaction Code
Maximum Length:30
The communication setup code that's associated with the timing rule.
Nested Schema : schema
Type:
Show Source
object
-
CategoryCode: string
Title:
Category Code
Maximum Length:30
The unique code for the category. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier for the category.
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 : eventSetups-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the event is active or inactive. -
EventCode: string
Title:
Event Code
Maximum Length:30
The unique code for the event, such as ADMINADDENRLL. -
EventDescription: string
Title:
Event Description
Maximum Length:240
The description of the event. -
EventId: integer
(int64)
Title:
Event ID
Read Only:true
The unique identifier for the event, for example, an identifier for student enrollment event. -
EventName: string
Title:
Event Name
Maximum Length:50
The name of the event, such as Add Enrollment. -
EventPayloadFormat: string
(byte)
Title:
Event Payload Format
The format of the event payload that the subscribers will receive. -
EventPayloadTypeCode: string
Title:
Event Payload Type Code
Maximum Length:30
The code of payload type which the event expects. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_PAYLOAD_FORMAT. -
EventPayloadTypeMeaning: string
Title:
Event Payload Type Meaning
Read Only:true
Maximum Length:80
The meaning of the payload type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_PAYLOAD_FORMAT. -
eventSubscribers: array
Event Subscribers
Title:
Event Subscribers
The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event. -
EventTypeCode: string
Title:
Event Type
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. -
EventTypeMeaning: string
Title:
Event Type Meaning
Read Only:true
Maximum Length:80
The meaning of the event type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE. -
ExternalFlag: boolean
Title:
External Source
Maximum Length:1
Indicates if the event originated from an external source. For example, a grade posted event that originated from an external learning management system. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the event was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the event setup. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappedCategories: string
Title:
Categories
Read Only:true
The categories to which an event is mapped. -
mappedEventCategories: array
Event Categories
Title:
Event Categories
The event categories resource lists all the categories of an event. -
PayloadAttributes: string
Title:
Payload Attributes
The attributes of payload expected for the event. -
SeededDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined. -
SystemDefinedFlag: boolean
Title:
Application Defined Indicator
Maximum Length:1
Default Value:false
Indicates whether the event is system-defined or not.
Nested Schema : Event Subscribers
Type:
array
Title:
Event Subscribers
The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Event Categories
Type:
array
Title:
Event Categories
The event categories resource lists all the categories of an event.
Show Source
Nested Schema : eventSetups-eventSubscribers-item-response
Type:
Show Source
object
-
EventSubscriberId: integer
(int64)
Title:
Event Subscriber ID
Read Only:true
The unique identifier for the subscriber to an event. -
eventSubscriberTimingRules: array
Event Subscriber Timing Rules
Title:
Event Subscriber Timing Rules
The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date. -
ExternalFlag: boolean
Title:
External Indicator
Read Only:true
Maximum Length:1
Indicates if the target is external, for example, an external SOAP service. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayloadTargetCode: string
Title:
Payload Target Code
Read Only:true
Maximum Length:30
The code for the payload target referenced in the target configuration data. -
PayloadTargetId: integer
(int64)
Title:
Payload Target ID
Read Only:true
The resource which will provide the payload information required to process the event successfully. -
SeededDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined. -
TargetCode: string
Title:
Target Code
Maximum Length:30
The code for the target referenced in the target configuration data. -
TargetDescription: string
Title:
Target Description
Read Only:true
Maximum Length:240
The description of the event subscriber target. -
TargetId: integer
(int64)
Title:
Target ID
The identifier for the subscriber in the target configuration data. -
TargetName: string
Title:
Target Name
Read Only:true
Maximum Length:50
The name of the event subscriber target, such as Communication.
Nested Schema : Event Subscriber Timing Rules
Type:
array
Title:
Event Subscriber Timing Rules
The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response
Type:
Show Source
object
-
EventSubscrTimingRuleId: integer
(int64)
Title:
Event Subscriber Timing Rule ID
Read Only:true
The unique identifier for the timing rule associated with the subscriber of an event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeededDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined. -
TimingRuleCount: integer
(int32)
Title:
Timing Rule Count
The counter to keep track of how many times a particular rule has been triggered. -
TimingRuleTypeCode: string
Title:
Timing Rule Type Code
Maximum Length:30
The code that indicates the timing rule type, for example, ORA_HEY_DAYS and ORA_HEY_MONTHS. A list of accepted values is defined in the lookup type ORA_HEY_PERIOD_TYPE. -
TimingRuleTypeCodeMeaning: string
Title:
Timing Rule Type Code Meaning
Read Only:true
Maximum Length:80
The meaning of the timing rule type code. For example, days for ORA_HEY_DAYS and months for ORA_HEY_MONTHS. A list of accepted values is defined in the lookup type ORA_HEY_PERIOD_TYPE. -
TransactionCode: string
Title:
Transaction Code
Maximum Length:30
The communication setup code that's associated with the timing rule.
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.
Nested Schema : eventSetups-mappedEventCategories-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
Maximum Length:1
Indicates whether the category is active or inactive. -
CategoryCode: string
Title:
Category Code
Maximum Length:30
The unique code for the category. -
CategoryDescription: string
Title:
Category Description
Read Only:true
Maximum Length:240
The description of the category. -
CategoryEventMapId: integer
(int64)
Title:
Category Event Map ID
Read Only:true
The unique identifier for the category event mapping. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier for the category. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:50
The name of the category. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeededDataFlag: boolean
Title:
Predefined Data Indicator
Read Only:true
Indicates whether the associated row is predefined.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- EventPayloadTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{EventPayloadTypeCode}%2CLookupType%3DORA_HEY_EVENT_PAYLOAD_FORMAT
The following properties are defined on the LOV link relation:- Source Attribute: EventPayloadTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EventTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{EventTypeCode}%2CLookupType%3DORA_HEY_EVENT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: EventTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- eventSubscribers
-
Parameters:
- EventId:
$request.path.EventId
The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event. - EventId:
- mappedEventCategories
-
Parameters:
- EventId:
$request.path.EventId
The event categories resource lists all the categories of an event. - EventId: