Set favorite
post
/crmRestApi/resources/11.13.18.05/userFavorites/action/setFavorite
Sets favorite or not for the input object identifier and object type based on input favorite value.
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
-
favoriteValue: boolean
Indicates whether the value is favorite or not.
-
objectId: number
A key that uniquely identifies the object that is set in favorite_object column.
-
objectType: string
The rest resource name of the object.
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 status of the operation as either success or failure.
Examples
The following example shows how to set an user as favorite by submitting a POST request on the REST resource.
cURL Command
The following shows an example of the request header.
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userFavorite/action/setFavorite \ -H 'Content-Type: application/vnd.oracle.adf.action+json' | json_pp
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "objectType" : "leads", "objectId": 12321, "favoriteValue": true }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "result": "success" }