put
/rest/v19/favoriteFolders/{id}/sharePermissions
This endpoint modifies the shared permissions for a favorite folder. Only groups can be granted folder permissions.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Primary key of Favorite Folders
Body ()
Root Schema : Favorite Folder Share Permissions
Type:
object
Title:
Favorite Folder Share Permissions
Favorite Folder Share Permissions
Show Source
{
"type":"object",
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/definitions/favoriteFolderSharePermissions-createform"
}
}
},
"title":"Favorite Folder Share Permissions",
"description":"Favorite Folder Share Permissions"
}
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Favorite Folder Share Permissions
Title:
Favorite Folder Share Permissions
{
"type":"array",
"items":{
"$ref":"#/definitions/favoriteFolderSharePermissions-createform"
}
}
Nested Schema : Favorite Folder Share Permissions
Type:
object
Title:
Show Source
Favorite Folder Share Permissions
-
accessLevel:
object Sharing Access Level
Title:
Sharing Access Level
Access Level of the Shared user or Group -
dateAdded:
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
favoriteFolderId:
object Favorite Folder ID
Title:
Favorite Folder ID
ID of the favorite folder -
groupId:
object Group ID
Title:
Group ID
ID of the Group of users the favorite is shared with -
groupLabel:
string
Title:
Shared Group's Label
Shared Group's Label
{
"type":"object",
"properties":{
"accessLevel":{
"type":"object",
"description":"Access Level of the Shared user or Group",
"title":"Sharing Access Level",
"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"
}
}
},
"dateAdded":{
"type":"string",
"description":"System field indicating the date on which the Resource was created.",
"title":"Date Added"
},
"dateModified":{
"type":"string",
"description":"System field indicating the date on which the Resource was last modified.",
"title":"Date Modified"
},
"favoriteFolderId":{
"type":"object",
"description":"ID of the favorite folder",
"title":"Favorite Folder ID",
"properties":{
"id":{
"type":"integer",
"description":"Primary key of Favorite Folders",
"title":"Id"
},
"name":{
"type":"string",
"description":"",
"title":"Name"
}
}
},
"groupId":{
"type":"object",
"description":"ID of the Group of users the favorite is shared with",
"title":"Group ID",
"properties":{
"id":{
"type":"integer",
"description":"PK of the resource",
"title":"Id"
},
"variableName":{
"type":"string",
"description":"Variable Name of the group.",
"title":"Group Variable Name"
}
}
},
"groupLabel":{
"type":"string",
"description":"Shared Group's Label",
"title":"Shared Group's Label"
}
},
"title":"Favorite Folder Share Permissions"
}
Nested Schema : Sharing Access Level
Type:
object
Title:
Sharing Access Level
Access Level of the Shared user or Group
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":"Access Level of the Shared user or Group",
"title":"Sharing Access Level",
"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"
}
}
}
Nested Schema : Favorite Folder ID
Type:
object
Title:
Favorite Folder ID
ID of the favorite folder
Show Source
-
id:
integer
Title:
Id
Primary key of Favorite Folders -
name:
string
Title:
Name
{
"type":"object",
"description":"ID of the favorite folder",
"title":"Favorite Folder ID",
"properties":{
"id":{
"type":"integer",
"description":"Primary key of Favorite Folders",
"title":"Id"
},
"name":{
"type":"string",
"description":"",
"title":"Name"
}
}
}
Nested Schema : Group ID
Type:
object
Title:
Group ID
ID of the Group of users the favorite is shared with
Show Source
-
id:
integer
Title:
Id
PK of the resource -
variableName:
string
Title:
Group Variable Name
Variable Name of the group.
{
"type":"object",
"description":"ID of the Group of users the favorite is shared with",
"title":"Group ID",
"properties":{
"id":{
"type":"integer",
"description":"PK of the resource",
"title":"Id"
},
"variableName":{
"type":"string",
"description":"Variable Name of the group.",
"title":"Group Variable Name"
}
}
}
Response
Supported Media Types
- application/json
Default Response
Body ()
Root Schema : favoriteFolderSharePermissions-collection
Type:
Show Source
object
-
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/favoriteFolderSharePermissions"
}
}
}
}
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Favorite Folder Share Permissions
Title:
Favorite Folder Share Permissions
{
"type":"array",
"items":{
"$ref":"#/definitions/favoriteFolderSharePermissions"
}
}
Nested Schema : Favorite Folder Share Permissions
Type:
object
Title:
Show Source
Favorite Folder Share Permissions
-
accessLevel:
object Sharing Access Level
Title:
Sharing Access Level
Access Level of the Shared user or Group -
dateAdded:
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
favoriteFolderId:
object Favorite Folder ID
Title:
Favorite Folder ID
ID of the favorite folder -
groupId:
object Group ID
Title:
Group ID
ID of the Group of users the favorite is shared with -
groupLabel:
string
Title:
Shared Group's Label
Shared Group's Label
{
"type":"object",
"properties":{
"accessLevel":{
"type":"object",
"description":"Access Level of the Shared user or Group",
"title":"Sharing Access Level",
"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"
}
}
},
"dateAdded":{
"type":"string",
"description":"System field indicating the date on which the Resource was created.",
"title":"Date Added"
},
"dateModified":{
"type":"string",
"description":"System field indicating the date on which the Resource was last modified.",
"title":"Date Modified"
},
"favoriteFolderId":{
"type":"object",
"description":"ID of the favorite folder",
"title":"Favorite Folder ID",
"properties":{
"id":{
"type":"integer",
"description":"Primary key of Favorite Folders",
"title":"Id"
},
"name":{
"type":"string",
"description":"",
"title":"Name"
}
}
},
"groupId":{
"type":"object",
"description":"ID of the Group of users the favorite is shared with",
"title":"Group ID",
"properties":{
"id":{
"type":"integer",
"description":"PK of the resource",
"title":"Id"
},
"variableName":{
"type":"string",
"description":"Variable Name of the group.",
"title":"Group Variable Name"
}
}
},
"groupLabel":{
"type":"string",
"description":"Shared Group's Label",
"title":"Shared Group's Label"
}
},
"title":"Favorite Folder Share Permissions"
}
Nested Schema : Sharing Access Level
Type:
object
Title:
Sharing Access Level
Access Level of the Shared user or Group
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":"Access Level of the Shared user or Group",
"title":"Sharing Access Level",
"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"
}
}
}
Nested Schema : Favorite Folder ID
Type:
object
Title:
Favorite Folder ID
ID of the favorite folder
Show Source
-
id:
integer
Title:
Id
Primary key of Favorite Folders -
name:
string
Title:
Name
{
"type":"object",
"description":"ID of the favorite folder",
"title":"Favorite Folder ID",
"properties":{
"id":{
"type":"integer",
"description":"Primary key of Favorite Folders",
"title":"Id"
},
"name":{
"type":"string",
"description":"",
"title":"Name"
}
}
}
Nested Schema : Group ID
Type:
object
Title:
Group ID
ID of the Group of users the favorite is shared with
Show Source
-
id:
integer
Title:
Id
PK of the resource -
variableName:
string
Title:
Group Variable Name
Variable Name of the group.
{
"type":"object",
"description":"ID of the Group of users the favorite is shared with",
"title":"Group ID",
"properties":{
"id":{
"type":"integer",
"description":"PK of the resource",
"title":"Id"
},
"variableName":{
"type":"string",
"description":"Variable Name of the group.",
"title":"Group Variable Name"
}
}
}
Examples
The following example shows how to modify the shared permissions for a favorite folder by submitting a PUT request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X PUT -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/favoriteFolders/1234/sharePermissions
Request Body Sample
{ "items": [{ "accessLevel": { "displayValue": "Edit" }, "groupId": { "variableName": "salesAdministrator" } } ] }