Jump to

• Request
• Response
• Examples

Update a Lightbox document page

patch

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

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• PageTitle: string
  Title: Page Title

  Maximum Length: 255

  The title of the page.
• 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.
• UpdateFlag: boolean
  Indicates whether the record can be updated. The default value is true.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the document pages. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "PageTitle":{
            "title":"Page Title",
            "maxLength":255,
            "type":"string",
            "description":"The title of the page.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DocumentPageCount"
                ]
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is true.",
            "nullable":true
        },
        "pageAddedToCartSignals":{
            "title":"Page-added-to-cart Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when pages of a document are added to cart.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageAddedToCartSignals-item-patch-request"
            }
        },
        "pageDownloadedInCartSignals":{
            "title":"Downloaded-from-cart Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when pages within a cart are downloaded by the user.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-patch-request"
            }
        },
        "pageViewedOutsideLightboxSignals":{
            "title":"Page-viewed-outside-Lightbox Signals",
            "type":"array",
            "description":"The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-patch-request"
            }
        }
    }
}

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

• Array of: object lightboxDocuments-documentPages-pageAddedToCartSignals-item-patch-request

{
    "title":"Page-added-to-cart Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when pages of a document are added to cart.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageAddedToCartSignals-item-patch-request"
    }
}

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

• Array of: object lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-patch-request

{
    "title":"Downloaded-from-cart Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when pages within a cart are downloaded by the user.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-patch-request"
    }
}

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

• Array of: object lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-patch-request

{
    "title":"Page-viewed-outside-Lightbox Signals",
    "type":"array",
    "description":"The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-patch-request"
    }
}

Nested Schema : lightboxDocuments-documentPages-pageAddedToCartSignals-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : lightboxDocuments-documentPages-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.
• 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)
  Title: Shared Date

  Read Only: true

  The date when the document was shared.
• 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.

{
    "type":"object",
    "properties":{
        "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":15,
            "type":"string",
            "description":"The currency code associated with the document pages. 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
        },
        "DocumentCurrentVersion":{
            "title":"Current Version",
            "maxLength":30,
            "type":"string",
            "description":"The current version of the document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentPageCount":{
            "title":"Page Count",
            "type":"integer",
            "description":"The total number of pages in the document.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9,
                "dependencies":[
                    "DocumentVersion"
                ]
            },
            "x-queryable":true
        },
        "DocumentPageImageURL":{
            "type":"string",
            "description":"The URL of the high-fidelity page image.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PreviewImageURL"
                ]
            },
            "x-queryable":true
        },
        "DocumentPageThumbnailURL":{
            "title":"Document Page Thumbnail URL",
            "type":"string",
            "description":"The URL to the document page thumbnail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PageThumbnailUrl"
                ]
            },
            "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
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Lightbox document page.",
            "nullable":false,
            "x-queryable":true
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "type":"string",
            "description":"The current version of the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContentItemId"
                ]
            },
            "x-queryable":true
        },
        "PageAddedToCartCount":{
            "title":"Lightbox Document Page Added to Cart Count",
            "type":"integer",
            "description":"The number of times the page of the Lightbox document has been added to the cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PageDisplayTitle":{
            "title":"Page Display Title",
            "maxLength":255,
            "type":"string",
            "description":"The page display title consisting of the page number, and either the page title or the total number of pages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DocumentPageCount",
                    "PageSequenceNumber",
                    "PageTitle"
                ]
            }
        },
        "PageDownloadedInCartCount":{
            "title":"Lightbox Document Page Downloaded to Cart Count",
            "type":"integer",
            "description":"The number of times the page of the Lightbox document has been downloaded to the cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The sequence number of the page in the document.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PageThumbnail":{
            "type":"string",
            "description":"The field used to get the page thumbnail through services.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContentItemId"
                ]
            }
        },
        "PageTitle":{
            "title":"Page Title",
            "maxLength":255,
            "type":"string",
            "description":"The title of the page.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DocumentPageCount"
                ]
            },
            "x-queryable":true
        },
        "PageViewedOutsideLightboxCount":{
            "title":"Outside Page Views",
            "type":"integer",
            "description":"The number of times the page was viewed outside Lightbox.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SharedDate":{
            "title":"Shared Date",
            "type":"string",
            "description":"The date when the document was shared.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimplePageDisplayTitle":{
            "title":"Simplified Page Display Title",
            "maxLength":255,
            "type":"string",
            "description":"The simplified page display title consisting of either the page title, or the page number and the total number of pages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DocumentPageCount",
                    "PageDisplayTitle",
                    "PageTitle"
                ]
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "pageAddedToCartSignals":{
            "title":"Page-added-to-cart Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when pages of a document are added to cart.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageAddedToCartSignals-item-response"
            }
        },
        "pageDownloadedInCartSignals":{
            "title":"Downloaded-from-cart Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when pages within a cart are downloaded by the user.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-response"
            }
        },
        "pageViewedOutsideLightboxSignals":{
            "title":"Page-viewed-outside-Lightbox Signals",
            "type":"array",
            "description":"The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-response"
            }
        }
    }
}

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 : 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

• Array of: object lightboxDocuments-documentPages-pageAddedToCartSignals-item-response

{
    "title":"Page-added-to-cart Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when pages of a document are added to cart.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageAddedToCartSignals-item-response"
    }
}

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

• Array of: object lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-response

{
    "title":"Downloaded-from-cart Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when pages within a cart are downloaded by the user.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-response"
    }
}

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

• Array of: object lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-response

{
    "title":"Page-viewed-outside-Lightbox Signals",
    "type":"array",
    "description":"The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-response"
    }
}

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

Nested Schema : lightboxDocuments-documentPages-pageAddedToCartSignals-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.
• 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.

{
    "type":"object",
    "properties":{
        "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
        },
        "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 Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true,
            "x-queryable":true
        },
        "LightboxSignalId":{
            "title":"Lightbox Signal ID",
            "type":"integer",
            "description":"The unique identifier of the Lightbox document's signal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The sequence number of the page in the document.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "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 : lightboxDocuments-documentPages-pageDownloadedInCartSignals-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.
• 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.

{
    "type":"object",
    "properties":{
        "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
        },
        "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 Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true,
            "x-queryable":true
        },
        "LightboxSignalId":{
            "title":"Lightbox Signal ID",
            "type":"integer",
            "description":"The unique identifier of the Lightbox document's signal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The sequence number of the page in the document.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "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 : lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-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.
• 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.

{
    "type":"object",
    "properties":{
        "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
        },
        "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 Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true,
            "x-queryable":true
        },
        "LightboxSignalId":{
            "title":"Lightbox Signal ID",
            "type":"integer",
            "description":"The unique identifier of the Lightbox document's signal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The sequence number of the page in the document.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "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"
    }
}

Links

RatedCurrenciesVO

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

pageAddedToCartSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/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.

pageDownloadedInCartSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/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.

pageViewedOutsideLightboxSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/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.

Back to Top

Examples

The following example shows how to update properties of a Lightbox document page by submitting a PATCH 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 PATCH -d ‘{“PageTitle”:”My New Page Title”}’ http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/lightboxDocuments/{lightboxDocumentID}/child/documentPages/{documentPageID}

Example of Request Body

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

{
“PageTitle”:”My New Page Title”
}

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": “My New Page Title”,
      "PageDisplayTitle": "2 of 2",
      "SimplePageDisplayTitle": "2 of 2",
      "UpdateFlag": "true",
 ...
    }
}

Back to Top