Jump to

• Request
• Response
• Examples

Create a Lightbox presentation session display event

post

/crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents

Request

Path Parameters

• PresentationSessionId(required): string
  The unique identifier of the Lightbox presentation session.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DisplayEventId: integer (int64)
  Title: Display Event ID

  The unique identifier of the presentation session display event.
• DisplayEventStartTime: string (date-time)
  Title: Display Event Start Time

  The start time for the display event.
• DisplayEventStopTime: string (date-time)
  Title: Display Event Stop Time

  The stop time for the display event.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentPageId: string
  Title: Document Page ID

  The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.
• LightboxDocumentVersion: string
  Title: Version

  Maximum Length: 64

  The version of the Lightbox document.
• PageSequenceNumber: integer (int32)
  Title: Page Sequence Number

  The page sequence number of the Lightbox document page.
• PresentationSessionId: string
  Title: Session ID

  Maximum Length: 1000

  The unique identifier of the presentation session.

{
    "type":"object",
    "properties":{
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true
        },
        "DisplayEventId":{
            "title":"Display Event ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session display event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "DisplayEventStartTime":{
            "title":"Display Event Start Time",
            "type":"string",
            "description":"The start time for the display event.",
            "format":"date-time",
            "nullable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The version of the Lightbox document.",
            "nullable":true
        },
        "DisplayEventStopTime":{
            "title":"Display Event Stop Time",
            "type":"string",
            "description":"The stop time for the display event.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : presentationSessions-sessionDisplayEvents-item-response

Type: object

Show Source

• 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.
• DisplayEventId: integer (int64)
  Title: Display Event ID

  The unique identifier of the presentation session display event.
• DisplayEventStartTime: string (date-time)
  Title: Display Event Start Time

  The start time for the display event.
• DisplayEventStopTime: string (date-time)
  Title: Display Event Stop Time

  The stop time for the display event.
• 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.
• LightboxDocumentPageId: string
  Title: Document Page ID

  The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.
• LightboxDocumentVersion: string
  Title: Version

  Maximum Length: 64

  The version of the Lightbox document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageSequenceNumber: integer (int32)
  Title: Page Sequence Number

  The page sequence number of the Lightbox document page.
• PresentationSessionId: string
  Title: Session ID

  Maximum Length: 1000

  The unique identifier of the presentation session.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "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 Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayEventStartTime":{
            "title":"Display Event Start Time",
            "type":"string",
            "description":"The start time for the display event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayEventStopTime":{
            "title":"Display Event Stop Time",
            "type":"string",
            "description":"The stop time for the display event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayEventId":{
            "title":"Display Event ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session display event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "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
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The version of the Lightbox document.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• 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.

{
    "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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to create a Lightbox presentation session display event by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessions/300100110457468/child/sessionDisplayEvents

Example of Request Body

The following shows an example of the request body in JSON format.

{
"LightboxDocumentId":"bc6c78fa-556a-4d31-86c1-0b522f539333",
"PageSequenceNumber":4,
"DisplayEventStartTime":"2017-02-21T04:08:09",
"DisplayEventStopTime":"2017-02-21T04:59:20"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "DisplayEventId": 300100110471627,
  "PresentationSessionId": "300100110457468",
  "LightboxDocumentId": "bc6c78fa-556a-4d31-86c1-0b522f539333",
  "LightboxDocumentPageId": "d1a5d658-49bd-4961-ad3c-4ccfd748bfcd",
  "LightboxDocumentVersion": "1",
  "PageSequenceNumber": 4,
  "DisplayEventStartTime": "2017-02-20T20:08:09-08:00",
  "DisplayEventStopTime": "2017-02-20T20:59:20-08:00",
  "CreatedBy": "KRyan",
  "CreationDate": "2017-02-21T03:20:21-08:00",
  "LastUpdateDate": "2017-02-21T03:20:21-08:00",
  "LastUpdateLogin": "4904BE299F5E24C4E053780CF10A4363",
  "LastUpdatedBy": "KRyan",
  "links": 
  ...
}

Back to Top