REST API Services for Oracle CPQ

Get a List of Favorite Folders

get

/rest/v16/favoriteFolders

This endpoint returns a list of all favorite folders available to the user.

Request

Supported Media Types

application/json

Query Parameters

expand: string

Allows expansion of relationships.
fields: string

Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
limit: integer

The requested page size, which limits the number of elements the collection should max return.
offset: integer

The offset of the page. By default, offset is 0, which means first page will be returned.
orderby: string

Specifies a comma-separated list of pairs to order the response by.
q: string

Allows to specify one or more filtering criteria. By default, no filtering is applied.
totalResults: boolean

Specifies that the total count of records should be included in the response when doing pagination.

Response

Supported Media Types

application/json

Default Response

Root Schema : favoriteFolders-collection

Type: object

Show Source

count: integer

The number of resource instances returned in the current range.
hasMore: boolean

Returns true if more resources are available on the server than the subset returned in current page.
items: array items
limit: integer

The actual paging size used by the server.
offset: integer

The offset used in the current page.
totalResults: integer

Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/favoriteFolders"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Favorite Folders

Title: Favorite Folders

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/favoriteFolders"
    }
}

Nested 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"
        }
    }
}

Examples

The following example shows how to return a list of all favorite folders available to the user 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

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/favoriteFolders"
    }
  ],
  "items": [{
      "canAdd": true,
      "dateModified": "2010-01-25T02:40:10.000Z",
      "folderType": {
        "lookupCode": "0",
        "displayValue": "ESUV100 Options",
        "id": 3022586486,
        "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"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/lookupValues/3022586486"
          }
        ]
      },
      "dateAdded": "2010-01-25T02:40:10.000Z",
      "isOwner": true,
      "name": "ESUV100 Options",
      "id": 6992502,
      "isShared": false,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/6992502"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/6992502/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/6992502/translations"
        }
      ]
    }, {
      "canAdd": true,
      "dateModified": "2010-01-25T02:40:10.000Z",
      "folderType": {
        "lookupCode": "1",
        "displayValue": "ESUV200 Options",
        "id": 3022586487,
        "links": [{
            "rel": "domain",
            "href": "https://csitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_FOLDER_TYPE%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/lookupValues/3022586487"
          }
        ]
      },
      "dateAdded": "2010-01-25T02:40:10.000Z",
      "isOwner": true,
      "name": "ESUV200 Options",
      "id": 6992501,
      "isShared": false,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/6992501"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/6992501/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/6992501/translations"
        }
      ]
    }, {
      "canAdd": true,
      "dateModified": "2022-02-24T00:24:40.000Z",
      "folderType": {
        "lookupCode": "2",
        "displayValue": "User Defined",
        "id": 3022586488,
        "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"
          }, {
            "rel": "canonical",
            "href": "https://csitename.oracle.com/rest/v16/lookupValues/3022586488"
          }
        ]
      },
      "dateAdded": "2022-02-24T00:24:40.000Z",
      "isOwner": true,
      "name": "My  Added Options",
      "id": 3022640642,
      "isShared": false,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022640642"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022640642/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022640642/translations"
        }
      ]
    }, {
      "canAdd": true,
      "dateModified": "2022-02-25T00:19:31.000Z",
      "folderType": {
        "lookupCode": "2",
        "displayValue": "User Defined",
        "id": 3022586488,
        "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"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/lookupValues/3022586488"
          }
        ]
      },
      "dateAdded": "2022-02-25T00:19:31.000Z",
      "isOwner": true,
      "name": "ESUV300 Options",
      "id": 3022643280,
      "isShared": false,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022643280"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022643280/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022643280/translations"
        }
      ]
    }, {
      "canAdd": true,
      "dateModified": "2022-02-23T04:29:10.000Z",
      "folderType": {
        "lookupCode": "2",
        "displayValue": "User Defined",
        "id": 3022586488,
        "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"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/lookupValues/3022586488"
          }
        ]
      },
      "dateAdded": "2022-02-17T22:05:23.000Z",
      "isOwner": true,
      "name": "ESUV400 Options",
      "id": 3022630612,
      "isShared": false,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022630612"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022630612/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022630612/translations"
        }
      ]
    }, {
      "canAdd": true,
      "dateModified": "2022-02-19T05:10:27.000Z",
      "folderType": {
        "lookupCode": "2",
        "displayValue": "User Defined",
        "id": 3022586488,
        "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"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v16/lookupValues/3022586488"
          }
        ]
      },
      "dateAdded": "2022-02-19T05:10:27.000Z",
      "isOwner": true,
      "name": "ESUV500 Options",
      "id": 3022633752,
      "isShared": false,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022633752"
        }, {
          "kind": "",
          "rel": "child",
          "name": "sharePermissions",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022633752/sharePermissions"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v16/favoriteFolders/3022633752/translations"
        }
      ]
    }
  ]
}