Update an action attribute
patch
/crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionAttribute/{ActionAttributeId}
Request
Path Parameters
-
ActionAttributeId(required): integer(int64)
The unique identifier of the action attribute.
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AttributeValue: string
Title:
Attribute Value
Maximum Length:1000
The value to be set for the action attribute. -
AttributeValueContextCd: string
Title:
Context
Maximum Length:30
Default Value:ORA_SVC_USER_DEFINED
The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup ORA_SVC_AP_CONTEXT_CD. -
AttributeValueContextCdMeaning: string
Title:
Context Value
Maximum Length:255
The display value corresponding to the context lookup code for the action attribute. -
ChildAttributeFlag: boolean
Title:
Child Attribute Indicator
Maximum Length:1
Default Value:false
Indicates whether this attribute belongs to the parent or one of its child objects. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the attribute action is deleted. The default value is false. -
UsageCd: string
Title:
Usage
Maximum Length:30
Default Value:ORA_SVC_CREATE
The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD. -
UsageCdMeaning: string
Title:
Usage Value
Maximum Length:255
The display value corresponding to the usage lookup code for the action attribute.
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-actionAttribute-item-response
Type:
Show Source
object
-
ActionAttributeId: integer
(int64)
Title:
Action Attribute ID
Read Only:true
The unique identifier of the action attribute. -
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. -
AttributeName: string
Title:
Attribute Name
Maximum Length:2000
The name of the action attribute. -
AttributeValue: string
Title:
Attribute Value
Maximum Length:1000
The value to be set for the action attribute. -
AttributeValueContextCd: string
Title:
Context
Maximum Length:30
Default Value:ORA_SVC_USER_DEFINED
The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup ORA_SVC_AP_CONTEXT_CD. -
AttributeValueContextCdMeaning: string
Title:
Context Value
Maximum Length:255
The display value corresponding to the context lookup code for the action attribute. -
ChildAttributeFlag: boolean
Title:
Child Attribute Indicator
Maximum Length:1
Default Value:false
Indicates whether this attribute belongs to the parent or one of its child objects. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the action attribute was created. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the attribute action is deleted. The default value is false. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the action attribute can be deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the action attribute was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the action attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the action attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the action attribute can be updated. -
UsageCd: string
Title:
Usage
Maximum Length:30
Default Value:ORA_SVC_CREATE
The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD. -
UsageCdMeaning: string
Title:
Usage Value
Maximum Length:255
The display value corresponding to the usage lookup code for the action attribute.
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
- UsageCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AP_ATTRIBUTE_USAGE_CD
The list of values indicating when to use an action attribute.
The following properties are defined on the LOV link relation:- Source Attribute: UsageCd; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating if this attribute belongs to the parent or one of its chid objects.
The following properties are defined on the LOV link relation:- Source Attribute: ChildAttributeFlag; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
Examples
The following example shows how to update an action attribute by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actions/ACT0000044367/child/actionAttribute/300100118913154
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "AttributeName":"AcP_Rest44" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ActionAttributeId": 300100118913154, "ActionId": 300100118621756, "AttributeName": "AcP_Rest44", "AttributeValue": null, "AttributeValueContextCd": "ORA_SVC_CUSTOM", "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-09-27T12:58:24+00:00", "DeletedFlag": false, "LastUpdateDate": "2017-09-27T13:03:03+00:00", "LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F", "LastUpdatedBy": "SALES_ADMIN", "UsageCd": "ORA_SVC_CREATE", "UpdateFlag": true, "DeleteFlag": true, "links": [ ... ] }