Jump to

• Request
• Response
• Examples

Invoke Favorite

post

/rest/v16/favorites/actions/start

This endpoint invokes a process actions upon user request.

Request

Supported Media Types

• application/json

Body ()

Root Schema : favorites-startCollectionRequest

Type: object

Show Source

• selections: array Selected Favorite Ids
  Title: Selected Favorite Ids

  List of selected favorite ids
• variableName: string
  Title: Variable Name

  Variable name used to of action.

{
    "type":"object",
    "properties":{
        "selections":{
            "$ref":"#/definitions/selectedFavoriteIds"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name used to of action.",
            "title":"Variable Name"
        }
    }
}

Nested Schema : Selected Favorite Ids

Type: array

Title: Selected Favorite Ids

List of selected favorite ids

Show Source

• Array of: integer

{
    "title":"Selected Favorite Ids",
    "type":"array",
    "description":"List of selected favorite ids",
    "items":{
        "type":"integer"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : favorites-startCollectionResponse

Type: object

Show Source

• destinationUrl: string
  Title: Destination URL

  Destination url to where ui shall navigate to on return.

{
    "type":"object",
    "properties":{
        "destinationUrl":{
            "type":"string",
            "description":"Destination url to where ui shall navigate to on return.",
            "title":"Destination URL"
        }
    }
}

Back to Top

Examples

The following example shows how to invoke a process action upon user request by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/favorites/actions/start

Request Body Sample

{
  "variableName": "_cm_4359285",
  "selections": ["123", "456", "789"]
}

Response Body Sample

{
  "destinationUrl": "" https: //sitename.oracle.com/commerce/buyside/commerce_list_detail.jsp?id=3022619257&contentType=7&autosubmit=true"
}

Back to Top