Get a Lightbox document page
get
/crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}
Request
Path Parameters
-
LightboxDocumentId(required): string
The unique identifier of the Lightbox document.
-
LightboxDocumentPageId(required): string
The unique identifier of the Lightbox document page.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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 : lightboxDocuments-documentPages-item-response
Type:
Show Source
object
-
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:15
The currency code associated with the document pages. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
DocumentCurrentVersion: string
Title:
Current Version
Read Only:true
Maximum Length:30
The current version of the document. -
DocumentPageCount: integer
(int32)
Title:
Page Count
Read Only:true
The total number of pages in the document. -
DocumentPageImageURL: string
Read Only:
true
The URL of the high-fidelity page image. -
DocumentPageThumbnailURL: string
Title:
Document Page Thumbnail URL
Read Only:true
The URL to the document page thumbnail. -
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. -
LightboxDocumentPageId: string
Title:
Document Page ID
Maximum Length:64
The unique identifier of the Lightbox document page. -
LightboxDocumentRevision: string
Title:
Version
Read Only:true
The current version of the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageAddedToCartCount: integer
Title:
Lightbox Document Page Added to Cart Count
Read Only:true
The number of times the page of the Lightbox document has been added to the cart. -
pageAddedToCartSignals: array
Page-added-to-cart Signals
Title:
Page-added-to-cart Signals
The resource is used to view the signals captured when pages of a document are added to cart. -
PageDisplayTitle: string
Title:
Page Display Title
Read Only:true
Maximum Length:255
The page display title consisting of the page number, and either the page title or the total number of pages. -
PageDownloadedInCartCount: integer
Title:
Lightbox Document Page Downloaded to Cart Count
Read Only:true
The number of times the page of the Lightbox document has been downloaded to the cart. -
pageDownloadedInCartSignals: array
Downloaded-from-cart Signals
Title:
Downloaded-from-cart Signals
The resource is used to view the signals captured when pages within a cart are downloaded by the user. -
PageSequenceNumber: integer
(int32)
Title:
Page Sequence Number
The sequence number of the page in the document. -
PageThumbnail: string
(byte)
Read Only:
true
The field used to get the page thumbnail through services. -
PageTitle: string
Title:
Page Title
Maximum Length:255
The title of the page. -
PageViewedOutsideLightboxCount: integer
Title:
Outside Page Views
Read Only:true
The number of times the page was viewed outside Lightbox. -
pageViewedOutsideLightboxSignals: array
Page-viewed-outside-Lightbox Signals
Title:
Page-viewed-outside-Lightbox Signals
The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox. - SharedDate: string (date-time)
-
SimplePageDisplayTitle: string
Title:
Simplified Page Display Title
Read Only:true
Maximum Length:255
The simplified page display title consisting of either the page title, or the page number and the total number of pages. -
UpdateFlag: boolean
Indicates whether the record can be updated. The default value is true.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Page-added-to-cart Signals
Type:
array
Title:
Page-added-to-cart Signals
The resource is used to view the signals captured when pages of a document are added to cart.
Show Source
Nested Schema : Downloaded-from-cart Signals
Type:
array
Title:
Downloaded-from-cart Signals
The resource is used to view the signals captured when pages within a cart are downloaded by the user.
Show Source
Nested Schema : Page-viewed-outside-Lightbox Signals
Type:
array
Title:
Page-viewed-outside-Lightbox Signals
The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox.
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.
Nested Schema : lightboxDocuments-documentPages-pageAddedToCartSignals-item-response
Type:
Show Source
object
-
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. -
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 Lightbox document. -
LightboxDocumentRevision: string
Title:
Version
Maximum Length:64
The current revision of the document. -
LightboxSignalId: integer
(int64)
Title:
Lightbox Signal ID
The unique identifier of the Lightbox document's signal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageSequenceNumber: integer
(int32)
Title:
Page Sequence Number
The sequence number of the page in the document. -
SignalDate: string
(date-time)
Title:
Signal Date
The date when the signal was captured.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-response
Type:
Show Source
object
-
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. -
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 Lightbox document. -
LightboxDocumentRevision: string
Title:
Version
Maximum Length:64
The current revision of the document. -
LightboxSignalId: integer
(int64)
Title:
Lightbox Signal ID
The unique identifier of the Lightbox document's signal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageSequenceNumber: integer
(int32)
Title:
Page Sequence Number
The sequence number of the page in the document. -
SignalDate: string
(date-time)
Title:
Signal Date
The date when the signal was captured.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-response
Type:
Show Source
object
-
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. -
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 Lightbox document. -
LightboxDocumentRevision: string
Title:
Version
Maximum Length:64
The current revision of the document. -
LightboxSignalId: integer
(int64)
Title:
Lightbox Signal ID
The unique identifier of the Lightbox document's signal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageSequenceNumber: integer
(int32)
Title:
Page Sequence Number
The sequence number of the page in the document. -
SignalDate: string
(date-time)
Title:
Signal Date
The date when the signal was captured.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- RatedCurrenciesVO
-
The list of values indicating the currency code used by the organization, such as USD and GBP.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- pageAddedToCartSignals
-
Parameters:
- LightboxDocumentId:
$request.path.LightboxDocumentId
- LightboxDocumentPageId:
$request.path.LightboxDocumentPageId
The resource is used to view the signals captured when pages of a document are added to cart. - LightboxDocumentId:
- pageDownloadedInCartSignals
-
Parameters:
- LightboxDocumentId:
$request.path.LightboxDocumentId
- LightboxDocumentPageId:
$request.path.LightboxDocumentPageId
The resource is used to view the signals captured when pages within a cart are downloaded by the user. - LightboxDocumentId:
- pageViewedOutsideLightboxSignals
-
Parameters:
- LightboxDocumentId:
$request.path.LightboxDocumentId
- LightboxDocumentPageId:
$request.path.LightboxDocumentPageId
The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox. - LightboxDocumentId:
Examples
The following example shows how to get a Lightbox document page of a document by submitting a GET request on the REST resource using cURL.
cURL Command
curl --basic --user user_name:passwd -X
GET http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/lightboxDocuments/{lightboxDocumentID}/child/documentPages/{LightboxDocumentPageId}
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "LightboxDocumentPageId": "4be54bb2-d827-4438-b7a2-2e0b1dd4423d", "PageSequenceNumber": 2, "DocumentPageCount": 2, "LightboxDocumentRevision": "1", "SharedDate": "2016-09-26T08:32:21-07:00", "CurrencyCode": "USD", "DocumentPageThumbnailURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/tn/UCMFA081778_1_2~.jpg", "PageAddedToCartCount": 0, "PageDownloadedInCartCount": 0, "PageViewedOutsideLightboxCount": 0, "CreationDate": "2016-09-26T08:32:20-07:00", "CreatedBy": "MHoope", "LastUpdateDate": "2016-09-26T08:32:23-07:00", "LastUpdatedBy": "MHoope", "LastUpdateLogin": "3D66BE490BF85D7DE053DF00F40AC044", "DocumentPageImageURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/img/UCMFA081778_1_2-C~.png", "DocumentCurrentVersion": "1", "PageTitle": null, "PageDisplayTitle": "2 of 2", "SimplePageDisplayTitle": "2 of 2", "UpdateFlag": "true", ... }