Get all lightbox presentation session feedback items
get
/crmRestApi/resources/11.13.18.05/presentationSessionFeedback
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- AllFeedbackForDocumentRF: Finds session feedback for a Lightbox document, or for any page within that document.
Finder Variables:- BindDocumentVersion; string; The version of the document.
- BindLightboxDocumentId; string; The unique identifier of the document.
- AllPageLevelFeedbackForDocumentRF: Finds the session feedback for any page of a Lightbox document.
Finder Variables:- BindDocumentVersion; string; The version of the document.
- BindLightboxDocumentId; string; The unique identifier of the document.
- DocumentLevelFeedbackForDocumentRF: Finds the session feedback that was created for a Lightbox document.
Finder Variables:- BindDocumentVersion; string; The version of the document.
- BindLightboxDocumentId; string; The unique identifier of the document.
- MyPresentationFeedbackRF: Find the feedback for any presentation session that was created by the current user.
Finder Variables: - PageLevelFeedbackForDocumentPageByIdRF: Finds the session feedback for a Sales Lightbox document page with the unique document page identifier.
Finder Variables:- BindLightboxDocumentPageId; string; The unique identifier of the document page.
- PageLevelFeedbackForDocumentPageRF: Finds the session feedback for a Sales Lightbox document page with the specified primary key, version, and page sequence number.
Finder Variables:- BindDocumentVersion; string; The version of the document.
- BindLightboxDocumentId; string; The unique identifier of the document.
- BindPageSequenceNumber; integer; Finds the session feedback by the page sequence number.
- PrimaryKey: Finds the session feedback with the specified primary key.
Finder Variables:- SessionFeedbackId; integer; The unique identifier of the session feedback.
- AllFeedbackForDocumentRF: Finds session feedback for a Lightbox document, or for any page within that document.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountId; integer; The unique identifier of the account.
- AccountName; string; The name of the account associated with the presentation session.
- AccountPartyNumber; string; The party number of the account associated with the presentation session.
- ActivityId; integer; The unique identifier of the activity.
- ActivitySubject; string; The subject of the activity.
- ContactId; integer; The unique identifier of the contact providing the feedback.
- ContactJobTitle; string; The job title of the contact providing the feedback.
- ContactName; string; The name of the contact providing the feedback.
- ContactPartyNumber; string; The party number of the contact providing the feedback.
- ContactTitle; string; The title of the contact providing the feedback.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CurrencyCode; string; The currency code associated with presentation session feedback. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
- DocumentTitle; string; The title of the Lightbox document.
- DocumentVersion; string; The version of the Lightbox document for this feedback.
- FeedbackComment; string; The comment on the session feedback.
- FeedbackRating; integer; The rating of the session feedback.
- FileName; string; The file name of the Lightbox document.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- LightboxDocumentId; string; The unique identifier of the Sales Lightbox document.
- LightboxDocumentPageId; string; 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.
- PageCount; integer; The page count of the Lightbox document.
- PageSequenceNumber; integer; The page sequence number of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.
- PageTitle; string; The page title of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.
- PresentationSessionId; integer; The unique identifier of the presentation session for this feedback.
- SessionDate; string; The date and time when the presentation session occurred.
- SessionFeedbackId; integer; The unique identifier of the session feedback.
- SessionOwnerEmailAddress; string; The e-mail address of the owner of the presentation session.
- SessionOwnerId; integer; The unique identifier of the owner of the presentation session.
- SessionOwnerName; string; The name of the owner of the presentation session.
- SessionOwnerTitle; string; The title of the owner of the presentation session.
- TotalTimeAttendeeViewedDocument; integer; The total duration for which the attendee viewed a Lightbox document.
- TotalTimeAttendeeViewedDocumentPage; integer; 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.
- TotalTimeAttendeeViewedSession; integer; The total duration for which the attendee viewed the session.
- TotalTimeDocumentPagePresented; integer; 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.
- TotalTimeDocumentPresented; integer; The total duration for which the document was presented during a session.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are 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 and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : presentationSessionFeedback
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : presentationSessionFeedback-item-response
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account ID
Read Only:true
The unique identifier of the account. -
AccountName: string
Title:
Organization Name
Read Only:true
Maximum Length:360
The name of the account associated with the presentation session. -
AccountPartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The party number of the account associated with the presentation session. -
ActivityId: integer
(int64)
Title:
Activity ID
Read Only:true
The unique identifier of the activity. -
ActivitySubject: string
Title:
Subject
Read Only:true
Maximum Length:500
The subject of the activity. -
ContactId: integer
Title:
Contact ID
The unique identifier of the contact providing the feedback. -
ContactJobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the contact providing the feedback. -
ContactName: string
Title:
Contact
Maximum Length:450
The name of the contact providing the feedback. -
ContactPartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the contact providing the feedback. -
ContactTitle: string
Title:
Title
Read Only:true
Maximum Length:60
The title of the contact providing the feedback. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The currency code associated with presentation session feedback. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
DeleteFlag: boolean
Read Only:
true
Indicates if the current user has the permission to delete the feedback record. The default value is true. -
DocumentTitle: string
Title:
Document Title
Maximum Length:255
The title of the Lightbox document. -
DocumentVersion: string
Title:
Version
Maximum Length:64
The version of the Lightbox document for this feedback. -
FeedbackComment: string
Title:
Comment
Maximum Length:240
The comment on the session feedback. -
FeedbackRating: integer
(int32)
Title:
Rating
The rating of the session feedback. -
FileName: string
Title:
File Name
Read Only:true
Maximum Length:1000
The file name of the Lightbox document. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
LightboxDocumentId: string
Title:
Document ID
Maximum Length:64
The unique identifier of the Sales Lightbox document. -
LightboxDocumentPageId: string
Title:
Document Page ID
Maximum Length:64
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageCount: integer
(int32)
Title:
Page Count
Read Only:true
Default Value:0
The page count of the Lightbox document. -
PageSequenceNumber: integer
(int32)
Title:
Page Sequence Number
The page sequence number of the Lightbox document page. The value will be null when the session feedback for the entire document is requested. -
PageTitle: string
Title:
Page Title
Maximum Length:255
The page title of the Lightbox document page. The value will be null when the session feedback for the entire document is requested. -
PresentationSessionId: integer
(int64)
Title:
Session ID
The unique identifier of the presentation session for this feedback. -
SessionDate: string
(date-time)
Title:
Date and Time
Read Only:true
The date and time when the presentation session occurred. -
SessionFeedbackId: integer
(int64)
Title:
Feedback ID
The unique identifier of the session feedback. -
SessionOwnerEmailAddress: string
Title:
Owner Primary Email
Read Only:true
Maximum Length:320
The e-mail address of the owner of the presentation session. -
SessionOwnerId: integer
(int64)
Title:
Session Owner ID
Read Only:true
The unique identifier of the owner of the presentation session. -
SessionOwnerName: string
Title:
Owner Name
Read Only:true
Maximum Length:360
The name of the owner of the presentation session. -
SessionOwnerTitle: string
Title:
Owner Title
Read Only:true
Maximum Length:60
The title of the owner of the presentation session. -
TotalTimeAttendeeViewedDocument: integer
Title:
Total Document Attended Duration
Read Only:true
The total duration for which the attendee viewed a Lightbox document. -
TotalTimeAttendeeViewedDocumentPage: integer
Title:
Total Page Attended Duration
Read Only:true
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. -
TotalTimeAttendeeViewedSession: integer
Title:
Total Session Attended Duration
Read Only:true
The total duration for which the attendee viewed the session. -
TotalTimeDocumentPagePresented: integer
Title:
Total Page Display Duration
Read Only:true
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. -
TotalTimeDocumentPresented: integer
Title:
Total Document Display Duration
Read Only:true
The total duration for which the document was presented during a session. -
UpdateFlag: boolean
Read Only:
true
Indicates if the current user has the permission to update the feedback record. The default value is true.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to get all lightbox presentation session feedback items by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessionFeedback
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "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": ... }