Jump to

• Request
• Response
• Examples

Add to recent items

post

/crmRestApi/resources/11.13.18.05/recentItems/action/addToRecentItems

The method lets you add one or more recent items.

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

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

Root Schema : schema

Type: object

Show Source

• recentItems: array recentItems
  Each recentItem parameter???s array item includes object Id of the object, entity name or rest source name of the object, and the flow or operation that triggers a recent item entry. The possible values for flow are READ, UPDATE,CREATE, ASSOCIATE, and FAVORITE.

{
    "type":"object",
    "properties":{
        "recentItems":{
            "type":"array",
            "description":"Each recentItem parameter???s array item includes object Id of the object, entity name or rest source name of the object, and the flow or operation that triggers a recent item entry. The possible values for flow are READ, UPDATE,CREATE, ASSOCIATE, and FAVORITE.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : recentItems

Type: array

Each recentItem parameter???s array item includes object Id of the object, entity name or rest source name of the object, and the flow or operation that triggers a recent item entry. The possible values for flow are READ, UPDATE,CREATE, ASSOCIATE, and FAVORITE.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Each recentItem parameter???s array item includes object Id of the object, entity name or rest source name of the object, and the flow or operation that triggers a recent item entry. The possible values for flow are READ, UPDATE,CREATE, ASSOCIATE, and FAVORITE.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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 result as either Success or Failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns result as either Success or Failure."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to add to a recent item by submitting a PATCH request on the REST resource.

cURL Command

curl -u <username:password> \
 -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/recentItems/action/addToRecentItems  \
 -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.

{
  "recentItems": [
    {
      "ObjectId": 300000001495004,
      "EntityName": "accounts",
      "Flow": "READ"
    }
  ]
}

Example of Response Body

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

{
    "result": "Success"
}

Back to Top