機械翻訳について

ジャンプ先

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

ソーシャル・ユーザーの作成

post

/crmRestApi/resources/11.13.18.05/socialUsers

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• FollowerCount: integer (int64)
  タイトル: Followers

  ユーザーがソーシャル・ネットワーク上に持っているフォロワの数。
• ImageURL: string
  タイトル: Profile Image URL

  最大長: 1000

  ソーシャル・ユーザーのプロファイル・イメージのURL。
• ProfileURL: string
  タイトル: Profile URL

  最大長: 1000

  ソーシャル・ユーザーのプロファイルのURL。
• SocialNetworkCd: string
  タイトル: Social Network

  最大長: 30

  TwitterやFacebookなど、使用されたソーシャル・ネットワークを示すコード。
• SocialNetworkUserId: string
  タイトル: Social Network User ID

  最大長: 200

  対応するソーシャル・ネットワーク内のソーシャル・ユーザーのユーザーID。
• SocialNetworkUserName: string
  タイトル: Social Network User Name

  最大長: 200

  対応するソーシャル・ネットワーク上のソーシャル・ユーザーの表示名。

{
    "type":"object",
    "properties":{
        "SocialNetworkUserName":{
            "title":"Social Network User Name",
            "maxLength":200,
            "type":"string",
            "description":"The display name of the social user on the corresponding social network.",
            "nullable":true
        },
        "ImageURL":{
            "title":"Profile Image URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL of the social user's profile image.",
            "nullable":true
        },
        "FollowerCount":{
            "title":"Followers",
            "type":"integer",
            "description":"The number of followers that the user has on the social network.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SocialNetworkUserId":{
            "title":"Social Network User ID",
            "maxLength":200,
            "type":"string",
            "description":"The user ID of the social user in the corresponding social network.",
            "nullable":false
        },
        "SocialNetworkCd":{
            "title":"Social Network",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the social network that was used, such as Twitter or Facebook.",
            "nullable":false
        },
        "ProfileURL":{
            "title":"Profile URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL of the social user's profile.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  ソーシャル・ユーザーを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  ソーシャル・ユーザーが作成された日付。
• FollowerCount: integer (int64)
  タイトル: Followers

  ユーザーがソーシャル・ネットワーク上に持っているフォロワの数。
• ImageURL: string
  タイトル: Profile Image URL

  最大長: 1000

  ソーシャル・ユーザーのプロファイル・イメージのURL。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  ソーシャル・ユーザーが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  ソーシャル・ユーザーを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  ソーシャル・ユーザーを最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ProfileURL: string
  タイトル: Profile URL

  最大長: 1000

  ソーシャル・ユーザーのプロファイルのURL。
• SocialNetworkCd: string
  タイトル: Social Network

  最大長: 30

  TwitterやFacebookなど、使用されたソーシャル・ネットワークを示すコード。
• SocialNetworkUserId: string
  タイトル: Social Network User ID

  最大長: 200

  対応するソーシャル・ネットワーク内のソーシャル・ユーザーのユーザーID。
• SocialNetworkUserName: string
  タイトル: Social Network User Name

  最大長: 200

  対応するソーシャル・ネットワーク上のソーシャル・ユーザーの表示名。
• UserId: integer (int64)
  タイトル: Social User ID

  読取り専用: true

  ソーシャル・ユーザーの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the social user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the social user was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the social user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SocialNetworkUserName":{
            "title":"Social Network User Name",
            "maxLength":200,
            "type":"string",
            "description":"The display name of the social user on the corresponding social network.",
            "nullable":true,
            "x-queryable":true
        },
        "ImageURL":{
            "title":"Profile Image URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL of the social user's profile image.",
            "nullable":true,
            "x-queryable":true
        },
        "UserId":{
            "title":"Social User ID",
            "type":"integer",
            "description":"The unique identifier of the social user.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "FollowerCount":{
            "title":"Followers",
            "type":"integer",
            "description":"The number of followers that the user has on the social network.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SocialNetworkUserId":{
            "title":"Social Network User ID",
            "maxLength":200,
            "type":"string",
            "description":"The user ID of the social user in the corresponding social network.",
            "nullable":false,
            "x-queryable":true
        },
        "SocialNetworkCd":{
            "title":"Social Network",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the social network that was used, such as Twitter or Facebook.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileURL":{
            "title":"Profile URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL of the social user's profile.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the social user was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the social user.",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、ソーシャル・ユーザーを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialUsers

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
  "SocialNetworkCd": "TWITTER",
  "SocialNetworkUserId": "rnhkmtest",
  "ImageURL": "https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png",
  "ProfileURL": "https://twitter.com/rnhkmtest",
  "FollowerCount": 6,
  "SocialNetworkUserName": "rnhkmtest"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "UserId": 300100182585582,
    "SocialNetworkCd": "TWITTER",
    "SocialNetworkUserId": "rnhkmtest",
    "ImageURL": "https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png",
    "ProfileURL": "https://twitter.com/rnhkmtest",
    "FollowerCount": 6,
    "CreationDate": "2020-01-06T10:53:58+00:00",
    "CreatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2020-01-06T10:53:58.086+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateLogin": "99EB0BDE3A88544BE05392BDF20A1824",
    "SocialNetworkUserName": "rnhkmtest",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialUsers/300100182585582",
            "name": "socialUsers",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialUsers/300100182585582",
            "name": "socialUsers",
            "kind": "item"
        }
    ]
}

「トップに戻る」