Update an action
patch
/crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}
Request
Path Parameters
-
ActivityId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
TemplateId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
activityTemplates_Activity_smartActions_Id(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
ActionContextParameters: string
Title:
Action Context Parameters
Maximum Length:1000
Determines the context when a smart action is applicable. -
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Boolean value indicating if the action is active or inactive. -
ApplicationRoles: string
Title:
Application Roles
Maximum Length:2000
The application roles associated with the smart action. -
Condition: string
Title:
Filter Condition
Maximum Length:1000
Groovy script used to qualify this action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
ContextualFlag: boolean
Title:
Contextual
Maximum Length:1
Indicates if the smart action is contextual. -
DataPrivilege: string
Title:
Data Security Privilege
Maximum Length:250
JSON string containing the Privilege name, the object name, and the object key. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedIn: string
Title:
Included In
Maximum Length:150
The view object this action is part of. Could contain more than one comma-separated value. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
InternalFlag: boolean
Title:
Restricted
Maximum Length:1
Boolean type indicating if this action is internal. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL. -
UserPrivilege: string
Title:
User Security Privilege
Maximum Length:4000
The user security privilege.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : activityTemplates-Activity-smartActions-UserActionRequestPayload-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : activityTemplates-Activity-smartActions-UserActionURLBinding-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
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 : activityTemplates-Activity-smartActions-item-response
Type:
Show Source
object
-
ActionContextParameters: string
Title:
Action Context Parameters
Maximum Length:1000
Determines the context when a smart action is applicable. -
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ActionSource: string
Title:
Action Source
Maximum Length:512
Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Boolean value indicating if the action is active or inactive. -
ApplicationRoles: string
Title:
Application Roles
Maximum Length:2000
The application roles associated with the smart action. -
Condition: string
Title:
Filter Condition
Maximum Length:1000
Groovy script used to qualify this action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
ContextualFlag: boolean
Title:
Contextual
Maximum Length:1
Indicates if the smart action is contextual. -
DataPrivilege: string
Title:
Data Security Privilege
Maximum Length:250
JSON string containing the Privilege name, the object name, and the object key. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedIn: string
Title:
Included In
Maximum Length:150
The view object this action is part of. Could contain more than one comma-separated value. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
InternalFlag: boolean
Title:
Restricted
Maximum Length:1
Boolean type indicating if this action is internal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
Uniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action Name
Maximum Length:256
Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL. -
UserPrivilege: string
Title:
User Security Privilege
Maximum Length:4000
The user security privilege.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
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.
Nested Schema : activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : activityTemplates-Activity-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- UserActionNavigation
-
Parameters:
- ActivityId:
$request.path.ActivityId
- TemplateId:
$request.path.TemplateId
- activityTemplates_Activity_smartActions_Id:
$request.path.activityTemplates_Activity_smartActions_Id
UI navigation metadata striped by app usage. - ActivityId:
- UserActionRequestPayload
-
Parameters:
- ActivityId:
$request.path.ActivityId
- TemplateId:
$request.path.TemplateId
- activityTemplates_Activity_smartActions_Id:
$request.path.activityTemplates_Activity_smartActions_Id
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. - ActivityId:
- UserActionURLBinding
-
Parameters:
- ActivityId:
$request.path.ActivityId
- TemplateId:
$request.path.TemplateId
- activityTemplates_Activity_smartActions_Id:
$request.path.activityTemplates_Activity_smartActions_Id
UI navigation metadata striped by app usage. - ActivityId:
- executeAction
-
Parameters:
- ActivityId:
$request.path.ActivityId
- TemplateId:
$request.path.TemplateId
- activityTemplates_Activity_smartActions_Id:
$request.path.activityTemplates_Activity_smartActions_Id
This method lets you execute a REST based action. - ActivityId: