Update an event subscriber target
patch
/fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}
Request
Path Parameters
-
TargetId(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
-
ActiveFlag: boolean
Title:
Active Indicator
Maximum Length:1
Indicates whether the target is active or inactive. -
eventSetups: array
Event Setups
Title:
Event Setups
The event setups resource lists all the events associated with the target. -
ExternalFlag: boolean
Title:
External Indicator
Maximum Length:1
Indicates whether the target is external or internal. -
InvocationHandle: string
Title:
Invocation Handle
Maximum Length:240
The invocation handle of the target. For example, a Java target contains the fully qualified path of the Java method. -
SystemDefinedFlag: boolean
Title:
Application Defined Indicator
Maximum Length:1
Indicates if the event subscriber target is application defined. -
TargetCode: string
Title:
Target Code
Maximum Length:30
The unique code for the target, such as EVENT_COMMUNICATION. -
TargetDescription: string
Title:
Target Description
Maximum Length:240
The description of the target. -
TargetId: integer
(int64)
Title:
Target ID
The unique identifier for the target, for example, an identifier for communication. -
TargetName: string
Title:
Target Name
Maximum Length:50
The name of the target, such as Event Communication. -
TargetTypeCode: string
Title:
Target Type Code
Maximum Length:30
The code that indicates the target type, for example, ORA_HEY_REST_TARGET and or ORA_HEY_CALLBACK_TARGET. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_TYPE. -
TargetURLSuffix: string
Title:
Target URL Suffix
Maximum Length:240
The suffix of the target URL. URL suffix means parameters at the end of URL. -
TargetValidationDate: string
(date-time)
Title:
Target Validation Date
Date on which the target URL was last validated. -
TargetValidationStatusCode: string
Title:
Target Validation Status Code
Maximum Length:30
Validation status of the target URL.
Nested Schema : Event Setups
Type:
array
Title:
Event Setups
The event setups resource lists all the events associated with the target.
Show Source
Nested Schema : eventSubscriberTargets-eventSetups-item-patch-request
Type:
Show Source
object
-
EventCode: string
Title:
Event Code
Maximum Length:30
The unique code for the event, such as ADMINADDENRLL. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for the event, for example, an identifier for student enrollment event.
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 : eventSubscriberTargets-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active Indicator
Maximum Length:1
Indicates whether the target is active or inactive. -
eventSetups: array
Event Setups
Title:
Event Setups
The event setups resource lists all the events associated with the target. -
ExternalFlag: boolean
Title:
External Indicator
Maximum Length:1
Indicates whether the target is external or internal. -
InvocationHandle: string
Title:
Invocation Handle
Maximum Length:240
The invocation handle of the target. For example, a Java target contains the fully qualified path of the Java method. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the target configuration was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the target configuration setup. -
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. -
SystemDefinedFlag: boolean
Title:
Application Defined Indicator
Maximum Length:1
Indicates if the event subscriber target is application defined. -
TargetCode: string
Title:
Target Code
Maximum Length:30
The unique code for the target, such as EVENT_COMMUNICATION. -
TargetDescription: string
Title:
Target Description
Maximum Length:240
The description of the target. -
TargetId: integer
(int64)
Title:
Target ID
The unique identifier for the target, for example, an identifier for communication. -
TargetName: string
Title:
Target Name
Maximum Length:50
The name of the target, such as Event Communication. -
TargetTypeCode: string
Title:
Target Type Code
Maximum Length:30
The code that indicates the target type, for example, ORA_HEY_REST_TARGET and or ORA_HEY_CALLBACK_TARGET. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_TYPE. -
TargetTypeCodeMeaning: string
Title:
Target Type Code Meaning
Read Only:true
Maximum Length:80
The meaning of the target type code. For example, REST for ORA_HEY_REST_TARGET and Callback for ORA_HEY_CALLBACK_TARGET. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_TYPE. -
TargetURLSuffix: string
Title:
Target URL Suffix
Maximum Length:240
The suffix of the target URL. URL suffix means parameters at the end of URL. -
TargetValidationDate: string
(date-time)
Title:
Target Validation Date
Date on which the target URL was last validated. -
TargetValidationStatusCode: string
Title:
Target Validation Status Code
Maximum Length:30
Validation status of the target URL. -
TargetValidationStatusMeaning: string
Title:
Target Validation Status Meaning
Read Only:true
Maximum Length:80
The meaning of the target validation status. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_VALIDATION_STATUS.
Nested Schema : Event Setups
Type:
array
Title:
Event Setups
The event setups resource lists all the events associated with the target.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : eventSubscriberTargets-eventSetups-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
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:
Description
Read Only:true
Maximum Length:240
The description of the event. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for the event, for example, an identifier for student enrollment event. -
EventName: string
Title:
Event Name
Read Only:true
Maximum Length:50
The name of the event, such as Add Enrollment. -
EventSubscriberId: integer
(int64)
Title:
Event Subscriber ID
Read Only:true
The unique identifier for the event subscriber. -
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. -
ExternalFlag: boolean
Title:
External Source
Read Only:true
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. -
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
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
- TargetTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{TargetTypeCode}%2CLookupType%3DORA_HEY_TARGET_TYPE
The list of values for the target type code associated with the event subscriber targets. - finder:
- TargetValidationStatusLOV
-
Parameters:
- finder:
LookupTypeFinder
The list of values for the target validation status code associated with the event subscriber targets. - finder:
- eventSetups
-
Parameters:
- TargetId:
$request.path.TargetId
The event setups resource lists all the events associated with the target. - TargetId: