Jump to

• Request
• Response
• Examples

Update Sharing Settings for a Favorite

put

/rest/v19/favorites/{id}/sharePermissions

This endpoint updates the sharing settings for a favorite. Only the owner of the favorite or FullAccess user can update a favorite.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  The identifier for the favorite.

Body ()

Root Schema : Favorite Share Permissions

Type: object

Title: Favorite Share Permissions

Favorite Share Permissions

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/favoriteSharePermissions-createform"
            }
        }
    },
    "title":"Favorite Share Permissions",
    "description":"Favorite Share Permissions"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Favorite Share Permissions
  Title: Favorite Share Permissions

  Favorite Share Permissions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/favoriteSharePermissions-createform"
    }
}

Nested Schema : Favorite Share Permissions

Type: object

Title: Favorite Share Permissions

Favorite Share Permissions

Show Source

• 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.
• favoriteId: object Favorite ID
  Title: Favorite ID

  ID of the favorite
• 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
• groupVariableName: string
  Title: Shared Group's Variable Name

  Shared Group's Variable Name
• userFirstName: string
  Title: Shared User's First Name

  Shared User's First Name
• userId: object User ID
  Title: User ID

  ID of the user with whom the favorite is shared with
• userLastName: string
  Title: Shared User's Last Name

  Shared User's First Name

{
    "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"
        },
        "favoriteId":{
            "type":"object",
            "description":"ID of the favorite",
            "title":"Favorite ID",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the resource",
                    "title":"Id"
                }
            }
        },
        "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"
                }
            }
        },
        "groupLabel":{
            "type":"string",
            "description":"Shared Group's Label",
            "title":"Shared Group's Label"
        },
        "groupVariableName":{
            "type":"string",
            "description":"Shared Group's Variable Name",
            "title":"Shared Group's Variable Name"
        },
        "userFirstName":{
            "type":"string",
            "description":"Shared User's First Name",
            "title":"Shared User's First Name"
        },
        "userId":{
            "type":"object",
            "description":"ID of the user with whom the favorite is shared with",
            "title":"User ID",
            "properties":{
                "internalId":{
                    "type":"integer",
                    "description":"PK of the resource",
                    "title":"Internal Id"
                },
                "key":{
                    "type":"string",
                    "description":"User Key",
                    "title":"key"
                }
            }
        },
        "userLastName":{
            "type":"string",
            "description":"Shared User's First Name",
            "title":"Shared User's Last Name"
        }
    },
    "title":"Favorite Share Permissions",
    "description":"Favorite 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 ID

Type: object

Title: Favorite ID

ID of the favorite

Show Source

• id: integer
  Title: Id

  Primary Key of the resource

{
    "type":"object",
    "description":"ID of the favorite",
    "title":"Favorite ID",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        }
    }
}

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

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

Nested Schema : User ID

Type: object

Title: User ID

ID of the user with whom the favorite is shared with

Show Source

• internalId: integer
  Title: Internal Id

  PK of the resource
• key: string
  Title: key

  User Key

{
    "type":"object",
    "description":"ID of the user with whom the favorite is shared with",
    "title":"User ID",
    "properties":{
        "internalId":{
            "type":"integer",
            "description":"PK of the resource",
            "title":"Internal Id"
        },
        "key":{
            "type":"string",
            "description":"User Key",
            "title":"key"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Back to Top

Examples

The following example shows how to update the sharing settings for a favorite 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/favorites/123/sharePermissions

Response Body Sample

{
  "items": [{
      "accessLevel": {
        "lookupCode": "1"
      },
      "userId": {
        "key": "abcd-efgh"
      }
    }, {
      "accessLevel": {
        "lookupCode": "1"
      },
      "groupId": {
        "id": 21081266
      }
    }
  ]
}

Back to Top