Jump to

• Request
• Response
• Examples

Create a user favorite

post

/crmRestApi/resources/11.13.18.05/userFavorites

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FavoriteObject: string
  Title: Favorite Object

  Maximum Length: 230

  The rest resource name of the object.
• FavoriteObjectId: integer (int64)
  Title: Favorite Object Identifier

  A key that uniquely identifies the object that is set in favorite_object column.

{
    "type":"object",
    "properties":{
        "FavoriteObject":{
            "title":"Favorite Object",
            "maxLength":"230",
            "type":"string",
            "description":"The rest resource name of the object.",
            "nullable":false
        },
        "FavoriteObjectId":{
            "title":"Favorite Object Identifier",
            "type":"integer",
            "description":"A key that uniquely identifies the object that is set in favorite_object column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : userFavorites-item-response

Type: object

Show Source

• FavoriteObject: string
  Title: Favorite Object

  Maximum Length: 230

  The rest resource name of the object.
• FavoriteObjectId: integer (int64)
  Title: Favorite Object Identifier

  A key that uniquely identifies the object that is set in favorite_object column.
• LastAccessedDate: string (date-time)
  Title: Last Accessed Date

  Read Only: true

  The date when the favorite access row was last accessed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UserFavoriteId: integer (int64)
  Title: User Favorite Identifier

  Read Only: true

  The unique identifier of a user favorite.

{
    "type":"object",
    "properties":{
        "FavoriteObjectId":{
            "title":"Favorite Object Identifier",
            "type":"integer",
            "description":"A key that uniquely identifies the object that is set in favorite_object column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastAccessedDate":{
            "title":"Last Accessed Date",
            "type":"string",
            "description":"The date when the favorite access row was last accessed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FavoriteObject":{
            "title":"Favorite Object",
            "maxLength":"230",
            "type":"string",
            "description":"The rest resource name of the object.",
            "nullable":false,
            "x-queryable":true
        },
        "UserFavoriteId":{
            "title":"User Favorite Identifier",
            "type":"integer",
            "description":"The unique identifier of a user favorite.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to create an user favorite by submitting a POST request on the REST resource.

cURL Command

The following shows an example of the request header.

curl -u <username:password> \
 -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userFavorite  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
      "FavoriteObject": "leads",
      "FavoriteObjectId": 123134
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "UserFavoriteId": 300100559075574,
    "FavoriteObject": "leads",
    "FavoriteObjectId": 123134,
    "LastAccessedDate": "2022-08-09T09:50:58+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userFavorites/300100559075574",
            "name": "userFavorites",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userFavorites/300100559075574",
            "name": "userFavorites",
            "kind": "item"
        }
    ]
}

Note:

• You can create user favorites on a valid CX rest resource object only.
• The following things happen when you create an user favorite:

  • A recent item record gets created, if the rest resource is Accounts, Activities, Assets, Contacts, Products,Setup Sales Catalogs, Leads, Opportunities, Partners, Service Requests, Partner Contacts, and

    custom objects.

  • The user context score increases, if the rest resource is Accounts, Activities, Assets, Contacts, Products, Setup Sales Catalogs, Leads, Opportunities, Partners, Service Requests, and Partner Contacts.

Back to Top