Jump to

• Request
• Response
• Examples

Create a lightbox presentation session feedback item

post

/crmRestApi/resources/11.13.18.05/presentationSessionFeedback

Request

Header Parameters

• Effective-Of: string
  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: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContactId: integer
  Title: Contact ID

  The unique identifier of the contact providing the feedback.
• ContactName: string
  Title: Contact

  Maximum Length: 450

  The name of the contact providing the feedback.
• 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.
• 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.
• 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.
• 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.
• SessionFeedbackId: integer (int64)
  Title: Feedback ID

  The unique identifier of the session feedback.

{
    "type":"object",
    "properties":{
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact providing the feedback.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactPartyId"
                ]
            }
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":450,
            "type":"string",
            "description":"The name of the contact providing the feedback.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "protectionKey":"PersonDEO.PersonName",
                "AttributeType":"Picklist",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency code associated with presentation session feedback. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "DocumentTitle":{
            "title":"Document Title",
            "maxLength":255,
            "type":"string",
            "description":"The title of the Lightbox document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "DocumentVersion":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The version of the Lightbox document for this feedback.",
            "nullable":true
        },
        "FeedbackComment":{
            "title":"Comment",
            "maxLength":240,
            "type":"string",
            "description":"The comment on the session feedback.",
            "nullable":true
        },
        "FeedbackRating":{
            "title":"Rating",
            "type":"integer",
            "description":"The rating of the session feedback.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist",
                "precision":5
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Sales Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "maxLength":64,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PageTitle":{
            "title":"Page Title",
            "maxLength":255,
            "type":"string",
            "description":"The page title of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session for this feedback.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SessionFeedbackId":{
            "title":"Feedback ID",
            "type":"integer",
            "description":"The unique identifier of the session feedback.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : presentationSessionFeedback-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountName":{
            "title":"Organization Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account associated with the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the account associated with the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivitySubject":{
            "title":"Subject",
            "maxLength":500,
            "type":"string",
            "description":"The subject of the activity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact providing the feedback.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactPartyId"
                ]
            },
            "x-queryable":true
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the contact providing the feedback.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":450,
            "type":"string",
            "description":"The name of the contact providing the feedback.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "protectionKey":"PersonDEO.PersonName",
                "AttributeType":"Picklist",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the contact providing the feedback.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the contact providing the feedback.",
            "nullable":true,
            "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency code associated with presentation session feedback. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has the permission to delete the feedback record. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentTitle":{
            "title":"Document Title",
            "maxLength":255,
            "type":"string",
            "description":"The title of the Lightbox document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "DocumentVersion":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The version of the Lightbox document for this feedback.",
            "nullable":true,
            "x-queryable":true
        },
        "FeedbackComment":{
            "title":"Comment",
            "maxLength":240,
            "type":"string",
            "description":"The comment on the session feedback.",
            "nullable":true,
            "x-queryable":true
        },
        "FeedbackRating":{
            "title":"Rating",
            "type":"integer",
            "description":"The rating of the session feedback.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist",
                "precision":5
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":1000,
            "type":"string",
            "description":"The file name of the Lightbox document.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Sales Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "maxLength":64,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PageCount":{
            "title":"Page Count",
            "type":"integer",
            "description":"The page count of the Lightbox document.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PageTitle":{
            "title":"Page Title",
            "maxLength":255,
            "type":"string",
            "description":"The page title of the Lightbox document page. The value will be null when the session feedback for the entire document is requested.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session for this feedback.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionDate":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date and time when the presentation session occurred.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "SessionFeedbackId":{
            "title":"Feedback ID",
            "type":"integer",
            "description":"The unique identifier of the session feedback.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionOwnerEmailAddress":{
            "title":"Owner Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "SessionOwnerId":{
            "title":"Session Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the presentation session.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionOwnerName":{
            "title":"Owner Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the owner of the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionOwnerTitle":{
            "title":"Owner Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalTimeAttendeeViewedDocument":{
            "title":"Total Document Attended Duration",
            "type":"integer",
            "description":"The total duration for which the attendee viewed a Lightbox document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalAttendeeDocumentDuration"
                ]
            },
            "x-queryable":true
        },
        "TotalTimeAttendeeViewedDocumentPage":{
            "title":"Total Page Attended Duration",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalAttendeePageDuration"
                ]
            },
            "x-queryable":true
        },
        "TotalTimeAttendeeViewedSession":{
            "title":"Total Session Attended Duration",
            "type":"integer",
            "description":"The total duration for which the attendee viewed the session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalAttendeeDuration"
                ]
            },
            "x-queryable":true
        },
        "TotalTimeDocumentPagePresented":{
            "title":"Total Page Display Duration",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalPageDisplayDuration"
                ]
            },
            "x-queryable":true
        },
        "TotalTimeDocumentPresented":{
            "title":"Total Document Display Duration",
            "type":"integer",
            "description":"The total duration for which the document was presented during a session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TotalDocumentDisplayDuration"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has the permission to update the feedback record. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

ContactVA

Operation: /crmRestApi/resources/11.13.18.05/contacts

The list of values indicating the contact person.

The following properties are defined on the LOV link relation:

• Source Attribute: ContactName; Target Attribute: ContactName
• Display Attribute: ContactName

PresentationFeedbackRatingVA

Operation: /crmRestApi/resources/11.13.18.05/feedbackRatingsLOV

The list of values indicating the rating value.

The following properties are defined on the LOV link relation:

• Source Attribute: FeedbackRating; Target Attribute: RatingValue
• Display Attribute: RatingValue, Meaning

PresentationSessionVA

Operation: /crmRestApi/resources/11.13.18.05/presentationSessions

The list of values indicating the presentation session.

The following properties are defined on the LOV link relation:

• Source Attribute: SessionDate; Target Attribute: SessionDate
• Display Attribute: SessionDate

RatedCurrencies

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

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

SharedLightboxDocumentVA

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments

The list of values indicating the Sales Lightbox document.

The following properties are defined on the LOV link relation:

• Source Attribute: DocumentTitle; Target Attribute: DocumentTitle
• Display Attribute: DocumentTitle

Back to Top

Examples

The following example shows how to create a lightbox presentation session feedback item by submitting a POST request on the REST resource using cURL.

Create a lightbox presentation session feedback for a Lightbox document

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/presentationSessionFeedback

Example of Request Body

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

{
"PresentationSessionId":300100110457468,
"ContactId":300100049609065,
"LightboxDocumentId":"bc6c78fa-556a-4d31-86c1-0b522f539333",
"FeedbackRating":"3",
"FeedbackComment":"Good document!"
}

Example of Response Body

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

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

Create a lightbox presentation session feedback for a Lightbox document page

cURL Command

curl --basic --user user_name:passwd -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessionFeedback

Example of Request Body

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

{
"PresentationSessionId":300100110457468,
"ContactId":300100011501118,
"LightboxDocumentPageId":"19a8ff7d-8126-451d-b9fd-b934e0dfed92",
"FeedbackComment":"excellent diagram",
"FeedbackRating":"4"
}

Example of Response Body

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

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

Back to Top