Get an action event
get
/crmRestApi/resources/11.13.18.05/actionEvents/{RequestActionCaptureId}
Request
Path Parameters
-
RequestActionCaptureId(required): integer(int64)
The unique identifier of the action event capture.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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.
Root Schema : actionEvents-item-response
Type:
Show Source
object
-
ActionType: string
Title:
Action Type
Maximum Length:30
The REST API method used. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action event. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the action event was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the action event was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the action event record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the action event record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductFamily: string
Title:
Product Family
Maximum Length:30
Default Value:CRM
The product family of the invoked REST API, such as CRM. -
ProxyUserFlag: boolean
Title:
Is Proxy User
Maximum Length:1
Indicates whether the session user is an end user or a proxy user. -
RequestActionCaptureId: integer
(int64)
Title:
Request Action Capture ID
The unique identifier of the action event capture. -
RequestDate: string
(date-time)
Title:
Request Date
The date when the REST API was invoked. -
RequestHeader: string
Title:
Request Header
Maximum Length:2000
The request header that should is included when making a REST call. -
RequestPayload: string
Title:
Request Payload
Maximum Length:3000
The payload containing the details of the incoming REST API call. -
RequestURI: string
Title:
Request URI
Maximum Length:1000
The request URI pattern that matches the REST API call. -
RequestURL: string
Title:
Request URL
Maximum Length:1000
The full URL of the REST request including the parameters. -
ResponseCode: string
Title:
Response Code
Maximum Length:50
The response status code of the REST API called. -
ResponsePayload: string
Title:
Response Payload
Maximum Length:4000
The output of the REST API call. -
SessionId: string
Title:
Session ID
Maximum Length:200
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
(int64)
Title:
Session Type ID
The unique identifier of the session type. -
SessionUser: string
Title:
Session User
Maximum Length:64
The logged in user calling the REST API.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- YesNoLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: ProxyUserFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to get an action event 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/{RequestActionCaptureId}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "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" } ] }