Lightboxプレゼンテーション・セッション出席イベントの取得
get
/crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents/{sessionAttendanceEventsUniqID}
リクエスト
パス・パラメータ
- PresentationSessionId(required): string
Lightboxプレゼンテーション・セッションの一意の識別子。
- sessionAttendanceEventsUniqID(required): string
これは、プレゼンテーション・セッション出席イベント・リソースのコンポジット・キーを構成し、プレゼンテーション・セッション出席イベントのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにプレゼンテーション・セッション出席イベント・コレクション・リソースの特定のインスタンスに移動するために、プレゼンテーション・セッション出席イベント・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : presentationSessions-sessionAttendanceEvents-item-response
タイプ:
ソースを表示
object
-
AttendanceEventId: integer (int64)
タイトル:
Attendance Event ID
出席イベントの一意の識別子。 -
AttendanceEventStartTime: string (date-time)
タイトル:
Attendance Event Start Time
出勤イベントの開始時間。 -
AttendanceEventStopTime: string (date-time)
タイトル:
Attendance Event Stop Time
出勤イベントの停止時間。 -
AttendeeId: integer (int64)
タイトル:
Attendee ID
出席者の一意の識別子。 -
ContactId: integer
タイトル:
Contact ID
担当者の一意の識別子。 -
ContactName: string
タイトル:
Contact
読取り専用:true
最大長:450
出席イベントの担当者の名前。 -
ContactPartyNumber: string
タイトル:
Party Number
読取り専用:true
最大長:30
担当者のパーティ番号。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
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
Lightbox文書の一意の識別子。 -
LightboxDocumentPageId: string
タイトル:
Document Page ID
Lightbox文書ページの一意の識別子。 この値は、作成中に指定されていないかぎり、LightboxDocumentId、DocumentVersionおよびPageSequenceNumberから取得されます。 -
LightboxDocumentVersion: string
タイトル:
Version
最大長:64
Lightboxドキュメントのバージョン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PageSequenceNumber: 整数(int32)
タイトル:
Page Sequence Number
Lightbox文書ページのページ順序番号。 -
PresentationSessionId: string
タイトル:
Session ID
最大長:1000
プレゼンテーション・セッションの一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、Lightboxプレゼンテーション・セッション出席イベントを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessions/300100110457468/child/sessionAttendanceEvents/300100110471422
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "AttendanceEventId": 300100110471422, "PresentationSessionId": "300100110457468", "AttendeeId": 300100110457879, "ContactId": 300100049609065, "LightboxDocumentId": "bc6c78fa-556a-4d31-86c1-0b522f539333", "LightboxDocumentPageId": "d1a5d658-49bd-4961-ad3c-4ccfd748bfcd", "LightboxDocumentVersion": "1", "PageSequenceNumber": 4, "AttendanceEventStartTime": "2017-02-20T20:38:09-08:00", "AttendanceEventStopTime": "2017-02-20T20:49:20-08:00", "ContactName": "Nicolas Cage", "ContactPartyNumber": "CDRM_79483", "CreatedBy": "KRyan", "CreationDate": "2017-02-21T02:41:11-08:00", "LastUpdateDate": "2017-02-21T02:41:17-08:00", "LastUpdateLogin": "4904BE299F5E24C4E053780CF10A4363", "LastUpdatedBy": "KRyan", "links": ... } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": ... }