Refresh an action plan
post
/crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlan
Refreshes an action plan that has already been initiated.
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.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
actionPlanId: number
The unique identifier of the action plan.
-
refreshProcess: boolean
Indicates whether an errored process action is re-initiated or not.
-
softRefresh: boolean
Indicates whether an auto-refresh is performed.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): string
Returns a response body that contains the action plan id if the refresh is successful, or returns an error message.
Examples
The following example shows how to refresh an action plan by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlan
Example of Request Body
The following shows an example of the request body in JSON format.
{ "actionPlanId":300100148450214, "softRefresh":false }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "result": "300100148450214" }