Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

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

get

/crmRestApi/resources/11.13.18.05/presentationSessionFeedback

リクエスト

問合せパラメータ

effectiveDate: string

この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
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>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- AllFeedbackForDocumentRF : Lightbox文書またはその文書内の任意のページのセッション・フィードバックを検索します。
  ファインダ変数:
  - BindDocumentVersion; string;ドキュメントのバージョン。
  - BindLightboxDocumentId; string;ドキュメントの一意の識別子。
- AllPageLevelFeedbackForDocumentRF : Lightbox文書の任意のページのセッション・フィードバックを検索します。
  ファインダ変数:
  - BindDocumentVersion; string;ドキュメントのバージョン。
  - BindLightboxDocumentId; string;ドキュメントの一意の識別子。
- DocumentLevelFeedbackForDocumentRF : Lightbox文書に対して作成されたセッション・フィードバックを検索します。
  ファインダ変数:
  - BindDocumentVersion; string;ドキュメントのバージョン。
  - BindLightboxDocumentId; string;ドキュメントの一意の識別子。
- MyPresentationFeedbackRF : 現在のユーザーが作成したプレゼンテーション・セッションのフィードバックを検索します。
  ファインダ変数:
- PageLevelFeedbackForDocumentPageByIdRF : 一意の文書ページ識別子を持つSales Lightbox文書ページのセッション・フィードバックを検索します。
  ファインダ変数:
  - BindLightboxDocumentPageId; string;ドキュメント・ページの一意の識別子。
- PageLevelFeedbackForDocumentPageRF : 指定した主キー、バージョンおよびページ順序番号を持つSales Lightbox文書ページのセッション・フィードバックを検索します。
  ファインダ変数:
  - BindDocumentVersion; string;ドキュメントのバージョン。
  - BindLightboxDocumentId; string;ドキュメントの一意の識別子。
  - BindPageSequenceNumber; integer;ページ順序番号でセッション・フィードバックを検索します。
- PrimaryKey : 指定された主キーを持つセッション・フィードバックを検索します。
  ファインダ変数:
  - SessionFeedbackId; integer; セッション・フィードバックの一意の識別子。
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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccountId; integer;アカウントの一意の識別子。
- AccountName; string; プレゼンテーション・セッションに関連付けられたアカウントの名前。
- AccountPartyNumber; string; プレゼンテーション・セッションに関連付けられたアカウントのパーティ番号。
- ActivityId; integer;アクティビティの一意の識別子。
- ActivitySubject; string;アクティビティの件名。
- ContactId; integer; フィードバックを提供する担当者の一意の識別子。
- ContactJobTitle; string;フィードバックを提供する担当者のジョブ・タイトル。
- ContactName; string;フィードバックを提供する担当者の名前。
- ContactPartyNumber; string; フィードバックを提供する担当者のパーティ番号。
- ContactTitle; string; フィードバックを提供する担当者のタイトル。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- CurrencyCode; string; プレゼンテーション・セッションのフィードバックに関連付けられた通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
- DocumentTitle; string; Lightboxドキュメントのタイトル。
- DocumentVersion; string;このフィードバックのLightboxドキュメントのバージョン。
- FeedbackComment; string;セッション・フィードバックに関するコメント。
- FeedbackRating; integer;セッション・フィードバックの評価。
- FileName; string; Lightbox文書のファイル名。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- LightboxDocumentId; string; Sales Lightbox文書の一意の識別子。
- LightboxDocumentPageId; string; Lightbox文書ページの一意の識別子。オプションで、LightbocDocumentIdおよびDocumentVersionを使用して、ドキュメント・ページを指定できます。文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
- PageCount; integer; Lightboxドキュメントのページ数。
- PageSequenceNumber; integer; Lightboxドキュメント・ページのページ順序番号。文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
- PageTitle; string; Lightbox文書ページのページ・タイトル。文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
- PresentationSessionId; integer; このフィードバックのプレゼンテーション・セッションの一意の識別子。
- SessionDate; string; プレゼンテーション・セッションが発生した日時。
- SessionFeedbackId; integer; セッション・フィードバックの一意の識別子。
- SessionOwnerEmailAddress; string; プレゼンテーション・セッションの所有者の電子メール・アドレス。
- SessionOwnerId; integer; プレゼンテーション・セッションの所有者の一意の識別子。
- SessionOwnerName; string;プレゼンテーション・セッションの所有者の名前。
- SessionOwnerTitle; string;プレゼンテーション・セッションの所有者のタイトル。
- TotalTimeAttendeeViewedDocument; integer;参加者がLightbox文書を表示した合計期間。
- TotalTimeAttendeeViewedDocumentPage; integer;出席者がドキュメント・ページを表示した合計期間。文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
- TotalTimeAttendeeViewedSession; integer;出席者がセッションを表示した合計期間。
- TotalTimeDocumentPagePresented; integer;セッション中にドキュメント・ページが提示された合計期間。文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
- TotalTimeDocumentPresented; integer;セッション中にドキュメントが提示された合計期間。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : presentationSessionFeedback

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/presentationSessionFeedback-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object presentationSessionFeedback-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/presentationSessionFeedback-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : 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

最大長: 255

Lightbox文書のタイトル。
DocumentVersion: string

タイトル: Version

最大長: 64

このフィードバックのLightbox文書のバージョン。
FeedbackComment: string

タイトル: Comment

最大長: 240

セッション・フィードバックに関するコメント。
FeedbackRating: 整数(int32)

タイトル: Rating

セッション・フィードバックの評価。
FileName: string

タイトル: File Name

読取り専用: true

最大長: 1000

Lightbox文書のファイル名。
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

最大長: 64

Sales Lightbox文書の一意の識別子。
LightboxDocumentPageId: string

タイトル: Document Page ID

最大長: 64

Lightbox文書ページの一意の識別子。オプションで、LightbocDocumentIdおよびDocumentVersionを使用して、ドキュメント・ページを指定できます。文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PageCount: 整数(int32)

タイトル: Page Count

読取り専用: true

デフォルト値: 0

Lightbox文書のページ数。
PageSequenceNumber: 整数(int32)

タイトル: Page Sequence Number

Lightbox文書ページのページ順序番号。文書全体のセッション・フィードバックがリクエストされると、値はNULLになります。
PageTitle: string

タイトル: Page Title

最大長: 255

Lightbox文書ページのページ・タイトル。文書全体のセッション・フィードバックがリクエストされると、値は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です。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":1000,
            "type":"string",
            "description":"The file name of the Lightbox document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact providing the feedback.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactPartyId"
                ]
            },
            "x-queryable":true
        },
        "SessionDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date and time when the presentation session occurred.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the account associated with the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session for this feedback.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency code associated with presentation session feedback. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the contact providing the feedback.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has the permission to update the feedback record. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SessionOwnerId":{
            "title":"Session Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the presentation session.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeedbackComment":{
            "title":"Comment",
            "maxLength":240,
            "type":"string",
            "description":"The comment on the session feedback.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalTimeDocumentPagePresented":{
            "title":"Total Page Display Duration",
            "type":"integer",
            "description":"The total duration for which the document page was presented during a session. The value will be null when the session feedback for the entire document is requested.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalPageDisplayDuration"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentVersion":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The version of the Lightbox document for this feedback.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTitle":{
            "title":"Document Title",
            "maxLength":255,
            "type":"string",
            "description":"The title of the Lightbox document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionFeedbackId":{
            "title":"Feedback ID",
            "type":"integer",
            "description":"The unique identifier of the session feedback.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionOwnerName":{
            "title":"Owner Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the owner of the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Sales Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "SessionOwnerEmailAddress":{
            "title":"Owner Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PageTitle":{
            "title":"Page Title",
            "maxLength":255,
            "type":"string",
            "description":"The page title of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "ContactTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the contact providing the feedback.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivitySubject":{
            "title":"Subject",
            "maxLength":500,
            "type":"string",
            "description":"The subject of the activity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has the permission to delete the feedback record. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the contact providing the feedback.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. Optionally, you can use LightbocDocumentId and DocumentVersion to specify the document page. The value will be null when the session feedback for the entire document is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "PageCount":{
            "title":"Page Count",
            "type":"integer",
            "description":"The page count of the Lightbox document.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TotalTimeAttendeeViewedDocumentPage":{
            "title":"Total Page Attended Duration",
            "type":"integer",
            "description":"The total duration for which the attendee viewed a document page. The value will be null when the session feedback for the entire document is requested.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalAttendeePageDuration"
                ]
            },
            "x-queryable":true
        },
        "TotalTimeAttendeeViewedDocument":{
            "title":"Total Document Attended Duration",
            "type":"integer",
            "description":"The total duration for which the attendee viewed a Lightbox document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalAttendeeDocumentDuration"
                ]
            },
            "x-queryable":true
        },
        "FeedbackRating":{
            "title":"Rating",
            "type":"integer",
            "description":"The rating of the session feedback.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist",
                "precision":5
            },
            "x-queryable":true
        },
        "TotalTimeDocumentPresented":{
            "title":"Total Document Display Duration",
            "type":"integer",
            "description":"The total duration for which the document was presented during a session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalDocumentDisplayDuration"
                ]
            },
            "x-queryable":true
        },
        "TotalTimeAttendeeViewedSession":{
            "title":"Total Session Attended Duration",
            "type":"integer",
            "description":"The total duration for which the attendee viewed the session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalAttendeeDuration"
                ]
            },
            "x-queryable":true
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":450,
            "type":"string",
            "description":"The name of the contact providing the feedback.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "protectionKey":"PersonDEO.PersonName",
                "AttributeType":"Picklist",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AccountName":{
            "title":"Organization Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account associated with the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionOwnerTitle":{
            "title":"Owner Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record 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 of the user who last updated the record.",
            "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リソースに対するGETリクエストを発行することによって、すべてのLightboxプレゼンテーション・セッション・フィードバック・アイテムを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
  "items": [
    {
      "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
    },
    {
      "SessionFeedbackId": 300100110457880,
      "PresentationSessionId": 300100110457468,
      "SessionDate": "2017-02-15T16:30:00-08:00",
      "ContactId": 300100049609065,
      "ContactPartyNumber": "CDRM_79483",
      "ContactName": "Nicolas Cage",
      "ContactTitle": null,
      "ContactJobTitle": null,
      "LightboxDocumentId": "bc6c78fa-556a-4d31-86c1-0b522f539333",
      "FileName": "16x4 Template.pptx",
      "DocumentTitle": "16x4 Template",
      "PageCount": 7,
      "DocumentVersion": "1",
      "PageSequenceNumber": null,
      "LightboxDocumentPageId": null,
      "PageTitle": null,
      "FeedbackComment": "Good document!",
      "FeedbackRating": 3,
      "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:30:29-08:00",
      "LastUpdatedBy": "KRyan",
      "LastUpdateDate": "2017-02-21T01:30:30-08:00",
      "LastUpdateLogin": "490390FD885C4E55E053780CF10ADBC8",
      "CurrencyCode": "USD",
      "TotalTimeAttendeeViewedDocumentPage": 0,
      "TotalTimeAttendeeViewedDocument": 0,
      "TotalTimeAttendeeViewedSession": 0,
      "TotalTimeDocumentPresented": 0,
      "TotalTimeDocumentPagePresented": 0,
      "DeleteFlag": true,
      "UpdateFlag": true
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
}

「トップに戻る」