Jump to

• Request
• Response
• Examples

Get a Favorite Folder

get

/rest/v16/favoriteFolders/{id}

This endpoint returns a favorite folder available to the user.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Primary key of Favorite Folders

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Favorite Folders

Type: object

Title: Favorite Folders

Show Source

• canAdd: boolean
  Title: Can Add Favorites
• dateAdded: string
  Title: Date Added
• dateModified: string
  Title: Date Modified
• folderType: object Folder Type
  Title: Folder Type

  Indicates type of folder
• id: integer
  Title: Id

  Primary key of Favorite Folders
• isOwner: boolean
  Title: Is Owner
• isShared: boolean
  Title: Is Shared
• name: string
  Title: Name

{
    "type":"object",
    "properties":{
        "canAdd":{
            "type":"boolean",
            "description":"",
            "title":"Can Add Favorites"
        },
        "dateAdded":{
            "type":"string",
            "description":"",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"",
            "title":"Date Modified"
        },
        "folderType":{
            "type":"object",
            "description":"Indicates type of folder",
            "title":"Folder Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "id":{
            "type":"integer",
            "description":"Primary key of Favorite Folders",
            "title":"Id"
        },
        "isOwner":{
            "type":"boolean",
            "description":"",
            "title":"Is Owner"
        },
        "isShared":{
            "type":"boolean",
            "description":"",
            "title":"Is Shared"
        },
        "name":{
            "type":"string",
            "description":"",
            "title":"Name"
        }
    },
    "title":"Favorite Folders"
}

Nested Schema : Folder Type

Type: object

Title: Folder Type

Indicates type of folder

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Indicates type of folder",
    "title":"Folder Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve the specified favorite folder by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/favoriteFolders/123

Response Body Sample

{
  "id": 123,
  "name": "SUV List",
  "isShared": true,
  "canAdd": true,
  "dateAdded": "08/17/2021 2:00 AM",
  "dateModified": "08/17/2021 2:00 AM",
  "createdBy": "john.jones",
  "links": ...
}

Back to Top