Jump to

• Request
• Response
• Examples

Copy a Favorite

post

/rest/v16/favorites/{id}/actions/copyTo

This endpoint copies a favorite.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  The identifier for the favorite.

Body ()

Root Schema : favorites-copyToRequest

Type: object

Show Source

• label: string
  Title: The label for the copy of current favorite

  The new label for the copy of current favorite
• targetFolderId: integer
  Title: Target Folder ID

  The target Folder to which the favorites will be copied to.

{
    "type":"object",
    "properties":{
        "targetFolderId":{
            "type":"integer",
            "description":"The target Folder to which the favorites will be copied to.",
            "title":"Target Folder ID"
        },
        "label":{
            "type":"string",
            "description":"The new label for the copy of current favorite",
            "title":"The label for the copy of current favorite"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : favorites-copyToResponse

Type: object

Show Source

• ids: array Created Favorite Ids
  Title: Created Favorite Ids

  List of created favorite root ids

{
    "type":"object",
    "properties":{
        "ids":{
            "$ref":"#/definitions/createdFavoriteIds"
        }
    }
}

Nested Schema : Created Favorite Ids

Type: array

Title: Created Favorite Ids

List of created favorite root ids

Show Source

• Array of: integer

{
    "title":"Created Favorite Ids",
    "type":"array",
    "description":"List of created favorite root ids",
    "items":{
        "type":"integer"
    }
}

Back to Top

Examples

The following example shows how to copy a favorite 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/123/actions/copyTo

Request Body Sample

{
  "targetFolderId": 123,
  "label": "copy of fav"
}

Response Body Sample

{
  "result": {
    "ids": [3023768871]
  }
}

Back to Top