Update a category event
patch
/fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents/{CategoryEventMapId}
Request
Path Parameters
-
CategoryEventMapId(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=
-
CategoryId(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
-
EventId: integer
(int64)
Title:
Event ID
The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted. -
EventName: string
Title:
Event Name
Maximum Length:50
The name of an event, such as Enrollment Drop. -
eventTokens: array
Event Tokens
Title:
Event Tokens
The event tokens resource provides a list of event tokens.
Nested Schema : Event Tokens
Type:
array
Title:
Event Tokens
The event tokens resource provides a list of event tokens.
Show Source
Nested Schema : studentManagementCategories-categoryEvents-eventTokens-item-patch-request
Type:
Show Source
object
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 : studentManagementCategories-categoryEvents-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
Maximum Length:1
Indicates whether an event is active or inactive. -
CategoryEventMapId: integer
(int64)
Title:
Category Event Map ID
Read Only:true
The unique identifier for the category and event mapping. -
EventCode: string
Title:
Event Code
Read Only:true
Maximum Length:30
The unique code for an event. -
EventDescription: string
Title:
Event Description
Read Only:true
Maximum Length:240
The description of an event. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted. -
EventName: string
Title:
Event Name
Maximum Length:50
The name of an event, such as Enrollment Drop. -
EventTimingRuleCode: string
Read Only:
true
Maximum Length:30
The timing rule type code for a date based event. For example, the ORA_HEY_EVENT_TIMING_AFTER code indicates a communication can be sent after the event occurs. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE. -
eventTokens: array
Event Tokens
Title:
Event Tokens
The event tokens resource provides a list of event tokens. -
EventTypeCode: string
Title:
Event Type
Read Only:true
Maximum Length:30
The type of an event, such as a transactional or date-based event. 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
Read Only:
true
Indicates whether the associated row is predefined.
Nested Schema : Event Tokens
Type:
array
Title:
Event Tokens
The event tokens resource provides a list of event tokens.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentManagementCategories-categoryEvents-eventTokens-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TokenCode: string
Title:
Token Code
Read Only:true
Maximum Length:30
The unique code for a communication token. -
TokenDescription: string
Title:
Token Description
Read Only:true
Maximum Length:256
The description of a communication token. -
TokenId: integer
(int64)
Title:
Token ID
Read Only:true
The unique identifier for a communication token. -
TokenIsMandatoryFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that the communication token is required for the mapped event. -
TokenName: string
Title:
Token Name
Read Only:true
Maximum Length:30
The name of a communication token, such as FIRST_NAME. -
TokenTypeCode: string
Title:
Token Type
Read Only:true
Maximum Length:30
The type of a communication token, such as a token specific to a single communication event or a token for all communications. A list of accepted values is defined in the lookup type ORA_HEY_TOKEN_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
- eventSetupsLOV
-
Parameters:
- finder:
KeywordFinder
The list of values for the events. - finder:
- eventTokens
-
Parameters:
- CategoryEventMapId:
$request.path.CategoryEventMapId
- CategoryId:
$request.path.CategoryId
The event tokens resource provides a list of event tokens. - CategoryEventMapId: