Update a web activity rule
patch
/crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}
Request
Path Parameters
-
WebActivityRuleNumber(required): string
The public unique identifier of the web activity rule.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ActiveFlag: boolean
Title:
StatusMaximum Length:1Indicates whether the web activity rule is active or not. -
Description: string
Title:
DescriptionMaximum Length:1000The description of the web activity rule. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version NumberThe object version number of the web activity rule. -
WebActivityRuleCondition: array
Web Activity Rule Conditions
Title:
Web Activity Rule ConditionsThe web activity rule conditions resource is used to view, create, update, and delete the web activity rule conditions. -
WebActivityRuleName: string
Title:
NameMaximum Length:30The name of the web activity rule.
Nested Schema : Web Activity Rule Conditions
Type:
arrayTitle:
Web Activity Rule ConditionsThe web activity rule conditions resource is used to view, create, update, and delete the web activity rule conditions.
Show Source
Nested Schema : schema
Type:
Show Source
object-
ObjectVersionNumber: integer
(int32)
Title:
Object Version NumberThe object version number of the web activity rule condition. -
RuleConditionExpression: string
(byte)
Title:
Condition ExpressionThe expression of the rule condition group of the web activity rule condition. -
RuleConditionGroupName: string
Title:
Condition Group NameMaximum Length:30The rule condition group of the web activity rule condition. -
RuleConditionGroupType: string
Title:
Condition Group TypeMaximum Length:30The type of the rule condition group of the web activity rule condition. -
SourceObject: string
Title:
Source ObjectMaximum Length:30The 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 IDThe unique identifier of the web activity rule of the web activity rule condition.
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 : webActivityRules-item-response
Type:
Show Source
object-
ActiveFlag: boolean
Title:
StatusMaximum Length:1Indicates whether the web activity rule is active or not. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The resource user who created the web activity rule. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the web activity rule is created. -
Description: string
Title:
DescriptionMaximum Length:1000The description of the web activity rule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the web activity rule was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The resource user who last updated the web activity rule. -
LastUpdateLogin: string
Title:
Last Updated LoginRead Only:trueMaximum Length:32The login associated with the user who last updated the web activity rule. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version NumberThe object version number of the web activity rule. -
StatusLookupCode: string
Title:
StatusRead Only:trueMaximum Length:30The lookup code of the status of the web activity rule. -
StatusMeaning: string
Title:
StatusRead Only:trueMaximum Length:80The status meaning of the web activity rule. -
WebActivityRuleCondition: array
Web Activity Rule Conditions
Title:
Web Activity Rule ConditionsThe 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 IDThe unique identifier of the web activity rule. -
WebActivityRuleName: string
Title:
NameMaximum Length:30The name of the web activity rule. -
WebActivityRuleNumber: string
Title:
Web Activity Rule NumberMaximum Length:30The public unique identifier of the web activity rule. -
WebActivityType: string
Title:
Web Activity TypeMaximum Length:100The web activity type of the web activity rule. -
WebActivityTypeLookupCode: string
Title:
Web Activity TypeRead Only:trueMaximum Length:30The lookup code of the web activity type of the web activity rule. -
WebActivityTypeMeaning: string
Title:
Web Activity TypeRead Only:trueMaximum Length:80The web activity type meaning of the web activity rule.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Web Activity Rule Conditions
Type:
arrayTitle:
Web Activity Rule ConditionsThe 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 referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 ByRead Only:trueMaximum Length:64The resource user who created the web activity rule condition. -
CreationDate: string
(date-time)
Title:
Created DateRead Only:trueThe date and time when the web activity rule condition is created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the web activity rule condition is last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The resource user who last updated the web activity rule condition. -
LastUpdateLogin: string
Title:
Last Updated LoginRead Only:trueMaximum Length:32The login associated with the user who last updated the web activity rule condition. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version NumberThe object version number of the web activity rule condition. -
RuleConditionExpression: string
(byte)
Title:
Condition ExpressionThe expression of the rule condition group of the web activity rule condition. -
RuleConditionGroupName: string
Title:
Condition Group NameMaximum Length:30The rule condition group of the web activity rule condition. -
RuleConditionGroupType: string
Title:
Condition Group TypeMaximum Length:30The type of the rule condition group of the web activity rule condition. -
SourceObject: string
Title:
Source ObjectMaximum Length:30The 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 IDThe unique identifier of the web activity rule of the web activity rule condition. -
WebActyRuleCondId: integer
(int64)
Title:
Web Activity Rule Condition IDThe unique identifier of the web activity rule condition. -
WebActyRuleCondNumber: string
Title:
Web Activity Rule Condition NumberMaximum Length:30The public unique identifier of the web activity rule condition.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- StatusLookupVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_WEB_ACT_RULE_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: StatusLookupCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- WebActivityRuleCondition
-
Parameters:
- WebActivityRuleNumber:
$request.path.WebActivityRuleNumber
The web activity rule conditions resource is used to view, create, update, and delete the web activity rule conditions. - WebActivityRuleNumber:
- WebActivityTypeLookupVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_WEB_ACT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: WebActivityTypeLookupCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to update a web activity rule by submitting a PATCH request on the REST resource using cURL.
curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"Description" : "Active Email Send Web Activity Rule ",
"ActiveFlag" : "Y"
}
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"WebActivityRuleId": 300100553880757,
"WebActivityRuleNumber": "300100553880757",
"WebActivityRuleName": "Email Send Rule",
"WebActivityType": "EmailSend",
"Description": "Active Email Send Web Activity Rule ",
"ActiveFlag": true,
"CreationDate": "2022-04-27T08:12:59+00:00",
"CreatedBy": "SALES_ADMIN",
"LastUpdateDate": "2022-04-27T08:13:24+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateLogin": "DD64F68F5E0D0F27E053D711F10AB350",
"ObjectVersionNumber": 2,
"WebActivityTypeMeaning": "Email Send",
"WebActivityTypeLookupCode": "ORA_EMAIL_SEND",
"StatusMeaning": "Inactive",
"StatusLookupCode": "ORA_INACTIVE",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757",
"name": "webActivityRules",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757",
"name": "webActivityRules",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757/child/WebActivityRuleCondition",
"name": "WebActivityRuleCondition",
"kind": "collection"
}
]
}