Get all user actions
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/smartActions
Request
Path Parameters
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
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 -
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:- ContextFilter: Finds the context filter of smart actions with parent resource, alias or exclusive context.
Finder Variables:- Alias; string; The alias of the smart action.
- ContextExclusive; string; The exclusive context of the smart action.
- ParentResource; string; The parent resource of the smart action.
- PrimaryKey: Finds the user action details with the specified primary key.
Finder Variables:- UserActionId; integer; The unique user action identifier of the subscription smart actions.
- ContextFilter: Finds the context filter of smart actions with parent resource, alias or exclusive context.
-
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:- ConfirmationMessage; string; A message seeking confirmation for the action being performed.
- ContentType; string; The content type used when invoking the REST endpoint.
- DisplayLabel; string; The display label of the subscription smart actions.
- Entity; string; The entity of the subscription smart actions.
- Href; string; The HREF of the subscription smart actions
- IncludedInApplication; string; The included in application flag of the subscription smart actions.
- MassActionFlag; boolean; The mass action flag of the smart action.
- Method; string; The method associated with the subscription smart actions.
- ObjectFunctionName; string; The object function name of the smart action.
- PageType; string; The page type of the smart action.
- SmartSuggestFlag; boolean; The smart suggest flag of the smart action.
- SystemActionFlag; boolean; The flag indicating if the action is seeded or custom.
- UpdateOfAttributes; string; The update of attributes flag of the subscription smart actions.
- UserActionId; integer; The unique identifier of the subscription user actions.
- UserActionName; string; The name of the subscription user actions.
- UserActionRank; integer; The user rank action of the smart action.
-
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: string
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: string
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 : subscriptions-smartActions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
The JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message seeking confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type used when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display label of the subscription smart actions. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The entity of the subscription smart actions. -
Href: string
Title:
REST Endpoint
Maximum Length:1024
The HREF of the subscription smart actions -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The included in application flag of the subscription smart actions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
The mass action flag of the smart action. -
Method: string
Title:
HTTP Method
Maximum Length:15
The method associated with the subscription smart actions. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function name of the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The page type of the smart action. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
The smart suggest flag of the smart action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
The flag indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The update of attributes flag of the subscription smart actions. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique identifier of the subscription user actions. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The name of the subscription user actions. - UserActionNavigation: array User Action Navigation
-
UserActionRank: integer
(int64)
Title:
Priority
The user rank action of the smart action. -
UserActionRequestPayload: array
User Action Request Payload
Title:
User Action Request Payload
The user action request payload resource stores the payload information for every user action request. -
UserActionURLBinding: array
User Action URL Binding
Title:
User Action URL Binding
The user action URL binding resource stores the binding metadata for a variable in the URL.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : User Action Request Payload
Type:
array
Title:
User Action Request Payload
The user action request payload resource stores the payload information for every user action request.
Show Source
Nested Schema : User Action URL Binding
Type:
array
Title:
User Action URL Binding
The user action URL binding resource stores the 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 : subscriptions-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The binding of the user action payload. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
The mandatory flag of the user action payload. -
RequestPayloadId: integer
(int64)
The request payload ID of the user action.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The request payload name of the user action. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The smart suggest path of the user action payload. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system action flag of the user action request payload. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value of the user action payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
The value structure of the user action payload.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The URL binding of user action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system action flag of the user action URL binding. -
URLBindingId: integer
(int64)
The identifier of URL binding of user action.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:256
The name of URL binding of user action. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:1000
The value of URL binding of user action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- executeActionForRows
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you to execute user smart actions for rows. - SubscriptionNumber:
- generateSmartActions
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you generate user smart actions. - SubscriptionNumber:
- getActionEvaluationAttributesForResource
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you get action evaluation attributes of smart action resource. - SubscriptionNumber:
- getActionsForRows
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you get user smart actions for rows. - SubscriptionNumber:
- getAttributesForResource
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you get attributes of smart action resource. - SubscriptionNumber:
- getEntities
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you get all entities of user smart action. - SubscriptionNumber:
- getObjectFunctions
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you get object functions of smart action. - SubscriptionNumber:
- processMassAction
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
This method lets you process mass action. - SubscriptionNumber: