Update an action event
patch
/crmRestApi/resources/11.13.18.05/actionEvents/{RequestActionCaptureId}
Request
Path Parameters
-
RequestActionCaptureId(required): integer(int64)
The unique identifier of the action event capture.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
RequestActionCaptureId: integer
(int64)
Title:
Request Action Capture ID
The unique identifier of the action event capture. -
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.
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.
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: