機械翻訳について

LightBoxプレゼンテーション・セッション・フィードバック・アイテムを取得

get

/crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}

リクエスト

パス・パラメータ
  • これは、Lightboxプレゼンテーション・セッション・フィードバック・リソースのコンポジット・キーを構成する属性のハッシュ・キーで、Lightboxプレゼンテーション・セッション・フィードバックのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはLightboxプレゼンテーション・セッション・フィードバックの特定のインスタンスに移動してハッシュ・キーを取得するために、Lightboxプレゼンテーション・セッション・フィードバック・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、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の値は、解析時に正の整数が生成されるように文字列である必要があります。
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : presentationSessionFeedback-item-response
タイプ: object
ソースを表示
  • タイトル: Account ID
    読取り専用: true
    アカウントの一意の識別子。
  • タイトル: Organization Name
    読取り専用: true
    最大長: 360
    プレゼンテーション・セッションに関連付けられているアカウントの名前。
  • タイトル: Registry ID
    読取り専用: true
    最大長: 30
    プレゼンテーション・セッションに関連付けられたアカウントのパーティ番号。
  • タイトル: Activity ID
    読取り専用: true
    アクティビティの一意の識別子。
  • タイトル: Subject
    読取り専用: true
    最大長: 500
    アクティビティの件名。
  • タイトル: Contact ID
    フィードバックを提供する担当者の一意の識別子。
  • タイトル: Job Title
    読取り専用: true
    最大長: 100
    フィードバックを提供する担当者のジョブ・タイトル。
  • タイトル: Contact
    最大長: 450
    フィードバックを提供する担当者の名前。
  • タイトル: Party Number
    読取り専用: true
    最大長: 30
    フィードバックを提供する担当者のパーティ番号。
  • タイトル: Title
    読取り専用: true
    最大長: 60
    フィードバックを提供する担当者のタイトル。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Currency
    最大長: 30
    プレゼンテーション・セッション・フィードバックに関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
  • 読取り専用: true
    現在のユーザーにフィードバック・レコードを削除する権限があるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Document Title
    最大長: 255
    Lightbox文書のタイトル。
  • タイトル: Version
    最大長: 64
    このフィードバックのLightbox文書のバージョン。
  • タイトル: Comment
    最大長: 240
    セッション・フィードバックに関するコメント。
  • タイトル: Rating
    セッション・フィードバックの評価。
  • タイトル: File Name
    読取り専用: true
    最大長: 1000
    Lightbox文書のファイル名。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • タイトル: Document ID
    最大長: 64
    Sales Lightbox文書の一意の識別子。
  • タイトル: Document Page ID
    最大長: 64
    Lightbox文書ページの一意の識別子。 オプションで、LightbocDocumentIdおよびDocumentVersionを使用して、ドキュメント・ページを指定できます。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
  • Links
  • タイトル: Page Count
    読取り専用: true
    デフォルト値: 0
    Lightbox文書のページ数。
  • タイトル: Page Sequence Number
    Lightbox文書ページのページ順序番号。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
  • タイトル: Page Title
    最大長: 255
    Lightbox文書ページのページ・タイトル。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
  • タイトル: Session ID
    このフィードバックのプレゼンテーション・セッションの一意の識別子。
  • タイトル: Date and Time
    読取り専用: true
    プレゼンテーション・セッションが発生した日時。
  • タイトル: Feedback ID
    セッション・フィードバックの一意の識別子。
  • タイトル: Owner Primary Email
    読取り専用: true
    最大長: 320
    プレゼンテーション・セッションの所有者の電子メール・アドレス。
  • タイトル: Session Owner ID
    読取り専用: true
    プレゼンテーション・セッションの所有者の一意の識別子。
  • タイトル: Owner Name
    読取り専用: true
    最大長: 360
    プレゼンテーション・セッションの所有者の名前。
  • タイトル: Owner Title
    読取り専用: true
    最大長: 60
    プレゼンテーション・セッションの所有者のタイトル。
  • タイトル: Total Document Attended Duration
    読取り専用: true
    参加者がLightbox文書を表示した合計期間。
  • タイトル: Total Page Attended Duration
    読取り専用: true
    出席者がドキュメント・ページを表示した合計期間。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
  • タイトル: Total Session Attended Duration
    読取り専用: true
    参加者がセッションを表示した合計期間。
  • タイトル: Total Page Display Duration
    読取り専用: true
    セッション中にドキュメント・ページが提示された合計時間。 文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
  • タイトル: Total Document Display Duration
    読取り専用: true
    セッション中にドキュメントが提示された合計期間。
  • 読取り専用: true
    現在のユーザーにフィードバック・レコードを更新する権限があるかどうかを示します。 デフォルト値はtrueです。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、Lightboxプレゼンテーション・セッション・フィードバック・アイテムを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessionFeedback/300100110457882

レスポンス本文の例

次の例は、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 diagram",
  "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-21T01:31:23-08:00",
  "LastUpdateLogin": "490390FD885C4E55E053780CF10ADBC8",
  "CurrencyCode": "USD",
  "TotalTimeAttendeeViewedDocumentPage": 0,
  "TotalTimeAttendeeViewedDocument": 0,
  "TotalTimeAttendeeViewedSession": 0,
  "TotalTimeDocumentPresented": 0,
  "TotalTimeDocumentPagePresented": 0,
  "DeleteFlag": true,
  "UpdateFlag": true,
  "links": 
  ...
}
「トップに戻る」