Create a web activity rule
post
/crmRestApi/resources/11.13.18.05/webActivityRules
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag(required): boolean
Title:
Status
Maximum Length:1
Indicates whether the web activity rule is active or not. -
Description: string
Title:
Description
Maximum Length:1000
The description of the web activity rule. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number 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(required): 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(required): string
Title:
Web Activity Type
Maximum Length:100
The web activity type of the web activity rule.
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 : schema
Type:
Show Source
object
-
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.
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:
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
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 create a web activity rule by submitting a POST request on the REST resource using cURL.
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "WebActivityRuleName":"Email Send Rule", "WebActivityType":"EmailSend", "Description":"Inactive Email Send Web Activity Rule", "ActiveFlag":"N" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "WebActivityRuleId": 300100592844203, "WebActivityRuleNumber": "300100592844203", "WebActivityRuleName": "Email Send Rule", "WebActivityType": "EmailSend", "Description": "Inactive Email Send Web Activity Rule", "ActiveFlag": false, "CreationDate": "2022-03-23T17:27:01+00:00", "CreatedBy": "SALES_ADMIN", "LastUpdateDate": "2022-03-23T17:27:01.178+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "DAA07C7F63C6D124E053D711F10A9C8B", "ObjectVersionNumber": 1, "WebActivityTypeMeaning": null, "WebActivityTypeLookupCode": null, "StatusMeaning": null, "StatusLookupCode": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100592844203", "name": "webActivityRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100592844203", "name": "webActivityRules", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100592844203/child/WebActivityRuleCondition", "name": "WebActivityRuleCondition", "kind": "collection" } ] }