Jump to

• Request
• Response

Update an event setup

patch

/fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}

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=

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the event is active or inactive.
• EventDescription: string
  Title: Event Description

  Maximum Length: 240

  The description of the 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "EventTypeCode":{
            "title":"Event Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PayloadAttributes":{
            "title":"Payload Attributes",
            "type":"string",
            "description":"The attributes of payload expected for the event.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PayloadAttributesClob"
                ]
            }
        },
        "EventPayloadFormat":{
            "title":"Event Payload Format",
            "type":"string",
            "description":"The format of the event payload that the subscribers will receive.",
            "format":"byte",
            "nullable":true
        },
        "eventSubscribers":{
            "title":"Event Subscribers",
            "type":"array",
            "description":"The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event.",
            "items":{
                "$ref":"#/components/schemas/eventSetups-eventSubscribers-item-patch-request"
            }
        },
        "EventPayloadTypeCode":{
            "title":"Event Payload Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SystemDefinedFlag":{
            "title":"Application Defined Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event is system-defined or not.",
            "nullable":false,
            "default":false
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the event, such as Add Enrollment.",
            "nullable":false
        },
        "mappedEventCategories":{
            "title":"Event Categories",
            "type":"array",
            "description":"The event categories resource lists all the categories of an event.",
            "items":{
                "$ref":"#/components/schemas/eventSetups-mappedEventCategories-item-patch-request"
            }
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the event.",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event is active or inactive.",
            "nullable":false
        },
        "ExternalFlag":{
            "title":"External Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the event originated from an external source. For example, a grade posted event that originated from an external learning management system.",
            "nullable":true
        }
    }
}

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

• Array of: object eventSetups-eventSubscribers-item-patch-request

{
    "title":"Event Subscribers",
    "type":"array",
    "description":"The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event.",
    "items":{
        "$ref":"#/components/schemas/eventSetups-eventSubscribers-item-patch-request"
    }
}

Nested Schema : Event Categories

Type: array

Title: Event Categories

The event categories resource lists all the categories of an event.

Show Source

• Array of: object eventSetups-mappedEventCategories-item-patch-request

{
    "title":"Event Categories",
    "type":"array",
    "description":"The event categories resource lists all the categories of an event.",
    "items":{
        "$ref":"#/components/schemas/eventSetups-mappedEventCategories-item-patch-request"
    }
}

Nested Schema : eventSetups-eventSubscribers-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "eventSubscriberTimingRules":{
            "title":"Event Subscriber Timing Rules",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/eventSetups-eventSubscribers-eventSubscriberTimingRules-item-patch-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Event Subscriber Timing Rules",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/eventSetups-eventSubscribers-eventSubscriberTimingRules-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":30,
            "type":"string",
            "description":"The communication setup code that's associated with the timing rule.",
            "nullable":true
        },
        "TimingRuleCount":{
            "title":"Timing Rule Count",
            "type":"integer",
            "description":"The counter to keep track of how many times a particular rule has been triggered.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "TimingRuleTypeCode":{
            "title":"Timing Rule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : eventSetups-mappedEventCategories-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : eventSetups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the event setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventTypeCode":{
            "title":"Event Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "eventSubscribers":{
            "title":"Event Subscribers",
            "type":"array",
            "description":"The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event.",
            "items":{
                "$ref":"#/components/schemas/eventSetups-eventSubscribers-item-response"
            }
        },
        "EventTypeMeaning":{
            "title":"Event Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the event type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemDefinedFlag":{
            "title":"Application Defined Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event is system-defined or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the event, such as Add Enrollment.",
            "nullable":false,
            "x-queryable":true
        },
        "MappedCategories":{
            "title":"Categories",
            "type":"string",
            "description":"The categories to which an event is mapped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "mappedEventCategories":{
            "title":"Event Categories",
            "type":"array",
            "description":"The event categories resource lists all the categories of an event.",
            "items":{
                "$ref":"#/components/schemas/eventSetups-mappedEventCategories-item-response"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the event, such as ADMINADDENRLL.",
            "nullable":false,
            "x-queryable":true
        },
        "PayloadAttributes":{
            "title":"Payload Attributes",
            "type":"string",
            "description":"The attributes of payload expected for the event.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PayloadAttributesClob"
                ]
            },
            "x-queryable":true
        },
        "EventPayloadFormat":{
            "title":"Event Payload Format",
            "type":"string",
            "description":"The format of the event payload that the subscribers will receive.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for the event, for example, an identifier for student enrollment event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventPayloadTypeCode":{
            "title":"Event Payload Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the event.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalFlag":{
            "title":"External Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the event originated from an external source. For example, a grade posted event that originated from an external learning management system.",
            "nullable":true,
            "x-queryable":true
        },
        "EventPayloadTypeMeaning":{
            "title":"Event Payload Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the payload type. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_PAYLOAD_FORMAT.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the event was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object eventSetups-eventSubscribers-item-response

{
    "title":"Event Subscribers",
    "type":"array",
    "description":"The event subscribers resource lists all the subscribers of an event. For example, communications is a subscriber for student enrollment event.",
    "items":{
        "$ref":"#/components/schemas/eventSetups-eventSubscribers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Event Categories

Type: array

Title: Event Categories

The event categories resource lists all the categories of an event.

Show Source

• Array of: object eventSetups-mappedEventCategories-item-response

{
    "title":"Event Categories",
    "type":"array",
    "description":"The event categories resource lists all the categories of an event.",
    "items":{
        "$ref":"#/components/schemas/eventSetups-mappedEventCategories-item-response"
    }
}

Nested Schema : eventSetups-eventSubscribers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TargetCode":{
            "title":"Target Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the target referenced in the target configuration data.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "TargetDescription":{
            "title":"Target Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the event subscriber target.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "eventSubscriberTimingRules":{
            "title":"Event Subscriber Timing Rules",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventSubscriberId":{
            "title":"Event Subscriber ID",
            "type":"integer",
            "description":"The unique identifier for the subscriber to an event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TargetName":{
            "title":"Target Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the event subscriber target, such as Communication.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayloadTargetCode":{
            "title":"Payload Target Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the payload target referenced in the target configuration data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalFlag":{
            "title":"External Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the target is external, for example, an external SOAP service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetId":{
            "title":"Target ID",
            "type":"integer",
            "description":"The identifier for the subscriber in the target configuration data.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TargetName"
                ]
            },
            "x-queryable":true
        },
        "PayloadTargetId":{
            "title":"Payload Target ID",
            "type":"integer",
            "description":"The resource which will provide the payload information required to process the event successfully.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response

{
    "title":"Event Subscriber Timing Rules",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TimingRuleTypeCodeMeaning":{
            "title":"Timing Rule Type Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":30,
            "type":"string",
            "description":"The communication setup code that's associated with the timing rule.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TimingRuleCount":{
            "title":"Timing Rule Count",
            "type":"integer",
            "description":"The counter to keep track of how many times a particular rule has been triggered.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "EventSubscrTimingRuleId":{
            "title":"Event Subscriber Timing Rule ID",
            "type":"integer",
            "description":"The unique identifier for the timing rule associated with the subscriber of an event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TimingRuleTypeCode":{
            "title":"Timing Rule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : eventSetups-mappedEventCategories-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The unique identifier for the category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategoryEventMapId":{
            "title":"Category Event Map ID",
            "type":"integer",
            "description":"The unique identifier for the category event mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "title":"Category Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category is active or inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

EventPayloadTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

EventTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

eventSubscribers

Operation: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/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.

mappedEventCategories

Operation: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/mappedEventCategories

Parameters:

• EventId: $request.path.EventId

The event categories resource lists all the categories of an event.

Back to Top