Jump to

• Request
• Response
• Examples

Copy a List of Favorites to a Folder

post

/rest/v19/favorites/actions/copyTo

This endpoint copies a list of favorites to a folder.

Request

Supported Media Types

• application/json

Body ()

Root Schema : favorites-copyToCollectionRequest

Type: object

Show Source

• labels: array Favorite Labels
  Title: Favorite Labels

  List of favorite labels
• selections: array Selected Favorite Ids
  Title: Selected Favorite Ids

  List of selected favorite ids
• targetFolderId: integer
  Title: Target Folder ID

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

{
    "type":"object",
    "properties":{
        "selections":{
            "$ref":"#/definitions/selectedFavoriteIds"
        },
        "targetFolderId":{
            "type":"integer",
            "description":"The target Folder to which the favorites will be copied to.",
            "title":"Target Folder ID"
        },
        "labels":{
            "$ref":"#/definitions/favoriteLabels"
        }
    }
}

Nested Schema : Favorite Labels

Type: array

Title: Favorite Labels

List of favorite labels

Show Source

• Array of: string

{
    "title":"Favorite Labels",
    "type":"array",
    "description":"List of favorite labels",
    "items":{
        "type":"string"
    }
}

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-copyToCollectionResponse

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 list of favorites to a folder by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/favorites/actions/copyTo

Request Body Sample

{
  "selections": [123, 124],
  "targetFolderId": 991,
  "labels": ["copy of 123", "copy of 124"]
}

Response Body Sample

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

Back to Top