Create a document-viewed-outside-Lightbox signal for a document
post
/crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals
Request
Path Parameters
-
LightboxDocumentId(required): string
The unique identifier of the Lightbox document.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
SignalDate: string
(date-time)
Title:
Signal Date
The date when the signal was captured.
Response
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-documentViewedOutsideLightboxSignals-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. -
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 : 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 create a document-viewed-outside-Lightbox signal for a document by submitting a POST request on the REST resource using cURL.
cURL Command
curl --basic --user user_name:passwd -H
"Content-Type: application/vnd.oracle.adf.resourceitem+json" -X
POST -d '{}' http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/lightboxDocuments/{lightboxDocumentID}/child/documentViewedOutsideLightboxSignals
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "LightboxDocumentId": "c8d23da1-587b-44f6-b35d-c43145eb19aa", "LightboxDocumentRevision": "1", "LightboxSignalId": 300100116964681, "SignalDate": null, "CreationDate": "2016-10-27T02:51:49-07:00", "CreatedBy": "MHoope", "LastUpdateDate": "2016-10-27T02:51:49-07:00", "LastUpdatedBy": "MHoope", "LastUpdateLogin": "3FD1C116587A04E3E053DF00F40AB442", ... }