Jump to

• Request
• Response
• Examples

Create a Favorite Folder

post

/rest/v16/favoriteFolders

This endpoint creates a favorite folder.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Favorite Folders

Type: object

Title: Favorite Folders

Show Source

• dateAdded: string
  Title: Date Added
• dateModified: string
  Title: Date Modified
• isShared: boolean
  Title: Is Shared
• name: string
  Title: Name

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"",
            "title":"Date Modified"
        },
        "isShared":{
            "type":"boolean",
            "description":"",
            "title":"Is Shared"
        },
        "name":{
            "type":"string",
            "description":"",
            "title":"Name"
        }
    },
    "title":"Favorite Folders"
}

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 a create favorite folder 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/favoriteFolders

Request Body Sample

{
  "name": "abc",
}

Response Body Sample

{
  "canAdd": true,
  "dateModified": "2022-03-01T02:55:21.010Z",
  "folderType": {
    "displayValue": "User Defined",
    "lookupCode": "2",
    "links": [{
        "rel": "domain",
        "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_FOLDER_TYPE%22%7D%7D"
      }
    ]
  },
  "dateAdded": "2022-03-01T02:55:21.010Z",
  "isOwner": true,
  "name": "newFolder",
  "id": 9100006914,
  "isShared": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/9100006914"
    }, {
      "kind": "",
      "rel": "child",
      "name": "sharePermissions",
      "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/9100006914/sharePermissions"
    }, {
      "kind": "",
      "rel": "child",
      "name": "translations",
      "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/9100006914/translations"
    }
  ]
}

Back to Top