Jump to

• Request
• Response
• Examples

Add an action to a parent business object

post

/crmRestApi/resources/11.13.18.05/actionplans/action/addActionToObject

Adds action to an object and creates action plan. The action and parent business object are specified in the input by action number, object type and object number.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• actionNumber: string
  The alternate unique identifier of an action to be included in an action plan.
• customAttributeValues: object customAttributeValues
  Additional Properties Allowed: additionalProperties

  Custom attribute mapping to be used while initiating the action plan.
• objectEntityName: string
  The type of the parent business object for this action plan.
• objectNumber: string
  The alternate unique identifier of the parent business object for this action plan.

{
    "type":"object",
    "properties":{
        "customAttributeValues":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Custom attribute mapping to be used while initiating the action plan.",
            "nullable":true
        },
        "actionNumber":{
            "type":"string",
            "description":"The alternate unique identifier of an action to be included in an action plan.",
            "nullable":true
        },
        "objectNumber":{
            "type":"string",
            "description":"The alternate unique identifier of the parent business object for this action plan.",
            "nullable":true
        },
        "objectEntityName":{
            "type":"string",
            "description":"The type of the parent business object for this action plan.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : customAttributeValues

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Custom attribute mapping to be used while initiating the action plan.",
    "nullable":true
}

Custom attribute mapping to be used while initiating the action plan.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Returns a response body that contains the action plan id if the call is successful, or returns an error message.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns a response body that contains the action plan id if the call is successful, or returns an error message."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to add an action to a parent business object 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/addActionToObject -D @request.json

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "actionNumber": "ACT0000000001",
	"customAttributeValues":
		{
			"type":"object",
			"additionalProperties":{
				"type":"string"
				},
			"description":"Custom attribute mapping to be used while initiating the action plan.",
			"nullable":true
			},
	"objectEntityName": "ServiceRequest",
	"objectNumber": "SR0000018004",
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "result": "300100642250893"
}

Back to Top