Create an action condition
post
/crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition
Request
Path Parameters
-
ActionNumber(required): string
The alternate unique identifier of the action.
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
-
ActionId: integer
(int64)
Title:
Action ID
The unique identifier of the action. -
ActionNumber: string
Title:
Action Number
Maximum Length:64
The alternate unique identifier of the action. -
ActionStatusCd: string
Title:
Action Status
Maximum Length:30
The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD. -
ActionStatusCdMeaning: string
Title:
Action Status Value
Maximum Length:255
The display value corresponding to the action status lookup code for the action condition. -
CompletionFlag: boolean
Title:
CompletionFlag
Maximum Length:1
Indicates whether the action was completed by fulfilling the condition. The default value is false. -
Condition: string
Title:
Condition
Maximum Length:1000
The expression indicating whether the condition is met or not. -
Description: string
Title:
Description
Maximum Length:1000
The description of the action condition. -
Name: string
Title:
Name
Maximum Length:400
The name of the action 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 : actions-actionCondition-item-response
Type:
Show Source
object
-
ActionConditionId: integer
(int64)
Title:
Action Condition ID
Read Only:true
The unique identifier of the action condition. -
ActionId: integer
(int64)
Title:
Action ID
The unique identifier of the action. -
ActionNumber: string
Title:
Action Number
Maximum Length:64
The alternate unique identifier of the action. -
ActionStatusCd: string
Title:
Action Status
Maximum Length:30
The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD. -
ActionStatusCdMeaning: string
Title:
Action Status Value
Maximum Length:255
The display value corresponding to the action status lookup code for the action condition. -
CompletionFlag: boolean
Title:
CompletionFlag
Maximum Length:1
Indicates whether the action was completed by fulfilling the condition. The default value is false. -
Condition: string
Title:
Condition
Maximum Length:1000
The expression indicating whether the condition is met or not. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action condition. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the condition was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the action condition can be deleted. -
Description: string
Title:
Description
Maximum Length:1000
The description of the action condition. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the action condition was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the action condition. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the action condition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:400
The name of the action condition. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the action condition can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- ActionStatusCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AP_STATUS_CD
The list of values indicating the status of an action condition.
The following properties are defined on the LOV link relation:- Source Attribute: ActionStatusCd; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating the completion status of an action.
The following properties are defined on the LOV link relation:- Source Attribute: CompletionFlag; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
Examples
The following example shows how to create an action condition by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actions/ACT0000044368/child/actionCondition
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "ActionStatusCd": "ORA_SVC_COMPLETED", "Condition": "(Location LIKE '%KM_Completed%')", "Description": null, "Name":null }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "ActionConditionId": 300100118621887, "ActionId": 300100118621849, "ActionStatusCd": "ORA_SVC_COMPLETED", "Condition": "(Location LIKE '%KM_Completed%')", "CompletionFlag": true, "CreatedBy": "xuidrill2", "CreationDate": "2017-09-25T06:47:18.957+00:00", "Description": null, "LastUpdateDate": "2017-09-25T07:49:50+00:00", "LastUpdateLogin": "59FCEEEABAA256BBE0538E09F20A384F", "LastUpdatedBy": "xuidrill2", "Name": null, "UpdateFlag": true, "DeleteFlag": true, "links": [ ... ] }