Jump to

• Request
• Response

Get all event instances

get

/fscmRestApi/resources/11.13.18.05/eventInstances

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all event Instances that match the primary key criteria specified.
    Finder Variables
    • EventInstanceId; integer; Unique identifier for an event instance.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ErrorMessage; string; The error message regarding delivery of the event instance.
  • EventId; integer; The unique identifier for the event, for example, an identifier for student enrollment event.
  • EventInstanceDate; string; The date when the event instance was created.
  • EventInstanceId; integer; The unique identifier for the event instance.
  • EventInstanceStatusCode; string; 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; 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; The name of the event, such as Add Enrollment.
  • EventOccurrenceDate; string; The date when the event instance occurred.
  • EventPublishDate; string; The date when the event instance was published.
  • ExpiredFlag; boolean; Indicates whether the event instance has expired and no longer needs to be tracked.
  • PublishRetryCount; integer; The number of retries that have been performed to deliver the event payload.
  • TrackingId; integer; The unique identifier for tracking the delivery of the event instance.
  • TrackingMessage; string; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : eventInstances

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/eventInstances-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object eventInstances-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/eventInstances-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 : 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."
        }
    }
}

Links

calculateEventStatistics

Operation: /fscmRestApi/resources/11.13.18.05/eventInstances/action/calculateEventStatistics

Calculates the statistics for event instances. For example, calculates the number of event instances that were successfully published, or failed, or didn't attempt to publish to the subscribers asynchronously.

Back to Top