Jump to

• Request
• Response

Create an event instance subscriber

post

/fscmRestApi/resources/11.13.18.05/eventInstanceSubscribers

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

• DeliveredDate: string (date-time)
  Title: Success Date

  The date on which the event instance was delivered.
• EventInstanceId: integer (int64)
  Title: Event Instance ID

  The unique identifier for the event instance.
• LastRetryDate: string (date-time)
  Title: Last Retry Date

  The date when last retry was performed for delivering the event instance.
• SubscriberErrorMessage: string
  Title: Subscriber Error Message

  Maximum Length: 4000

  The error message regarding receipt of event instance by the subscriber.
• SubscriberInstanceDate: string (date)
  Title: Subscriber Instance Date

  The date on which event instance was sent to the subscriber.
• SubscriberRetryCount: integer (int32)
  Title: Subscriber Retry Count

  The number of times a subscriber has tried to reprocess the event instance.
• SubscriberStatusCode: string
  Title: Subscriber Status Code

  Maximum Length: 30

  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. The patch action can be used with this attribute to retry a failed event delivery. To retry an event delivery for a subscriber, pass the subscriber payload.
• SubscriberStatusId: integer (int64)
  Title: Subscriber Status ID

  The unique identifier for the event instance subscriber status.

{
    "type":"object",
    "properties":{
        "LastRetryDate":{
            "title":"Last Retry Date",
            "type":"string",
            "description":"The date when last retry was performed for delivering the event instance.",
            "format":"date-time",
            "nullable":true
        },
        "DeliveredDate":{
            "title":"Success Date",
            "type":"string",
            "description":"The date on which the event instance was delivered.",
            "format":"date-time",
            "nullable":true
        },
        "SubscriberStatusId":{
            "title":"Subscriber Status ID",
            "type":"integer",
            "description":"The unique identifier for the event instance subscriber status.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EventInstanceId":{
            "title":"Event Instance ID",
            "type":"integer",
            "description":"The unique identifier for the event instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriberRetryCount":{
            "title":"Subscriber Retry Count",
            "type":"integer",
            "description":"The number of times a subscriber has tried to reprocess the event instance.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "SubscriberInstanceDate":{
            "title":"Subscriber Instance Date",
            "type":"string",
            "description":"The date on which event instance was sent to the subscriber.",
            "format":"date",
            "nullable":false
        },
        "SubscriberErrorMessage":{
            "title":"Subscriber Error Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The error message regarding receipt of event instance by the subscriber.",
            "nullable":true
        },
        "SubscriberStatusCode":{
            "title":"Subscriber Status Code",
            "maxLength":"30",
            "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. The patch action can be used with this attribute to retry a failed event delivery. To retry an event delivery for a subscriber, pass the subscriber payload.",
            "nullable":false
        }
    }
}

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 : eventInstanceSubscribers-item-response

Type: object

Show Source

• DeliveredDate: string (date-time)
  Title: Success Date

  The date on which the event instance was delivered.
• EventId: integer (int64)
  Title: Event ID

  Read Only: true

  The unique identifier for an event.
• EventInstanceDate: string (date)
  Title: Instance Date

  Read Only: true

  The date on which event instance was created.
• EventInstanceErrorMessage: string
  Title: Event Instance Error Message

  Read Only: true

  Maximum Length: 4000

  The error message regarding delivery of the event instance.
• EventInstanceId: integer (int64)
  Title: Event Instance ID

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

  Read Only: true

  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 instance that was triggered.
• EventOccurrenceDate: string (date-time)
  Title: Occurrence Date

  Read Only: true

  The date of occurrence of the event instance.
• LastRetryDate: string (date-time)
  Title: Last Retry Date

  The date when last retry was performed for delivering the event instance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RetryAllowed: string
  Title: Retry Allowed

  Read Only: true

  Indicates whether the application or user can retry to trigger the event instance.
• SubscriberErrorMessage: string
  Title: Subscriber Error Message

  Maximum Length: 4000

  The error message regarding receipt of event instance by the subscriber.
• SubscriberInstanceDate: string (date)
  Title: Subscriber Instance Date

  The date on which event instance was sent to the subscriber.
• SubscriberRetryCount: integer (int32)
  Title: Subscriber Retry Count

  The number of times a subscriber has tried to reprocess the event instance.
• SubscriberStatusCode: string
  Title: Subscriber Status Code

  Maximum Length: 30

  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. The patch action can be used with this attribute to retry a failed event delivery. To retry an event delivery for a subscriber, pass the subscriber payload.
• SubscriberStatusId: integer (int64)
  Title: Subscriber Status ID

  The unique identifier for the event instance subscriber status.
• SubscriberStatusMeaning: string
  Title: Subscriber Status

  Read Only: true

  Maximum Length: 80

  The status of the event instance being delivered to and processed by the subscriber, such as successful or failed. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_SUBSCRIBER_STATUS.
• TargetCode: string
  Title: Subscriber Code

  Read Only: true

  Maximum Length: 30

  The unique code of the event instance target.
• TargetId: integer (int64)
  Title: Target ID

  Read Only: true

  The unique identifier for the event subscriber.
• TargetName: string
  Title: Subscriber Name

  Read Only: true

  Maximum Length: 50

  The name of the event instance target, such as Send Communications Service.

{
    "type":"object",
    "properties":{
        "LastRetryDate":{
            "title":"Last Retry Date",
            "type":"string",
            "description":"The date when last retry was performed for delivering the event instance.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriberStatusMeaning":{
            "title":"Subscriber Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the event instance being delivered to and processed by the subscriber, such as successful or failed. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_SUBSCRIBER_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberInstanceDate":{
            "title":"Subscriber Instance Date",
            "type":"string",
            "description":"The date on which event instance was sent to the subscriber.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriberErrorMessage":{
            "title":"Subscriber Error Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The error message regarding receipt of event instance by the subscriber.",
            "nullable":true,
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the event instance that was triggered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetName":{
            "title":"Subscriber Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the event instance target, such as Send Communications Service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetId":{
            "title":"Target ID",
            "type":"integer",
            "description":"The unique identifier for the event subscriber.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EventInstanceDate":{
            "title":"Instance Date",
            "type":"string",
            "description":"The date on which event instance was created.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveredDate":{
            "title":"Success Date",
            "type":"string",
            "description":"The date on which the event instance was delivered.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriberStatusId":{
            "title":"Subscriber Status ID",
            "type":"integer",
            "description":"The unique identifier for the event instance subscriber status.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventInstanceId":{
            "title":"Event Instance ID",
            "type":"integer",
            "description":"The unique identifier for the event instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubscriberRetryCount":{
            "title":"Subscriber Retry Count",
            "type":"integer",
            "description":"The number of times a subscriber has tried to reprocess the event instance.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "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
        },
        "TargetCode":{
            "title":"Subscriber Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code of the event instance target.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventOccurrenceDate":{
            "title":"Occurrence Date",
            "type":"string",
            "description":"The date of occurrence of the event instance.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RetryAllowed":{
            "title":"Retry Allowed",
            "type":"string",
            "description":"Indicates whether the application or user can retry to trigger the event instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventInstanceStatusCode":{
            "title":"Event 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,
            "readOnly":true,
            "x-queryable":true
        },
        "EventInstanceErrorMessage":{
            "title":"Event Instance Error Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The error message regarding delivery of the event instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriberStatusCode":{
            "title":"Subscriber Status Code",
            "maxLength":"30",
            "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. The patch action can be used with this attribute to retry a failed event delivery. To retry an event delivery for a subscriber, pass the subscriber payload.",
            "nullable":false,
            "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