1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Event Setups

Get all event setups

get

/fscmRestApi/resources/11.13.18.05/eventSetups

Request

Query Parameters
  • 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).
  • 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
  • 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

    • KeywordFinder Finds all the event definitions that match the specified keyword in event name, code or event description.
      Finder Variables
      • Active; string; Indicates whether to get active or inactive events.
      • Keyword; string; Keyword; string; to search in event name, event code and event description.
    • PrimaryKey Finds all the event definitions that match the primary key criteria specified.
      Finder Variables
      • EventId; integer; Unique identifier for the event definition.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ActiveFlag; boolean; Indicates whether the event is active or inactive.
    • EventCode; string; The unique code for the event, such as ADMINADDENRLL.
    • EventDescription; string; The description of the event.
    • EventId; integer; The unique identifier for the event, for example, an identifier for student enrollment event.
    • EventName; string; The name of the event, such as Add Enrollment.
    • EventPayloadFormat; string; The format of the event payload that the subscribers will receive.
    • EventPayloadTypeCode; string; 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; The meaning of the payload type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_PAYLOAD_FORMAT.
    • EventTypeCode; string; 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; The meaning of the event type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.
    • ExternalFlag; boolean; 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; The date and time when the event was updated.
    • LastUpdatedBy; string; The user who last updated the event setup.
    • MappedCategories; string; The categories to which an event is mapped.
    • PayloadAttributes; string; The attributes of payload expected for the event.
    • SystemDefinedFlag; boolean; Indicates whether the event is system-defined or not.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : eventSetups
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : eventSetups-item-response
Type: object
Show Source
  • Title: Active
    Maximum Length: 1
    Indicates whether the event is active or inactive.
  • Title: Event Code
    Maximum Length: 30
    The unique code for the event, such as ADMINADDENRLL.
  • Title: Event Description
    Maximum Length: 240
    The description of the event.
  • Title: Event ID
    Read Only: true
    The unique identifier for the event, for example, an identifier for student enrollment event.
  • Title: Event Name
    Maximum Length: 50
    The name of the event, such as Add Enrollment.
  • Title: Event Payload Format
    The format of the event payload that the subscribers will receive.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the event was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the event setup.
  • Links
  • Title: Categories
    Read Only: true
    The categories to which an event is mapped.
  • Event Categories
    Title: Event Categories
    The event categories resource lists all the categories of an event.
  • Title: Payload Attributes
    The attributes of payload expected for the event.
  • Title: Predefined Data Indicator
    Read Only: true
    Indicates whether the associated row is predefined.
  • 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-response
Type: object
Show Source
  • Title: Event Subscriber ID
    Read Only: true
    The unique identifier for the subscriber to an event.
  • 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.
  • Title: External Indicator
    Read Only: true
    Maximum Length: 1
    Indicates if the target is external, for example, an external SOAP service.
  • Links
  • Title: Payload Target Code
    Read Only: true
    Maximum Length: 30
    The code for the payload target referenced in the target configuration data.
  • Title: Payload Target ID
    Read Only: true
    The resource which will provide the payload information required to process the event successfully.
  • Title: Predefined Data Indicator
    Read Only: true
    Indicates whether the associated row is predefined.
  • Title: Target Code
    Maximum Length: 30
    The code for the target referenced in the target configuration data.
  • Title: Target Description
    Read Only: true
    Maximum Length: 240
    The description of the event subscriber target.
  • Title: Target ID
    The identifier for the subscriber in the target configuration data.
  • 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 : eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response
Type: object
Show Source
  • Title: Event Subscriber Timing Rule ID
    Read Only: true
    The unique identifier for the timing rule associated with the subscriber of an event.
  • Links
  • Title: Predefined Data Indicator
    Read Only: true
    Indicates whether the associated row is predefined.
  • Title: Timing Rule Count
    The counter to keep track of how many times a particular rule has been triggered.
  • 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.
  • 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.
  • Title: Transaction Code
    Maximum Length: 30
    The communication setup code that's associated with the timing rule.
Nested Schema : eventSetups-mappedEventCategories-item-response
Type: object
Show Source
Back to Top