LightBoxプレゼンテーション・セッション・フィードバック・アイテムの更新
patch
/crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}
リクエスト
パス・パラメータ
- presentationSessionFeedbackUniqID(required): string
これは、Lightboxプレゼンテーション・セッション・フィードバック・リソースのコンポジット・キーを構成する属性のハッシュ・キーで、Lightboxプレゼンテーション・セッション・フィードバックのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはLightboxプレゼンテーション・セッション・フィードバックの特定のインスタンスに移動してハッシュ・キーを取得するために、Lightboxプレゼンテーション・セッション・フィードバック・コレクション・リソースを問い合せる必要があります。
ヘッダー・パラメータ
- Effective-Of:
このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた
= 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。のリストです。 - Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
CurrencyCode: string
タイトル:
Currency最大長:30プレゼンテーション・セッション・フィードバックに関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 -
FeedbackComment: string
タイトル:
Comment最大長:240セッション・フィードバックに関するコメント。 -
FeedbackRating: 整数(int32)
タイトル:
Ratingセッション・フィードバックの評価。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : presentationSessionFeedback-item-response
タイプ:
ソースを表示
object-
AccountId: integer (int64)
タイトル:
Account ID読取り専用:trueアカウントの一意の識別子。 -
AccountName: string
タイトル:
Organization Name読取り専用:true最大長:360プレゼンテーション・セッションに関連付けられているアカウントの名前。 -
AccountPartyNumber: string
タイトル:
Registry ID読取り専用:true最大長:30プレゼンテーション・セッションに関連付けられたアカウントのパーティ番号。 -
ActivityId: integer (int64)
タイトル:
Activity ID読取り専用:trueアクティビティの一意の識別子。 -
ActivitySubject: string
タイトル:
Subject読取り専用:true最大長:500アクティビティの件名。 -
ContactId: integer
タイトル:
Contact IDフィードバックを提供する担当者の一意の識別子。 -
ContactJobTitle: string
タイトル:
Job Title読取り専用:true最大長:100フィードバックを提供する担当者のジョブ・タイトル。 -
ContactName: string
タイトル:
Contact最大長:450フィードバックを提供する担当者の名前。 -
ContactPartyNumber: string
タイトル:
Party Number読取り専用:true最大長:30フィードバックを提供する担当者のパーティ番号。 -
ContactTitle: string
タイトル:
Title読取り専用:true最大長:60フィードバックを提供する担当者のタイトル。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueレコードが作成された日付。 -
CurrencyCode: string
タイトル:
Currency最大長:30プレゼンテーション・セッション・フィードバックに関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 -
DeleteFlag: boolean
読取り専用:
true現在のユーザーにフィードバック・レコードを削除する権限があるかどうかを示します。 デフォルト値はtrueです。 -
DocumentTitle: string
タイトル:
Document Title最大長:255Lightbox文書のタイトル。 -
DocumentVersion: string
タイトル:
Version最大長:64このフィードバックのLightbox文書のバージョン。 -
FeedbackComment: string
タイトル:
Comment最大長:240セッション・フィードバックに関するコメント。 -
FeedbackRating: 整数(int32)
タイトル:
Ratingセッション・フィードバックの評価。 -
FileName: string
タイトル:
File Name読取り専用:true最大長:1000Lightbox文書のファイル名。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date読取り専用:trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32レコードを最後に更新したユーザーのログイン。 -
LightboxDocumentId: string
タイトル:
Document ID最大長:64Sales Lightbox文書の一意の識別子。 -
LightboxDocumentPageId: string
タイトル:
Document Page ID最大長:64Lightbox文書ページの一意の識別子。 オプションで、LightbocDocumentIdおよびDocumentVersionを使用して、ドキュメント・ページを指定できます。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
PageCount: 整数(int32)
タイトル:
Page Count読取り専用:trueデフォルト値:0Lightbox文書のページ数。 -
PageSequenceNumber: 整数(int32)
タイトル:
Page Sequence NumberLightbox文書ページのページ順序番号。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。 -
PageTitle: string
タイトル:
Page Title最大長:255Lightbox文書ページのページ・タイトル。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。 -
PresentationSessionId: integer (int64)
タイトル:
Session IDこのフィードバックのプレゼンテーション・セッションの一意の識別子。 -
SessionDate: string (date-time)
タイトル:
Date and Time読取り専用:trueプレゼンテーション・セッションが発生した日時。 -
SessionFeedbackId: integer (int64)
タイトル:
Feedback IDセッション・フィードバックの一意の識別子。 -
SessionOwnerEmailAddress: string
タイトル:
Owner Primary Email読取り専用:true最大長:320プレゼンテーション・セッションの所有者の電子メール・アドレス。 -
SessionOwnerId: integer (int64)
タイトル:
Session Owner ID読取り専用:trueプレゼンテーション・セッションの所有者の一意の識別子。 -
SessionOwnerName: string
タイトル:
Owner Name読取り専用:true最大長:360プレゼンテーション・セッションの所有者の名前。 -
SessionOwnerTitle: string
タイトル:
Owner Title読取り専用:true最大長:60プレゼンテーション・セッションの所有者のタイトル。 -
TotalTimeAttendeeViewedDocument: integer
タイトル:
Total Document Attended Duration読取り専用:true参加者がLightbox文書を表示した合計期間。 -
TotalTimeAttendeeViewedDocumentPage: integer
タイトル:
Total Page Attended Duration読取り専用:true出席者がドキュメント・ページを表示した合計期間。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。 -
TotalTimeAttendeeViewedSession: integer
タイトル:
Total Session Attended Duration読取り専用:true参加者がセッションを表示した合計期間。 -
TotalTimeDocumentPagePresented: integer
タイトル:
Total Page Display Duration読取り専用:trueセッション中にドキュメント・ページが提示された合計時間。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。 -
TotalTimeDocumentPresented: integer
タイトル:
Total Document Display Duration読取り専用:trueセッション中にドキュメントが提示された合計期間。 -
UpdateFlag: boolean
読取り専用:
true現在のユーザーにフィードバック・レコードを更新する権限があるかどうかを示します。 デフォルト値はtrueです。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- ContactVA
-
担当者を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ContactName;ターゲット属性: ContactName
- 表示属性: ContactName
- PresentationFeedbackRatingVA
-
評点値を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: FeedbackRating;ターゲット属性: RatingValue
- 表示属性: RatingValue、内容
- PresentationSessionVA
-
プレゼンテーション・セッションを示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: SessionDate;ターゲット属性: SessionDate
- 表示属性: SessionDate
- RatedCurrencies
-
USDやGBPなど、組織で使用される通貨コードを示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
- 表示属性: CurrencyCode
- SharedLightboxDocumentVA
-
Sales Lightbox文書を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: DocumentTitle;ターゲット属性: DocumentTitle
- 表示属性: DocumentTitle
例:
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、Lightboxプレゼンテーション・セッション・フィードバック・アイテムを更新する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X PATCH -d @example_request_payload.json ???https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessionFeedback/300100110457882???
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"FeedbackComment": "excellent document",
"FeedbackRating":4
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"SessionFeedbackId": 300100110457882,
"PresentationSessionId": 300100110457468,
"SessionDate": "2017-02-15T16:30:00-08:00",
"ContactId": 300100011501118,
"ContactPartyNumber": "CDRM_2897",
"ContactName": "AFrst8282012101218183692 ALast8282012101218183693",
"ContactTitle": null,
"ContactJobTitle": null,
"LightboxDocumentId": "bc6c78fa-556a-4d31-86c1-0b522f539333",
"FileName": "16x4 Template.pptx",
"DocumentTitle": "16x4 Template",
"PageCount": 7,
"DocumentVersion": "1",
"PageSequenceNumber": 5,
"LightboxDocumentPageId": "19a8ff7d-8126-451d-b9fd-b934e0dfed92",
"PageTitle": "5 of 7",
"FeedbackComment": "excellent document...",
"FeedbackRating": 4,
"ActivityId": 300100110456944,
"ActivitySubject": "Payload Examples",
"AccountId": 1004,
"AccountName": "Hilman and Associates",
"AccountPartyNumber": "1004",
"SessionOwnerId": 100010032752947,
"SessionOwnerName": "Ryan,Katy",
"SessionOwnerEmailAddress": "email@your_organization.com",
"SessionOwnerTitle": null,
"CreatedBy": "KRyan",
"CreationDate": "2017-02-21T01:31:23-08:00",
"LastUpdatedBy": "KRyan",
"LastUpdateDate": "2017-02-21T02:25:36-08:00",
"LastUpdateLogin": "490390FD88674E55E053780CF10ADBC8",
"CurrencyCode": "USD",
"TotalTimeAttendeeViewedDocumentPage": 0,
"TotalTimeAttendeeViewedDocument": 0,
"TotalTimeAttendeeViewedSession": 0,
"TotalTimeDocumentPresented": 0,
"TotalTimeDocumentPagePresented": 0,
"DeleteFlag": true,
"UpdateFlag": true,
"links":
...
}