機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

お気に入りの設定

post

/crmRestApi/resources/11.13.18.05/userFavorites/action/setFavorite

入力オブジェクト識別子およびオブジェクト・タイプに対して、入力お気に入り値に基づいてお気に入りを設定するかどうかを設定します。

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/vnd.oracle.adf.action+json

リクエスト本文 - application/vnd.oracle.adf.action+json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• favoriteValue: boolean
  値がお気に入りかどうかを示します。
• objectId: number
  favorite_object列に設定されているオブジェクトを一意に識別するキー。
• objectType: string
  オブジェクトの残りのリソース名。

{
    "type":"object",
    "properties":{
        "favoriteValue":{
            "type":"boolean",
            "description":"Indicates whether the value is favorite or not.",
            "nullable":true
        },
        "objectId":{
            "type":"number",
            "description":"A key that uniquely identifies the object that is set in favorite_object column.",
            "nullable":true
        },
        "objectType":{
            "type":"string",
            "description":"The rest resource name of the object.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json
• application/vnd.oracle.adf.actionresult+json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

本文( )

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• result(required): string
  操作のステータスを成功または失敗として返します。

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns status of the operation as either success or failure."
        }
    },
    "additionalProperties":false
}

トップに戻る

例:

次の例は、RESTリソースでPOSTリクエストを発行して、ユーザーをお気に入りに設定する方法を示しています。

cURLコマンド

次に、リクエスト・ヘッダーの例を示します。

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

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
"objectType" : "leads",
"objectId": 12321,
"favoriteValue": true
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "result": "success"
}

「トップに戻る」