すべてのソーシャル・ポストの取得
get
/crmRestApi/resources/11.13.18.05/socialPosts
リクエスト
問合せパラメータ
- expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 指定された主キーを持つソーシャル・ポストを検索します。
ファインダ変数:- PostId; integer;ソーシャル投稿の一意の識別子。
- PrimaryKey : 指定された主キーを持つソーシャル・ポストを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CanRespondFlag; boolean;他のユーザーがソーシャル・ポストに応答できるかどうかを示します。
- CreatedBy; string;ソーシャル投稿を作成したユーザー。
- CreationDate; string;ソーシャル投稿が作成された日付。
- DeletedFlag; boolean;ソーシャル投稿を削除できるかどうかを示します。 値がYの場合、ソーシャル投稿を削除できます。 デフォルト値はNです。
- LastUpdateDate; string;ソーシャル投稿が最後に更新された日時。
- LastUpdateLogin; string;ソーシャル投稿を最後に更新したユーザーのログイン。
- LastUpdatedBy; string; ソーシャル投稿を最後に更新したユーザー。
- ObjectId; integer; ソーシャル・ポストに関連付けられたビジネス・オブジェクトの一意の識別子。
- ObjectTypeCd; string; SVC_SERVICE_REQUESTSやSVC_SR_MESSAGESなど、ソーシャル・ポストに関連付けられたビジネス・オブジェクトのタイプを示します。
- PostChannelCd; string;ソーシャル投稿が作成されたソーシャル・ネットワークを示すコード。 受け入れられる値は、参照タイプHZ_INSTANT_MESSENGER_TYPEで定義されます。
- PostContentString; string;文字列データ型のソーシャル投稿のコンテンツ。
- PostDate; string; 顧客がソーシャル・ネットワークでソーシャル投稿を行った日時。
- PostId; integer;ソーシャル投稿の一意の識別子。
- PostMessageTypeCd; string; ソーシャル投稿が公開か非公開かを示すコード。 受け入れられる値は、参照タイプORA_SVC_SOC_POST_MSG_TYPE_CDで定義されます。
- PostParentPostId; string; ソース・システムによって提供されるソーシャル・ポストの親の一意の識別子。 このフィールドがnullの場合、ソーシャル・ポストのサービス・リクエストが作成されます。 このフィールドがnullでない場合、このレコードのソーシャル投稿コンテンツは、このフィールドのソーシャル投稿レコードに対応するサービス・リクエストに追加されます。
- PostPostId; string; ソース・システムによって提供されるソーシャル投稿の一意の識別子。
- PostSubChannelName; string; Facebookファン・ページやブランド会社のTwitterハンドルなど、ソーシャル・ポストが作成されたチャネルの名前。
- PostURL; string;ソーシャル・ネットワーク上のソーシャル投稿のURL。
- PostUser; string;ソーシャル・ポストを作成した作成者のソーシャル・ネットワーク・ハンドル。
- ProcessingMessage; string;処理されたソーシャル投稿メッセージ。
- ProcessingStatusCd; string; ソーシャル投稿が正常に処理されたかどうかを示すコード。 たとえば、エラー、処理済です。 受け入れられる値のリストは、参照ORA_SVC_SOCIAL_PROC_STATUS_CDで定義されます。
- SocialUserId; integer;ソーシャル・ネットワーク上のユーザーの一意の識別子。
- SourceCd;文字列。CX SalesおよびB2B Serviceにソーシャル投稿を送信したソース・システムを示すコード(SRMなど)。 受け入れられる値は、参照タイプORA_SVC_SOC_POST_SOURCE_CDで定義されます。
- SourcePostIdPrimary; string;統合のために予約されています。 このフィールドは、ソース・システムのコールバック時またはソース・システムへのレスポンスの送信時にインテグレータが使用できます。
- SourcePostIdSecondary; string;統合のために予約されています。 このフィールドは、ソース・システムのコールバック時またはソース・システムへのレスポンスの送信時にインテグレータが使用できます。
- SourcePostIdTertiary; string;統合のために予約されています。 このフィールドは、ソース・システムのコールバック時またはソース・システムへのレスポンスの送信時にインテグレータが使用できます。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
例:
次のURI構文でGETを使用して、すべてのソーシャル投稿の詳細を取得します:
リクエストURIの例
次に、リクエスト・ヘッダーの例を示します。
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
GET /crmRestApi/resources/11.13.18.05/socialPosts/ HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200: OK Date: Mon, 09 Jan 2017 13:26:04 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "CreatedBy": "autoapicsm2", "CreationDate": "2016-09-27T12:47:02-07:00", "DeletedFlag": false, "LastUpdateDate": "2016-11-08T13:50:47-08:00", "LastUpdateLogin": "40CBE73A45914FBBE0530E8EF50A5A19", "LastUpdatedBy": "SALES_ADMIN", "PostChannelCd": "ORA_SVC_FACEBOOK", "PostDate": "2016-09-27T13:23:22-07:00", "PostId": 300100090027888, "PostMessageTypeCd": null, "PostParentPostId": null, "PostPostId": "8391", "PostSubChannelName": null, "PostURL": null, "PostUser": "me@me.com", "SourceCd": "ORA_SVC_ICS", "SourcePostIdPrimary": "9281", "SourcePostIdSecondary": null, "SourcePostIdTertiary": null, "PostContentString": "Test Test", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888", "name": "socialPosts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888", "name": "socialPosts", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/lov/SourceCdLookup", "name": "SourceCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/lov/PostMessageTypeCdLookup", "name": "PostMessageTypeCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/lov/PostChannelCdLookup", "name": "PostChannelCdLookup", "kind": "collection" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/enclosure/PostContent", "name": "PostContent", "kind": "other" } ], }, { "CreatedBy": "autoapicsm2", "CreationDate": "2016-10-13T21:17:43-07:00", "DeletedFlag": false, "LastUpdateDate": "2016-10-13T21:17:43-07:00", "LastUpdateLogin": "3ECC4811802C501FE0530E8EF50ACE3A", "LastUpdatedBy": "autoapicsm2", "PostChannelCd": "ORA_SVC_TWITTER", "PostDate": "2016-10-13T13:23:22-07:00", "PostId": 300100091600174, "PostMessageTypeCd": null, "PostParentPostId": null, "PostPostId": "2332", "PostSubChannelName": null, "PostURL": null, "PostUser": "me@me.com", "SourceCd": "ORA_SVC_ICS", "SourcePostIdPrimary": "1483", "SourcePostIdSecondary": null, "SourcePostIdTertiary": null, "PostContentString": "Test Test", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174", "name": "socialPosts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174", "name": "socialPosts", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/lov/SourceCdLookup", "name": "SourceCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/lov/PostMessageTypeCdLookup", "name": "PostMessageTypeCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/lov/PostChannelCdLookup", "name": "PostChannelCdLookup", "kind": "collection" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/enclosure/PostContent", "name": "PostContent", "kind": "other" } ], }, . . . } }