機械翻訳について

ジャンプ先

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

ユーザーお気に入りの作成

post

/crmRestApi/resources/11.13.18.05/userFavorites

リクエスト

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• FavoriteObject: string
  タイトル: Favorite Object

  最大長: 230

  オブジェクトの残りのリソース名。
• FavoriteObjectId: integer (int64)
  タイトル: Favorite Object Identifier

  favorite_object列に設定されているオブジェクトを一意に識別するキー。

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

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : userFavorites-item-response

タイプ: object

ソースを表示

• FavoriteObject: string
  タイトル: Favorite Object

  最大長: 230

  オブジェクトの残りのリソース名。
• FavoriteObjectId: integer (int64)
  タイトル: Favorite Object Identifier

  favorite_object列に設定されているオブジェクトを一意に識別するキー。
• LastAccessedDate: string (date-time)
  タイトル: Last Accessed Date

  読取り専用: true

  お気に入りアクセス行が最後にアクセスされた日付。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• UserFavoriteId: integer (int64)
  タイトル: User Favorite Identifier

  読取り専用: true

  ユーザーお気に入りの一意の識別子。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

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

トップに戻る

例:

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

cURLコマンド

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

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

リクエスト本文の例

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

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

レスポンス本文の例

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

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

ノート:

• 有効なCX Restリソース・オブジェクトにのみユーザーのお気に入りを作成できます。
• ユーザーのお気に入りを作成すると、次のことが発生します:

  • 残りのリソースが取引先、活動、アセット、担当者、製品、販売カタログの設定、見込み客、商談、パートナ、サービス・リクエスト、パートナ担当者、および

    カスタム・オブジェクト。

  • 残りのリソースがアカウント、アクティビティ、アセット、担当者、製品、販売カタログの設定、リード、商談、パートナ、サービス・リクエストおよびパートナ担当者の場合は、ユーザー・コンテキスト・スコアが増加します。

「トップに戻る」