Jump to

• Request
• Response

Create an event instance

post

/fscmRestApi/resources/11.13.18.05/eventInstances

Request

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ErrorMessage: string
  Title: Error Message

  Maximum Length: 4000

  The error message regarding delivery of the event instance.
• EventCode: string
  Title: Event Code

  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.
• EventInstanceDate: string (date)
  Title: Event Instance Date

  The date when the event instance was created.
• EventInstanceId: integer (int64)
  Title: Event Instance ID

  The unique identifier for the event instance.
• EventInstanceStatusCode: string
  Title: Event Instance Status Code

  Maximum Length: 30

  The status code of event instance, such as ORA_HEY_EVENT_PUBLISHED or ORA_HEY_EVENT_UNATTEMPTED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_INSTANCE_STATUS.
• EventOccurrenceDate: string (date-time)
  Title: Occurrence Date

  The date when the event instance occurred.
• EventPublishDate: string (date-time)
  Title: Event Publish Date

  The date when the event instance was published.
• ExpiredFlag: boolean
  Title: Expired Indicator

  Maximum Length: 1

  Indicates whether the event instance has expired and no longer needs to be tracked.
• Payload: string (byte)
  Title: Payload

  The payload sent by the event publisher, for example, a payload that contains the list of recipients who are impacted by the event occurrence and to whom communication should be sent.
• PublishRetryCount: integer (int32)
  Title: Publish Retry Count

  The number of retries that have been performed to deliver the event payload.
• SubscriberErrorMessage: string
  Title: Subscriber Error Message

  The error message regarding receipt of event instance by the subscriber.
• SubscriberStatusCode: string
  Title: Subscriber Status Code

  The status code of the event instance being delivered to and processed by the subscriber, such as ORA_HEY_SUBSCRIBER_SUCCESS or ORA_HEY_SUBSCRIBER_FAILED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_SUBSCRIBER_STATUS.
• SubscriberStatusId: integer
  Title: Subscriber Status ID

  The unique identifier for the event instance subscriber status.
• TrackingId: integer (int64)
  Title: Tracking ID

  The unique identifier for tracking the delivery of the event instance.
• TrackingMessage: string
  Title: Tracking Message

  Maximum Length: 900

  The tracking message regarding delivery of the event instance. The tracking message contains details such as whether the event was accepted for delivery to subscribers.

{
    "type":"object",
    "properties":{
        "PublishRetryCount":{
            "title":"Publish Retry Count",
            "type":"integer",
            "description":"The number of retries that have been performed to deliver the event payload.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "TrackingMessage":{
            "title":"Tracking Message",
            "maxLength":900,
            "type":"string",
            "description":"The tracking message regarding delivery of the event instance. The tracking message contains details such as whether the event was accepted for delivery to subscribers.",
            "nullable":true
        },
        "SubscriberErrorMessage":{
            "title":"Subscriber Error Message",
            "type":"string",
            "description":"The error message regarding receipt of event instance by the subscriber.",
            "nullable":true,
            "x-queryable":false
        },
        "TrackingId":{
            "title":"Tracking ID",
            "type":"integer",
            "description":"The unique identifier for tracking the delivery of the event instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExpiredFlag":{
            "title":"Expired Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event instance has expired and no longer needs to be tracked.",
            "nullable":false
        },
        "EventCode":{
            "title":"Event Code",
            "type":"string",
            "description":"The unique code for the event, such as ADMINADDENRLL.",
            "nullable":true,
            "x-queryable":false
        },
        "EventInstanceDate":{
            "title":"Event Instance Date",
            "type":"string",
            "description":"The date when the event instance was created.",
            "format":"date",
            "nullable":true
        },
        "EventInstanceId":{
            "title":"Event Instance ID",
            "type":"integer",
            "description":"The unique identifier for the event instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SubscriberStatusId":{
            "title":"Subscriber Status ID",
            "type":"integer",
            "description":"The unique identifier for the event instance subscriber status.",
            "nullable":true,
            "x-queryable":false
        },
        "EventOccurrenceDate":{
            "title":"Occurrence Date",
            "type":"string",
            "description":"The date when the event instance occurred.",
            "format":"date-time",
            "nullable":true
        },
        "EventInstanceStatusCode":{
            "title":"Event Instance Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of event instance, such as ORA_HEY_EVENT_PUBLISHED or ORA_HEY_EVENT_UNATTEMPTED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_INSTANCE_STATUS.",
            "nullable":false
        },
        "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,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "EventCode"
                ]
            }
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload sent by the event publisher, for example, a payload that contains the list of recipients who are impacted by the event occurrence and to whom communication should be sent.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriberStatusCode":{
            "title":"Subscriber Status Code",
            "type":"string",
            "description":"The status code of the event instance being delivered to and processed by the subscriber, such as ORA_HEY_SUBSCRIBER_SUCCESS or ORA_HEY_SUBSCRIBER_FAILED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_SUBSCRIBER_STATUS.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "title":"Error Message",
            "maxLength":4000,
            "type":"string",
            "description":"The error message regarding delivery of the event instance.",
            "nullable":true
        },
        "EventPublishDate":{
            "title":"Event Publish Date",
            "type":"string",
            "description":"The date when the event instance was published.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : eventInstances-item-response

Type: object

Show Source

• ErrorMessage: string
  Title: Error Message

  Maximum Length: 4000

  The error message regarding delivery of the event instance.
• EventCode: string
  Title: Event Code

  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.
• EventInstanceDate: string (date)
  Title: Event Instance Date

  The date when the event instance was created.
• EventInstanceId: integer (int64)
  Title: Event Instance ID

  The unique identifier for the event instance.
• EventInstanceStatusCode: string
  Title: Event Instance Status Code

  Maximum Length: 30

  The status code of event instance, such as ORA_HEY_EVENT_PUBLISHED or ORA_HEY_EVENT_UNATTEMPTED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_INSTANCE_STATUS.
• EventInstanceStatusMeaning: string
  Title: Event Status

  Read Only: true

  Maximum Length: 80

  The status of event instance, such as published or not attempted. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_INSTANCE_STATUS.
• EventName: string
  Title: Event Name

  Read Only: true

  Maximum Length: 50

  The name of the event, such as Add Enrollment.
• EventOccurrenceDate: string (date-time)
  Title: Occurrence Date

  The date when the event instance occurred.
• EventPublishDate: string (date-time)
  Title: Event Publish Date

  The date when the event instance was published.
• ExpiredFlag: boolean
  Title: Expired Indicator

  Maximum Length: 1

  Indicates whether the event instance has expired and no longer needs to be tracked.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Payload: string (byte)
  Title: Payload

  The payload sent by the event publisher, for example, a payload that contains the list of recipients who are impacted by the event occurrence and to whom communication should be sent.
• PublishRetryCount: integer (int32)
  Title: Publish Retry Count

  The number of retries that have been performed to deliver the event payload.
• SubscriberErrorMessage: string
  Title: Subscriber Error Message

  The error message regarding receipt of event instance by the subscriber.
• SubscriberStatusCode: string
  Title: Subscriber Status Code

  The status code of the event instance being delivered to and processed by the subscriber, such as ORA_HEY_SUBSCRIBER_SUCCESS or ORA_HEY_SUBSCRIBER_FAILED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_SUBSCRIBER_STATUS.
• SubscriberStatusId: integer
  Title: Subscriber Status ID

  The unique identifier for the event instance subscriber status.
• TrackingId: integer (int64)
  Title: Tracking ID

  The unique identifier for tracking the delivery of the event instance.
• TrackingMessage: string
  Title: Tracking Message

  Maximum Length: 900

  The tracking message regarding delivery of the event instance. The tracking message contains details such as whether the event was accepted for delivery to subscribers.

{
    "type":"object",
    "properties":{
        "PublishRetryCount":{
            "title":"Publish Retry Count",
            "type":"integer",
            "description":"The number of retries that have been performed to deliver the event payload.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "TrackingMessage":{
            "title":"Tracking Message",
            "maxLength":900,
            "type":"string",
            "description":"The tracking message regarding delivery of the event instance. The tracking message contains details such as whether the event was accepted for delivery to subscribers.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriberErrorMessage":{
            "title":"Subscriber Error Message",
            "type":"string",
            "description":"The error message regarding receipt of event instance by the subscriber.",
            "nullable":true,
            "x-queryable":false
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the event, such as Add Enrollment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrackingId":{
            "title":"Tracking ID",
            "type":"integer",
            "description":"The unique identifier for tracking the delivery of the event instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpiredFlag":{
            "title":"Expired Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the event instance has expired and no longer needs to be tracked.",
            "nullable":false,
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "type":"string",
            "description":"The unique code for the event, such as ADMINADDENRLL.",
            "nullable":true,
            "x-queryable":false
        },
        "EventInstanceDate":{
            "title":"Event Instance Date",
            "type":"string",
            "description":"The date when the event instance was created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EventInstanceId":{
            "title":"Event Instance ID",
            "type":"integer",
            "description":"The unique identifier for the event instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SubscriberStatusId":{
            "title":"Subscriber Status ID",
            "type":"integer",
            "description":"The unique identifier for the event instance subscriber status.",
            "nullable":true,
            "x-queryable":false
        },
        "EventInstanceStatusMeaning":{
            "title":"Event Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of event instance, such as published or not attempted. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_INSTANCE_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventOccurrenceDate":{
            "title":"Occurrence Date",
            "type":"string",
            "description":"The date when the event instance occurred.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EventInstanceStatusCode":{
            "title":"Event Instance Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of event instance, such as ORA_HEY_EVENT_PUBLISHED or ORA_HEY_EVENT_UNATTEMPTED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_INSTANCE_STATUS.",
            "nullable":false,
            "x-queryable":true
        },
        "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,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "EventCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload sent by the event publisher, for example, a payload that contains the list of recipients who are impacted by the event occurrence and to whom communication should be sent.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriberStatusCode":{
            "title":"Subscriber Status Code",
            "type":"string",
            "description":"The status code of the event instance being delivered to and processed by the subscriber, such as ORA_HEY_SUBSCRIBER_SUCCESS or ORA_HEY_SUBSCRIBER_FAILED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_SUBSCRIBER_STATUS.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "title":"Error Message",
            "maxLength":4000,
            "type":"string",
            "description":"The error message regarding delivery of the event instance.",
            "nullable":true,
            "x-queryable":true
        },
        "EventPublishDate":{
            "title":"Event Publish Date",
            "type":"string",
            "description":"The date when the event instance was published.",
            "format":"date-time",
            "nullable":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"
    }
}

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."
        }
    }
}

Back to Top