Get all web activity rules
get
/crmRestApi/resources/11.13.18.05/webActivityRules
Request
Query Parameters
-
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:- PrimaryKey: Finds a web activity rule with the specified web activity rule ID.
Finder Variables:- WebActivityRuleId; integer; The unique identifier of the web activity rule.
- WebActivityRuleNumberRowFinder: Finds a web activity rule with the specified web activity rule number.
Finder Variables:- WebActivityRuleNumber; string; The web activity rule number.
- PrimaryKey: Finds a web activity rule with the specified web activity rule ID.
-
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:- ActiveFlag; boolean; Indicates whether the web activity rule is active or not.
- CreatedBy; string; The resource user who created the web activity rule.
- CreationDate; string; The date and time when the web activity rule is created.
- Description; string; The description of the web activity rule.
- LastUpdateDate; string; The date and time when the web activity rule was last updated.
- LastUpdateLogin; string; The login associated with the user who last updated the web activity rule.
- LastUpdatedBy; string; The resource user who last updated the web activity rule.
- ObjectVersionNumber; integer; The object version number of the web activity rule.
- StatusMeaning; string; The status meaning of the web activity rule.
- WebActivityRuleId; integer; The unique identifier of the web activity rule.
- WebActivityRuleName; string; The name of the web activity rule.
- WebActivityRuleNumber; string; The public unique identifier of the web activity rule.
- WebActivityType; string; The web activity type of the web activity rule.
- WebActivityTypeMeaning; string; The web activity type meaning of the web activity rule.
-
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:
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 : webActivityRules
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 : webActivityRules-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Status
Maximum Length:1
Indicates whether the web activity rule is active or not. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The resource user who created the web activity rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the web activity rule is created. -
Description: string
Title:
Description
Maximum Length:1000
The description of the web activity rule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the web activity rule was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The resource user who last updated the web activity rule. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login associated with the user who last updated the web activity rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number of the web activity rule. -
StatusLookupCode: string
Title:
Status
Read Only:true
Maximum Length:30
The lookup code of the status of the web activity rule. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The status meaning of the web activity rule. -
WebActivityRuleCondition: array
Web Activity Rule Conditions
Title:
Web Activity Rule Conditions
The web activity rule conditions resource is used to view, create, update, and delete the web activity rule conditions. -
WebActivityRuleId: integer
(int64)
Title:
Web Activity Rule ID
The unique identifier of the web activity rule. -
WebActivityRuleName: string
Title:
Name
Maximum Length:30
The name of the web activity rule. -
WebActivityRuleNumber: string
Title:
Web Activity Rule Number
Maximum Length:30
The public unique identifier of the web activity rule. -
WebActivityType: string
Title:
Web Activity Type
Maximum Length:100
The web activity type of the web activity rule. -
WebActivityTypeLookupCode: string
Title:
Web Activity Type
Read Only:true
Maximum Length:30
The lookup code of the web activity type of the web activity rule. -
WebActivityTypeMeaning: string
Title:
Web Activity Type
Read Only:true
Maximum Length:80
The web activity type meaning of the web activity rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Web Activity Rule Conditions
Type:
array
Title:
Web Activity Rule Conditions
The web activity rule conditions resource is used to view, create, update, and delete the web activity rule conditions.
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 : webActivityRules-WebActivityRuleCondition-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The resource user who created the web activity rule condition. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date and time when the web activity rule condition is created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the web activity rule condition is last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The resource user who last updated the web activity rule condition. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login associated with the user who last updated the web activity rule condition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number of the web activity rule condition. -
RuleConditionExpression: string
(byte)
Title:
Condition Expression
The expression of the rule condition group of the web activity rule condition. -
RuleConditionGroupName: string
Title:
Condition Group Name
Maximum Length:30
The rule condition group of the web activity rule condition. -
RuleConditionGroupType: string
Title:
Condition Group Type
Maximum Length:30
The type of the rule condition group of the web activity rule condition. -
SourceObject: string
Title:
Source Object
Maximum Length:30
The source object of the web activity rule condition. The condition is defined using the attributes of the source object. -
WebActivityRuleId: integer
(int64)
Title:
Web Activity Rule ID
The unique identifier of the web activity rule of the web activity rule condition. -
WebActyRuleCondId: integer
(int64)
Title:
Web Activity Rule Condition ID
The unique identifier of the web activity rule condition. -
WebActyRuleCondNumber: string
Title:
Web Activity Rule Condition Number
Maximum Length:30
The public unique identifier of the web activity rule condition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source