1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Action Events

Get all action events

get

/crmRestApi/resources/11.13.18.05/actionEvents

Request

Query Parameters
  • 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).
  • 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
  • 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: Find an action event with the specified primary key.
      Finder Variables:
      • RequestActionCaptureId; integer; The unique identifier of the action event capture.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ActionType; string; The REST API method used.
    • CreatedBy; string; The user who created the action event.
    • CreationDate; string; The date when the action event was created.
    • LastUpdateDate; string; The date when the action event was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the action event record.
    • LastUpdatedBy; string; The user who last updated the action event record.
    • ProductFamily; string; The product family of the invoked REST API, such as CRM.
    • ProxyUserFlag; boolean; Indicates whether the session user is an end user or a proxy user.
    • RequestActionCaptureId; integer; The unique identifier of the action event capture.
    • RequestDate; string; The date when the REST API was invoked.
    • RequestHeader; string; The request header that should is included when making a REST call.
    • RequestPayload; string; The payload containing the details of the incoming REST API call.
    • RequestURI; string; The request URI pattern that matches the REST API call.
    • RequestURL; string; The full URL of the REST request including the parameters.
    • ResponseCode; string; The response status code of the REST API called.
    • ResponsePayload; string; The output of the REST API call.
    • SessionId; string; The login details of the user. This attribute is used to track contiguous usage of REST API in applications like digital customer service.
    • SessionTypeId; integer; The unique identifier of the session type.
    • SessionUser; string; The logged in user calling the REST API.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : actionEvents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : actionEvents-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all action events by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/actionEvents

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "RequestActionCaptureId": 300100181442401,
            "SessionId": "user:anonymous-20190729",
            "SessionUser": "anonymous",
            "RequestDate": "2019-07-29T09:00:22+00:00",
            "RequestURI": "/.*",
            "ActionType": "GET",
            "ProxyUserFlag": null,
            "ProductFamily": "CRM",
            "CreationDate": "2019-07-29T09:00:22+00:00",
            "CreatedBy": "anonymous",
            "LastUpdateDate": "2019-07-29T09:00:22+00:00",
            "LastUpdatedBy": "anonymous",
            "LastUpdateLogin": "ANONYMOUS_USER_GUID",
            "SessionTypeId": 100100053060570,
            "RequestHeader": null,
            "RequestURL": null,
            "RequestPayload": null,
            "ResponseCode": null,
            "ResponsePayload": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionEvents/300100181442401",
                    "name": "actionEvents",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionEvents/300100181442401",
                    "name": "actionEvents",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionEvents/300100181442401/lov/YesNoLookupPVO",
                    "name": "YesNoLookupPVO",
                    "kind": "collection"
                }
            ]
        },
        .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionEvents",
            "name": "actionEvents",
            "kind": "collection"
        }
    ]
}
Back to Top