Update an action plan action
patch
/crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}
Request
Path Parameters
-
ActionPlanActionId(required): integer(int64)
The unique identifier of the action in an action plan.
-
ActionPlanId(required): integer(int64)
The unique identifier of the action plan.
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
-
ActionId: integer
(int64)
Title:
Action ID
The unique identifier of the action. -
ActionNumber: string
Title:
Action Number
The reference number of the action in an action plan. -
actionPlanActionRelation: array
Action Plan Action Relations
Title:
Action Plan Action Relations
The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out. -
ActionPlanId: integer
(int64)
Title:
Action Plan ID
The unique identifier of the action plan. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the action in an action plan is deleted. The default value is false. -
EndDate: string
(date-time)
Title:
End Date
The date when an action in the action plan ends. -
ExpectedCompletionDate: string
(date-time)
Title:
Expected Completion Date
The date when the action in an action plan is to be completed. -
ExpectedStartDate: string
(date-time)
Title:
Expected Start Date
The date when an action in the action plan is expected to start. -
LeadTime: integer
(int64)
Title:
Duration
The estimated time required to complete the action. -
LeadTimeUnit: string
Title:
Duration Unit
Maximum Length:30
The unit of measurement of the lead time, such as minutes, hours, or days. -
LeadTimeUnitMeaning: string
Title:
Lead Time Unit Value
Maximum Length:255
The display value corresponding to the lead time unit lookup code for the action plan action. -
ObjectEntityNameMeaning: string
Title:
Object Entity Name Value
Maximum Length:255
The display value corresponding to the object entity name lookup code for the action plan action. -
ObjectEntityTypeMeaning: string
Title:
Object Entity Type Value
Maximum Length:255
The display value corresponding to the object entity type lookup code for the action plan action. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object associated with the action. -
ObjectReferenceNumber: string
Title:
Object Reference Number
Maximum Length:100
The reference number of the object associated with the action. -
OrderNumber: integer
(int64)
Title:
Step
The order of the action in an action plan. -
ProcessInstanceId: string
Title:
Process Instance ID
Maximum Length:500
Indicates the process instance identifier of an external process. -
ProcessStatus: string
Title:
Process Status
Maximum Length:100
The status of the external process. -
SkipFlag: boolean
Title:
Skip
Maximum Length:1
Default Value:false
Indicates whether the action for the action plan can be skipped. -
StartDate: string
(date-time)
Title:
Start Date
The date when an action in the action plan begins. -
StatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD. -
StatusCdMeaning: string
Title:
Status Value
Maximum Length:255
The display value corresponding to the status lookup code for the action plan action. -
StatusDetails: string
Title:
Status Details
Maximum Length:1000
The details of the status of an action in an action plan. -
VisibilityCdMeaning: string
Title:
Visibility Value
Maximum Length:255
The display value corresponding to the visibility lookup code for the action plan action.
Nested Schema : Action Plan Action Relations
Type:
array
Title:
Action Plan Action Relations
The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ActionPlanActionId: integer
(int64)
Title:
Action Plan Action ID
The unique identifier of the action in an action plan. -
ActionStatusCd: string
Title:
Action Status
Maximum Length:30
Default Value:ORA_SVC_COMPLETED
The code indicating the status of the dependency condition of the action relation. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the action dependency is deleted. The default value is false. -
DepActionPlanActionId: integer
(int64)
Title:
Dependent Action Plan Action ID
The unique identifier of the dependent action in an action plan.
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 : actionplans-actionPlanAction-item-response
Type:
Show Source
object
-
ActionDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of an action in an action plan. -
ActionId: integer
(int64)
Title:
Action ID
The unique identifier of the action. -
ActionName: string
Title:
Action
Read Only:true
Maximum Length:400
The name of the action. -
ActionNumber: string
Title:
Action Number
The reference number of the action in an action plan. -
ActionPlanActionId: integer
(int64)
Title:
Action Plan Action ID
Read Only:true
The unique identifier of the action in an action plan. -
ActionPlanActionNumber: string
Title:
Action Plan Action Number
Maximum Length:30
The alternate unique identifier of an action plan action. -
actionPlanActionRelation: array
Action Plan Action Relations
Title:
Action Plan Action Relations
The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out. -
ActionPlanId: integer
(int64)
Title:
Action Plan ID
The unique identifier of the action plan. -
ActionPlanNumber: string
Title:
Action Plan Number
Maximum Length:30
The action plan reference number. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action in an action plan. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the action was created in an action plan. -
DelayedFlag: boolean
Read Only:
true
Indicates whether the action in an action plan is delayed. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the action in an action plan is deleted. The default value is false. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the action in an action plan can be deleted. -
EndDate: string
(date-time)
Title:
End Date
The date when an action in the action plan ends. -
EndDateReadOnlyFlag: boolean
Read Only:
true
Indicates whether the end date should be read only. -
ExpectedCompletionDate: string
(date-time)
Title:
Expected Completion Date
The date when the action in an action plan is to be completed. -
ExpectedStartDate: string
(date-time)
Title:
Expected Start Date
The date when an action in the action plan is expected to start. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the action was last updated in an action plan. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the action in an action plan. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the action in an action plan. -
LeadTime: integer
(int64)
Title:
Duration
The estimated time required to complete the action. -
LeadTimeUnit: string
Title:
Duration Unit
Maximum Length:30
The unit of measurement of the lead time, such as minutes, hours, or days. -
LeadTimeUnitMeaning: string
Title:
Lead Time Unit Value
Maximum Length:255
The display value corresponding to the lead time unit lookup code for the action plan action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Default Value:true
Indicates whether the action in an action plan is mandatory. The default value is false. -
ObjectEntityName: string
Title:
Entity Name
Read Only:true
Maximum Length:400
The name of the parent entity object on which the action is based. -
ObjectEntityNameMeaning: string
Title:
Object Entity Name Value
Maximum Length:255
The display value corresponding to the object entity name lookup code for the action plan action. -
ObjectEntitySubtype: string
Title:
Object Entity Subtype
Read Only:true
Maximum Length:400
Indicates the object entity subtype of the action in the action plan. -
ObjectEntityType: string
Title:
Type
Read Only:true
Maximum Length:400
The type of the parent entity object on which the action is based. -
ObjectEntityTypeMeaning: string
Title:
Object Entity Type Value
Maximum Length:255
The display value corresponding to the object entity type lookup code for the action plan action. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object associated with the action. -
ObjectReferenceNumber: string
Title:
Object Reference Number
Maximum Length:100
The reference number of the object associated with the action. -
OrderNumber: integer
(int64)
Title:
Step
The order of the action in an action plan. -
OwnerName: string
Title:
Owner
Read Only:true
The name of the owner of the action. -
Prerequisites: string
Title:
Prerequisites
Read Only:true
The prerequisite steps required to initiate the action. -
ProcessInstanceId: string
Title:
Process Instance ID
Maximum Length:500
Indicates the process instance identifier of an external process. -
ProcessStatus: string
Title:
Process Status
Maximum Length:100
The status of the external process. -
SkipFlag: boolean
Title:
Skip
Maximum Length:1
Default Value:false
Indicates whether the action for the action plan can be skipped. -
StartDate: string
(date-time)
Title:
Start Date
The date when an action in the action plan begins. -
StatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD. -
StatusCdMeaning: string
Title:
Status Value
Maximum Length:255
The display value corresponding to the status lookup code for the action plan action. -
StatusDetails: string
Title:
Status Details
Maximum Length:1000
The details of the status of an action in an action plan. -
TemplateId: integer
(int64)
Title:
Template ID
The unique identifier of the action plan template from which the action is created. -
TemplateNumber: string
Title:
Template Number
Maximum Length:30
The reference number of the action plan template. -
TemplateTemplateId: integer
(int64)
Title:
Template ID
Read Only:true
The unique identifier of a template. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the action in an action plan can be updated. -
VisibilityCd: string
Title:
Visibility
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_NOT_PUBLISHED
The code indicating the visibility level of the action. A list of valid values is defined in the lookup ORA_SVC_AP_VISIBILITY_CD. -
VisibilityCdMeaning: string
Title:
Visibility Value
Maximum Length:255
The display value corresponding to the visibility lookup code for the action plan action.
Nested Schema : Action Plan Action Relations
Type:
array
Title:
Action Plan Action Relations
The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : actionplans-actionPlanAction-actionPlanActionRelation-item-response
Type:
Show Source
object
-
ActionPlanActionId: integer
(int64)
Title:
Action Plan Action ID
The unique identifier of the action in an action plan. -
ActionPlanActionNumber: string
Title:
Action Plan Action Number
Maximum Length:30
The action plan reference number. -
ActionStatusCd: string
Title:
Action Status
Maximum Length:30
Default Value:ORA_SVC_COMPLETED
The code indicating the status of the dependency condition of the action relation. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the dependencies of an action. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the action dependency was created. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the action dependency is deleted. The default value is false. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the action dependency can be deleted. -
DepActionPlanActionId: integer
(int64)
Title:
Dependent Action Plan Action ID
The unique identifier of the dependent action in an action plan. -
DepActionPlanActionNumber: string
Title:
Dependent Action Plan Action Number
Maximum Length:30
The dependent action plan reference number. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the action dependency was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the dependencies of action. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the dependencies of action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelationId: integer
(int64)
Title:
Relation ID
Read Only:true
The unique identifier of the relation between actions in an action plan. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the action dependency 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
- ActionVisibilityCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AP_VISIBILITY_CD
The list of values indicating the visibility of the action in an action plan.
The following properties are defined on the LOV link relation:- Source Attribute: VisibilityCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LeadTimeUnitLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AP_LEAD_TIME_UNIT
The list of values indicating the unit of measurement for the time required to complete an action.
The following properties are defined on the LOV link relation:- Source Attribute: LeadTimeUnit; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AP_STATUS_CD
The list of values indicating the status of the action in an action plan.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating whether an action in an action plan is skipped.
The following properties are defined on the LOV link relation:- Source Attribute: SkipFlag; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- actionPlanActionRelation
-
Parameters:
- ActionPlanActionId:
$request.path.ActionPlanActionId
- ActionPlanId:
$request.path.ActionPlanId
The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out. - ActionPlanActionId:
Examples
The following example shows how to update an action in an action plan 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/actionplans/300100117534967/child/actionPlanAction/300100118919336
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "StatusDetails": "Not started" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ActionId": 300100117527290, "ActionPlanActionId": 300100118919336, "ActionPlanId": 300100117534967, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-09-27T14:15:59+00:00", "DelayedFlag": false, "DeletedFlag": false, "EndDate": null, "ExpectedCompletionDate": null, "ExpectedStartDate": null, "LastUpdateDate": "2017-09-27T14:29:53+00:00", "LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F", "LastUpdatedBy": "SALES_ADMIN", "LeadTime": null, "LeadTimeUnit": null, "MandatoryFlag": true, "ObjectId": null, "ObjectReferenceNumber": null, "OrderNumber": 1, "StartDate": null, "StatusCd": "ORA_SVC_NOT_STARTED", "StatusDetails": "Not started", "TemplateId": null, "OwnerName": null, "Prerequisites": null, "ObjectEntityName": "Activity", "ObjectEntityType": "Appointment", "VisibilityCd": "ORA_SVC_CUSTOMER_VISIBLE", "ActionName": "action149_1", "UpdateFlag": true, "DeleteFlag": true, "ActionNumber": "ACT0000043279", "ActionDescription": null, "EndDateReadOnlyFlag": false, "DclActionPlan_Id_c": null, "DclActionPlan_c": null, "links": [ ... ] }