Create an event subscriber timing rule
post
/fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}/child/eventSubscriberTimingRules
Request
Path Parameters
-
EventId(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=
-
EventSubscriberId(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.
-
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
-
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.
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-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.
Links
- TimingRuleTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_PERIOD_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: TimingRuleTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: