Jump to

• Request
• Response
• Examples

Create a Lightbox document

post

/crmRestApi/resources/11.13.18.05/lightboxDocuments

Request

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.
• Upsert-Mode:
  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

• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the lightbox document. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• DocumentContents: string (byte)
  The field used to upload and download the document through services.
• documentDownloadSignals: array Lightbox Scoring Signals
  Title: Lightbox Scoring Signals

  The resource is used to view the signals captured when a document is downloaded.
• documentPages: array Lightbox Document Pages
  Title: Lightbox Document Pages

  The Lightbox document page resource is used to view and update the pages within a Lightbox document.
• documentSharedToUserSignals: array Document-shared-with-user Signals
  Title: Document-shared-with-user Signals

  The resource is used to view the signals captured when a document is shared with a user.
• DocumentTitle: string
  Title: Document Title

  Maximum Length: 255

  The title of the document. The default value is the file name without the file extension. You can change the title using the update method.
• documentUnsharedFromUserSignals: array Document-unshared-with-user Signals
  Title: Document-unshared-with-user Signals

  The resource is used to view the signals captured when a document share with a user is deleted.
• documentViewedInLightboxSignals: array Document-Viewed-Within-Lightbox Signals
  Title: Document-Viewed-Within-Lightbox Signals

  The resource is used to view the signals that the document is viewed within Lightbox.
• documentViewedOutsideLightboxSignals: array Document-viewed-outside-Lightbox Signals
  Title: Document-viewed-outside-Lightbox Signals

  The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.
• FileName(required): string
  Title: File Name

  Maximum Length: 1000

  The file name of the document.
• KeyPageSequenceNumber: integer
  Title: Thumbnail Page Number

  The page number of the thumbnail.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• PublicDocumentFlag: boolean
  Title: Public Document

  Maximum Length: 1

  Default Value: false

  Identifies whether a document has been marked as public.
• sharedPersons: array Shared-person Instances
  Title: Shared-person Instances

  The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.

{
    "required":[
        "FileName"
    ],
    "type":"object",
    "properties":{
        "KeyPageSequenceNumber":{
            "title":"Thumbnail Page Number",
            "type":"integer",
            "description":"The page number of the thumbnail.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DocumentDefaultKeyPageSequenceNum",
                    "PersonalKeyPageSequenceNumber",
                    "UserKeyPageSequenceNumber"
                ]
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The file name of the document.",
            "nullable":false
        },
        "PublicDocumentFlag":{
            "title":"Public Document",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies whether a document has been marked as public.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "documentDownloadSignals":{
            "title":"Lightbox Scoring Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when a document is downloaded.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentDownloadSignals-item-post-request"
            }
        },
        "documentUnsharedFromUserSignals":{
            "title":"Document-unshared-with-user Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when a document share with a user is deleted.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentUnsharedFromUserSignals-item-post-request"
            }
        },
        "documentPages":{
            "title":"Lightbox Document Pages",
            "type":"array",
            "description":"The Lightbox document page resource is used to view and update the pages within a Lightbox document.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-item-post-request"
            }
        },
        "documentSharedToUserSignals":{
            "title":"Document-shared-with-user Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when a document is shared with a user.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentSharedToUserSignals-item-post-request"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the lightbox document. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "documentViewedInLightboxSignals":{
            "title":"Document-Viewed-Within-Lightbox Signals",
            "type":"array",
            "description":"The resource is used to view the signals that the document is viewed within Lightbox.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentViewedInLightboxSignals-item-post-request"
            }
        },
        "DocumentContents":{
            "type":"string",
            "description":"The field used to upload and download the document through services.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContentItemId"
                ]
            }
        },
        "sharedPersons":{
            "title":"Shared-person Instances",
            "type":"array",
            "description":"The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-sharedPersons-item-post-request"
            }
        },
        "DocumentTitle":{
            "title":"Document Title",
            "maxLength":"255",
            "type":"string",
            "description":"The title of the document. The default value is the file name without the file extension. You can change the title using the update method.",
            "nullable":true
        },
        "documentViewedOutsideLightboxSignals":{
            "title":"Document-viewed-outside-Lightbox Signals",
            "type":"array",
            "description":"The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentViewedOutsideLightboxSignals-item-post-request"
            }
        }
    }
}

Nested Schema : Lightbox Scoring Signals

Type: array

Title: Lightbox Scoring Signals

The resource is used to view the signals captured when a document is downloaded.

Show Source

• Array of: object lightboxDocuments-documentDownloadSignals-item-post-request

{
    "title":"Lightbox Scoring Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when a document is downloaded.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentDownloadSignals-item-post-request"
    }
}

Nested Schema : Lightbox Document Pages

Type: array

Title: Lightbox Document Pages

The Lightbox document page resource is used to view and update the pages within a Lightbox document.

Show Source

• Array of: object lightboxDocuments-documentPages-item-post-request

{
    "title":"Lightbox Document Pages",
    "type":"array",
    "description":"The Lightbox document page resource is used to view and update the pages within a Lightbox document.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-item-post-request"
    }
}

Nested Schema : Document-shared-with-user Signals

Type: array

Title: Document-shared-with-user Signals

The resource is used to view the signals captured when a document is shared with a user.

Show Source

• Array of: object lightboxDocuments-documentSharedToUserSignals-item-post-request

{
    "title":"Document-shared-with-user Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when a document is shared with a user.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentSharedToUserSignals-item-post-request"
    }
}

Nested Schema : Document-unshared-with-user Signals

Type: array

Title: Document-unshared-with-user Signals

The resource is used to view the signals captured when a document share with a user is deleted.

Show Source

• Array of: object lightboxDocuments-documentUnsharedFromUserSignals-item-post-request

{
    "title":"Document-unshared-with-user Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when a document share with a user is deleted.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentUnsharedFromUserSignals-item-post-request"
    }
}

Nested Schema : Document-Viewed-Within-Lightbox Signals

Type: array

Title: Document-Viewed-Within-Lightbox Signals

The resource is used to view the signals that the document is viewed within Lightbox.

Show Source

• Array of: object lightboxDocuments-documentViewedInLightboxSignals-item-post-request

{
    "title":"Document-Viewed-Within-Lightbox Signals",
    "type":"array",
    "description":"The resource is used to view the signals that the document is viewed within Lightbox.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentViewedInLightboxSignals-item-post-request"
    }
}

Nested Schema : Document-viewed-outside-Lightbox Signals

Type: array

Title: Document-viewed-outside-Lightbox Signals

The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.

Show Source

• Array of: object schema

{
    "title":"Document-viewed-outside-Lightbox Signals",
    "type":"array",
    "description":"The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentViewedOutsideLightboxSignals-item-post-request"
    }
}

Nested Schema : Shared-person Instances

Type: array

Title: Shared-person Instances

The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.

Show Source

• Array of: object schema

{
    "title":"Shared-person Instances",
    "type":"array",
    "description":"The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-sharedPersons-item-post-request"
    }
}

Nested Schema : lightboxDocuments-documentDownloadSignals-item-post-request

Type: object

Show Source

• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentRevision: string
  Title: Version

  Maximum Length: 64

  The current revision of the document.
• LightboxSignalId: integer (int64)
  Title: Lightbox Signal ID

  The unique identifier of the Lightbox document's signal.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : lightboxDocuments-documentPages-item-post-request

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.
• LightboxDocumentPageId: string
  Title: Document Page ID

  Maximum Length: 64

  The unique identifier of the Lightbox document page.
• pageAddedToCartSignals: array Page Added to Cart Signals
  Title: Page Added to Cart Signals
• pageDownloadedInCartSignals: array Page Downloaded in Cart Signals
  Title: Page Downloaded in Cart Signals
• PageSequenceNumber(required): integer (int32)
  Title: Page Sequence Number

  The sequence number of the page in the document.
• PageTitle: string
  Title: Page Title

  Maximum Length: 255

  The title of the page.
• pageViewedOutsideLightboxSignals: array Page Viewed Externally Signals
  Title: Page Viewed Externally Signals
• UpdateFlag: boolean
  Indicates whether the record can be updated. The default value is true.

{
    "required":[
        "PageSequenceNumber"
    ],
    "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"
            }
        },
        "pageViewedOutsideLightboxSignals":{
            "title":"Page Viewed Externally Signals",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-post-request"
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is true.",
            "nullable":true
        },
        "PageTitle":{
            "title":"Page Title",
            "maxLength":"255",
            "type":"string",
            "description":"The title of the page.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DocumentPageCount"
                ]
            }
        },
        "pageAddedToCartSignals":{
            "title":"Page Added to Cart Signals",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageAddedToCartSignals-item-post-request"
            }
        },
        "pageDownloadedInCartSignals":{
            "title":"Page Downloaded in Cart Signals",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-post-request"
            }
        },
        "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"
            }
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page.",
            "nullable":false
        }
    }
}

Nested Schema : Page Added to Cart Signals

Type: array

Title: Page Added to Cart Signals

Show Source

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

{
    "title":"Page Added to Cart Signals",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageAddedToCartSignals-item-post-request"
    }
}

Nested Schema : Page Downloaded in Cart Signals

Type: array

Title: Page Downloaded in Cart Signals

Show Source

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

{
    "title":"Page Downloaded in Cart Signals",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-post-request"
    }
}

Nested Schema : Page Viewed Externally Signals

Type: array

Title: Page Viewed Externally Signals

Show Source

• Array of: object schema

{
    "title":"Page Viewed Externally Signals",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-post-request"
    }
}

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

Type: object

Show Source

• 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.
• 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":{
        "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"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":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"
            }
        }
    }
}

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

Type: object

Show Source

• 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.
• 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":{
        "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"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":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"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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":{
        "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"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":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"
            }
        }
    }
}

Nested Schema : lightboxDocuments-documentSharedToUserSignals-item-post-request

Type: object

Show Source

• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentRevision: string
  Title: Version

  Maximum Length: 64

  The current revision of the document.
• LightboxSignalId: integer (int64)
  Title: Lightbox Signal ID

  The unique identifier of the Lightbox document's signal.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.
• SignalSubjectIdentifier: string
  Title: Party ID

  Maximum Length: 1000

  The unique identifier of the signal's subject.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "SignalSubjectIdentifier":{
            "title":"Party ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the signal's subject.",
            "nullable":false
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : lightboxDocuments-documentUnsharedFromUserSignals-item-post-request

Type: object

Show Source

• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentRevision: string
  Title: Version

  Maximum Length: 64

  The current revision of the document.
• LightboxSignalId: integer (int64)
  Title: Lightbox Signal ID

  The unique identifier of the Lightbox document's signal.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.
• SignalSubjectIdentifier: string
  Title: Party ID

  Maximum Length: 1000

  The subject of the signal.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "SignalSubjectIdentifier":{
            "title":"Party ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The subject of the signal.",
            "nullable":false
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : lightboxDocuments-documentViewedInLightboxSignals-item-post-request

Type: object

Show Source

• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentRevision: string
  Title: Version

  Maximum Length: 64

  The current revision of the document.
• LightboxSignalId: integer (int64)
  Title: Lightbox Signal ID

  The unique identifier of the Lightbox document's signal.
• SignalDate: string (date-time)
  Title: Signal Date

  The sequence number of the page in the document.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The sequence number of the page in the document.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• LightboxDocumentRevision: string
  Title: Version

  Maximum Length: 64

  The current revision of the document.
• LightboxSignalId: integer (int64)
  Title: Lightbox Signal ID

  The unique identifier of the Lightbox document's signal.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The date when the signal was captured.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• IsJointOwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Indicates if the party with whom the document has been shared is one of the owners of the document.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

  The unique identifier of the Lightbox document.
• SharedUserPartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party with whom the document has been shared.

{
    "type":"object",
    "properties":{
        "IsJointOwnerFlag":{
            "title":"Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the party with whom the document has been shared is one of the owners of the document.",
            "nullable":true
        },
        "SharedUserPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party with whom the document has been shared.",
            "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
        }
    }
}

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-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 lightbox document. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• CurrentRevision: string
  Title: Current Version

  Read Only: true

  The current version of the document.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the current user can delete the document. The default value is true.
• DocumentContents: string (byte)
  The field used to upload and download the document through services.
• DocumentDownloadedCount: integer
  Title: Downloads

  Read Only: true

  The number of times the document has been downloaded.
• documentDownloadSignals: array Lightbox Scoring Signals
  Title: Lightbox Scoring Signals

  The resource is used to view the signals captured when a document is downloaded.
• DocumentDownloadURL: string
  Title: Document Download URL

  Read Only: true

  The URL to the document.
• DocumentOwnerFlag: boolean
  Title: Owner

  Read Only: true

  Maximum Length: 1

  Default Value: true

  The owner of the document.
• DocumentPageCount: integer (int32)
  Title: Page Count

  Read Only: true

  Default Value: 0

  The page count of the user.
• documentPages: array Lightbox Document Pages
  Title: Lightbox Document Pages

  The Lightbox document page resource is used to view and update the pages within a Lightbox document.
• DocumentSharedToEntityCount: integer
  Title: Object Shares

  Read Only: true

  The number of times the document has been shared to objects.
• DocumentSharedToUserCount: integer
  Title: User Shares

  Read Only: true

  The number of times the document has been shared to users.
• documentSharedToUserSignals: array Document-shared-with-user Signals
  Title: Document-shared-with-user Signals

  The resource is used to view the signals captured when a document is shared with a user.
• DocumentThumbnailURL: string
  Title: Document Thumbnail URL

  Read Only: true

  The URL to the document thumbnail.
• DocumentTitle: string
  Title: Document Title

  Maximum Length: 255

  The title of the document. The default value is the file name without the file extension. You can change the title using the update method.
• DocumentType: string
  Title: Type Description

  Read Only: true

  The description of the document type.
• DocumentTypeCode: string
  Title: File Type

  Read Only: true

  Maximum Length: 30

  The type of the Lightbox document, for example, Image, PPTX, PDF, Site, etc.
• DocumentUnsharedFromUserCount: integer
  Title: User Share Count Removed

  Read Only: true

  The number of times the document has been unshared from a user.
• documentUnsharedFromUserSignals: array Document-unshared-with-user Signals
  Title: Document-unshared-with-user Signals

  The resource is used to view the signals captured when a document share with a user is deleted.
• DocumentViewedInLightboxCount: integer
  Title: Inside Document Views

  Read Only: true

  The number of times the document has been viewed in Lightbox.
• documentViewedInLightboxSignals: array Document-Viewed-Within-Lightbox Signals
  Title: Document-Viewed-Within-Lightbox Signals

  The resource is used to view the signals that the document is viewed within Lightbox.
• DocumentViewedOutsideLightboxCount: integer
  Title: Outside Document Views

  Read Only: true

  The number of times the document has been viewed outside Lightbox.
• documentViewedOutsideLightboxSignals: array Document-viewed-outside-Lightbox Signals
  Title: Document-viewed-outside-Lightbox Signals

  The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.
• FileName: string
  Title: File Name

  Maximum Length: 1000

  The file name of the document.
• FileSize: integer (int64)
  Title: File Size

  Read Only: true

  Default Value: -1

  The file size of the document.
• IsDocumentReadyFlag: boolean
  Title: Document Ready

  Read Only: true

  Indicates if the document is ready for sharing. The default value is true.
• IsDocumentUploadInProgressFlag: boolean
  Title: Document Upload in Progress

  Read Only: true

  Maximum Length: 1

  Indicates whether a document upload is in progress. You cannot access certain functions during the upload process.
• IsSharedWithCurrentUserFlag: boolean
  Title: Shared with Current User

  Read Only: true

  Maximum Length: 1

  Indicates whether the document is shared with the current user. A document is visible if the current user is an owner or an administrator, or if the document is shared with them or with a subordinate in their organization.
• KeyPageSequenceNumber: integer
  Title: Thumbnail Page Number

  The page number of the 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.
• LightboxDocumentId: string
  Title: Document ID

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• OriginalOwnerEmailAddress: string
  Title: Original Owner Email Address

  Read Only: true

  Maximum Length: 320

  The e-mail address of the employee resource who originally uploaded the Sales Lightbox document.
• OriginalOwnerName: string
  Title: Original Owner Name

  Read Only: true

  Maximum Length: 450

  The name of the employee resource who originally uploaded the document.
• OriginalOwnerPartyId: integer (int64)
  Title: Original Owner Party ID

  Read Only: true

  The unique identifier of the original owner of the document. The original owner is the person who first uploaded the document.
• PublicDocumentDate: string
  Title: Public Document Date

  Read Only: true

  The date when a document was last made public.
• PublicDocumentFlag: boolean
  Title: Public Document

  Maximum Length: 1

  Default Value: false

  Identifies whether a document has been marked as public.
• SharedDate: string (date-time)
  Title: Shared Date

  Read Only: true

  The date when the document was shared.
• sharedPersons: array Shared-person Instances
  Title: Shared-person Instances

  The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.
• Thumbnail: string (byte)
  Read Only: true

  The field used to get the document thumbnail through services.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the record can be updated. The default value is true.
• UploadDate: string (date-time)
  Title: Upload Date

  Read Only: true

  The date when the document was originally shared with the current user, or was last updated. It is used to provide the default sort ordering.

{
    "type":"object",
    "properties":{
        "DocumentViewedInLightboxCount":{
            "title":"Inside Document Views",
            "type":"integer",
            "description":"The number of times the document has been viewed in Lightbox.",
            "nullable":true,
            "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
        },
        "KeyPageSequenceNumber":{
            "title":"Thumbnail Page Number",
            "type":"integer",
            "description":"The page number of the thumbnail.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DocumentDefaultKeyPageSequenceNum",
                    "PersonalKeyPageSequenceNumber",
                    "UserKeyPageSequenceNumber"
                ]
            },
            "x-queryable":true
        },
        "DocumentDownloadURL":{
            "title":"Document Download URL",
            "type":"string",
            "description":"The URL to the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DownloadUrl"
                ]
            },
            "x-queryable":true
        },
        "DocumentViewedOutsideLightboxCount":{
            "title":"Outside Document Views",
            "type":"integer",
            "description":"The number of times the document has been viewed outside Lightbox.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentSharedToUserCount":{
            "title":"User Shares",
            "type":"integer",
            "description":"The number of times the document has been shared to users.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The file name of the document.",
            "nullable":false,
            "x-queryable":true
        },
        "documentDownloadSignals":{
            "title":"Lightbox Scoring Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when a document is downloaded.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentDownloadSignals-item-response"
            }
        },
        "documentUnsharedFromUserSignals":{
            "title":"Document-unshared-with-user Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when a document share with a user is deleted.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentUnsharedFromUserSignals-item-response"
            }
        },
        "Thumbnail":{
            "type":"string",
            "description":"The field used to get the document thumbnail through services.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContentItemId"
                ]
            }
        },
        "documentPages":{
            "title":"Lightbox Document Pages",
            "type":"array",
            "description":"The Lightbox document page resource is used to view and update the pages within a Lightbox document.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentPages-item-response"
            }
        },
        "CurrentRevision":{
            "title":"Current Version",
            "type":"string",
            "description":"The current version of the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentPageCount":{
            "title":"Page Count",
            "type":"integer",
            "description":"The page count of the user.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the lightbox document. 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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentDownloadedCount":{
            "title":"Downloads",
            "type":"integer",
            "description":"The number of times the document has been downloaded.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"File Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the Lightbox document, for example, Image, PPTX, PDF, Site, etc.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentTitle":{
            "title":"Document Title",
            "maxLength":"255",
            "type":"string",
            "description":"The title of the document. The default value is the file name without the file extension. You can change the title using the update method.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSharedWithCurrentUserFlag":{
            "title":"Shared with Current User",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the document is shared with the current user. A document is visible if the current user is an owner or an administrator, or if the document is shared with them or with a subordinate in their organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SharedUserPartyId"
                ]
            },
            "x-queryable":true
        },
        "OriginalOwnerName":{
            "title":"Original Owner Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the employee resource who originally uploaded the document.",
            "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
        },
        "UploadDate":{
            "title":"Upload Date",
            "type":"string",
            "description":"The date when the document was originally shared with the current user, or was last updated. It is used to provide the default sort ordering.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LastUpdateDate",
                    "SharedDate",
                    "PublicDocumentOrderDate"
                ]
            },
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentUnsharedFromUserCount":{
            "title":"User Share Count Removed",
            "type":"integer",
            "description":"The number of times the document has been unshared from a user.",
            "nullable":true,
            "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
        },
        "IsDocumentReadyFlag":{
            "title":"Document Ready",
            "type":"boolean",
            "description":"Indicates if the document is ready for sharing. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DocumentStatusCode"
                ]
            },
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Type Description",
            "type":"string",
            "description":"The description of the document type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DocumentTypeCode"
                ]
            },
            "x-queryable":true
        },
        "PublicDocumentFlag":{
            "title":"Public Document",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies whether a document has been marked as public.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "OriginalOwnerPartyId":{
            "title":"Original Owner Party ID",
            "type":"integer",
            "description":"The unique identifier of the original owner of the document. The original owner is the person who first uploaded the document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PublicDocumentDate":{
            "title":"Public Document Date",
            "type":"string",
            "description":"The date when a document was last made public.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PublicDocumentOrderDate"
                ]
            },
            "x-queryable":true
        },
        "OriginalOwnerEmailAddress":{
            "title":"Original Owner Email Address",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the employee resource who originally uploaded the Sales Lightbox document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "documentSharedToUserSignals":{
            "title":"Document-shared-with-user Signals",
            "type":"array",
            "description":"The resource is used to view the signals captured when a document is shared with a user.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentSharedToUserSignals-item-response"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the current user can delete the document. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DocumentOwnerFlag"
                ]
            }
        },
        "IsDocumentUploadInProgressFlag":{
            "title":"Document Upload in Progress",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a document upload is in progress. You cannot access certain functions during the upload process.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "UploadStatusCode"
                ]
            },
            "x-queryable":true
        },
        "documentViewedInLightboxSignals":{
            "title":"Document-Viewed-Within-Lightbox Signals",
            "type":"array",
            "description":"The resource is used to view the signals that the document is viewed within Lightbox.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentViewedInLightboxSignals-item-response"
            }
        },
        "DocumentSharedToEntityCount":{
            "title":"Object Shares",
            "type":"integer",
            "description":"The number of times the document has been shared to objects.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentContents":{
            "type":"string",
            "description":"The field used to upload and download the document through services.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContentItemId"
                ]
            }
        },
        "DocumentThumbnailURL":{
            "title":"Document Thumbnail URL",
            "type":"string",
            "description":"The URL to the document thumbnail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "KeyPageSequenceNumber",
                    "ThumbnailUrl"
                ]
            },
            "x-queryable":true
        },
        "sharedPersons":{
            "title":"Shared-person Instances",
            "type":"array",
            "description":"The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-sharedPersons-item-response"
            }
        },
        "documentViewedOutsideLightboxSignals":{
            "title":"Document-viewed-outside-Lightbox Signals",
            "type":"array",
            "description":"The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-documentViewedOutsideLightboxSignals-item-response"
            }
        },
        "DocumentOwnerFlag":{
            "title":"Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"The owner of the document.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The file size of the document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"-1",
            "x-hints":{
                "precision":"18"
            },
            "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
        }
    }
}

Nested Schema : Lightbox Scoring Signals

Type: array

Title: Lightbox Scoring Signals

The resource is used to view the signals captured when a document is downloaded.

Show Source

• Array of: object lightboxDocuments-documentDownloadSignals-item-response

{
    "title":"Lightbox Scoring Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when a document is downloaded.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentDownloadSignals-item-response"
    }
}

Nested Schema : Lightbox Document Pages

Type: array

Title: Lightbox Document Pages

The Lightbox document page resource is used to view and update the pages within a Lightbox document.

Show Source

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

{
    "title":"Lightbox Document Pages",
    "type":"array",
    "description":"The Lightbox document page resource is used to view and update the pages within a Lightbox document.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentPages-item-response"
    }
}

Nested Schema : Document-shared-with-user Signals

Type: array

Title: Document-shared-with-user Signals

The resource is used to view the signals captured when a document is shared with a user.

Show Source

• Array of: object lightboxDocuments-documentSharedToUserSignals-item-response

{
    "title":"Document-shared-with-user Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when a document is shared with a user.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentSharedToUserSignals-item-response"
    }
}

Nested Schema : Document-unshared-with-user Signals

Type: array

Title: Document-unshared-with-user Signals

The resource is used to view the signals captured when a document share with a user is deleted.

Show Source

• Array of: object lightboxDocuments-documentUnsharedFromUserSignals-item-response

{
    "title":"Document-unshared-with-user Signals",
    "type":"array",
    "description":"The resource is used to view the signals captured when a document share with a user is deleted.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentUnsharedFromUserSignals-item-response"
    }
}

Nested Schema : Document-Viewed-Within-Lightbox Signals

Type: array

Title: Document-Viewed-Within-Lightbox Signals

The resource is used to view the signals that the document is viewed within Lightbox.

Show Source

• Array of: object lightboxDocuments-documentViewedInLightboxSignals-item-response

{
    "title":"Document-Viewed-Within-Lightbox Signals",
    "type":"array",
    "description":"The resource is used to view the signals that the document is viewed within Lightbox.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentViewedInLightboxSignals-item-response"
    }
}

Nested Schema : Document-viewed-outside-Lightbox Signals

Type: array

Title: Document-viewed-outside-Lightbox Signals

The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.

Show Source

• Array of: object lightboxDocuments-documentViewedOutsideLightboxSignals-item-response

{
    "title":"Document-viewed-outside-Lightbox Signals",
    "type":"array",
    "description":"The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-documentViewedOutsideLightboxSignals-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 : Shared-person Instances

Type: array

Title: Shared-person Instances

The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.

Show Source

• Array of: object lightboxDocuments-sharedPersons-item-response

{
    "title":"Shared-person Instances",
    "type":"array",
    "description":"The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-sharedPersons-item-response"
    }
}

Nested Schema : lightboxDocuments-documentDownloadSignals-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.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.

{
    "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":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
        }
    }
}

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

Nested 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":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
                ]
            }
        },
        "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
        },
        "DocumentPageImageURL":{
            "type":"string",
            "description":"The URL of the high-fidelity page image.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PreviewImageURL"
                ]
            },
            "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
        },
        "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
        },
        "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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is true.",
            "nullable":true,
            "x-queryable":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-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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"
            }
        },
        "SharedDate":{
            "title":"Shared Date",
            "type":"string",
            "description":"The date when the document was shared.",
            "format":"date-time",
            "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
        },
        "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"
                ]
            }
        },
        "PageTitle":{
            "title":"Page Title",
            "maxLength":"255",
            "type":"string",
            "description":"The title of the page.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DocumentPageCount"
                ]
            },
            "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
        },
        "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
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page.",
            "nullable":false,
            "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
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "type":"string",
            "description":"The current version of the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContentItemId"
                ]
            },
            "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
        },
        "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
        }
    }
}

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 : 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":{
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true,
            "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
        },
        "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
        }
    }
}

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":{
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true,
            "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
        },
        "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
        }
    }
}

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":{
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":true,
            "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
        },
        "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
        }
    }
}

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-documentSharedToUserSignals-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.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.
• SignalSubjectIdentifier: string
  Title: Party ID

  Maximum Length: 1000

  The unique identifier of the signal's subject.

{
    "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
        },
        "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
        },
        "SignalSubjectIdentifier":{
            "title":"Party ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The unique identifier of the signal's subject.",
            "nullable":false,
            "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
        },
        "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":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
        }
    }
}

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-documentUnsharedFromUserSignals-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.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.
• SignalSubjectIdentifier: string
  Title: Party ID

  Maximum Length: 1000

  The subject of the signal.

{
    "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
        },
        "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
        },
        "SignalSubjectIdentifier":{
            "title":"Party ID",
            "maxLength":"1000",
            "type":"string",
            "description":"The subject of the signal.",
            "nullable":false,
            "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
        },
        "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":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
        }
    }
}

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-documentViewedInLightboxSignals-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.
• SignalDate: string (date-time)
  Title: Signal Date

  The sequence number of the page in the document.

{
    "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
        },
        "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
        },
        "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
        },
        "SignalDate":{
            "title":"Signal Date",
            "type":"string",
            "description":"The sequence number of the page in the document.",
            "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":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
        }
    }
}

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-documentViewedOutsideLightboxSignals-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.
• SignalDate: string (date-time)
  Title: Signal Date

  The date when the signal was captured.

{
    "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "LightboxDocumentRevision":{
            "title":"Version",
            "maxLength":"64",
            "type":"string",
            "description":"The current revision of the document.",
            "nullable":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
        }
    }
}

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-sharedPersons-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.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the current user has the permission to delete the shared person record.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The email ID of the person with whom the document was shared.
• IsJointOwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Indicates if the party with whom the document has been shared is one of the owners of the document.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the record was last updated.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationName: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  The organization name of the person with whom the document was shared.
• PersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the person with whom the document was shared.
• PersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the person with whom the document was shared.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 450

  The name of the person with whom the document was shared.
• PersonTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The title of the person with whom the document was shared.
• ReportsTo: string
  Title: Manager

  Read Only: true

  Maximum Length: 360

  The manager of the person with whom the document was shared.
• SharedDate: string (date-time)
  Title: Shared Date

  Read Only: true

  The date when the document was shared.
• SharedUserPartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party with whom the document has been shared.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The organization name of the person with whom the document was shared.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the record was last updated.",
            "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
        },
        "PersonName":{
            "title":"Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the person with whom the document was shared.",
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person with whom the document was shared.",
            "nullable":true,
            "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
        },
        "IsJointOwnerFlag":{
            "title":"Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the party with whom the document has been shared is one of the owners of the document.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SharedUserPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party with whom the document has been shared.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email ID of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has the permission to delete the shared person record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DocumentStatusCode",
                    "IsOriginalOwnerRecord",
                    "MyDocumentOwnerFlag",
                    "SharedUserPartyId"
                ]
            }
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportsTo":{
            "title":"Manager",
            "maxLength":"360",
            "type":"string",
            "description":"The manager of the person with whom the document was shared.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the record.",
            "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
        }
    }
}

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

LightboxDocumentTypeVO

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocumentTypesLOV

The list of values indicating the document type.

The following properties are defined on the LOV link relation:

• Source Attribute: DocumentTypeCode; Target Attribute: LightboxDocumentType
• Display Attribute: Meaning

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

YesNoLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

The list of values indicating if the document has been marked as public, such as true or false.

The following properties are defined on the LOV link relation:

• Source Attribute: PublicDocumentFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

documentDownloadSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentDownloadSignals

Parameters:

• LightboxDocumentId: $request.path.LightboxDocumentId

The resource is used to view the signals captured when a document is downloaded.

documentPages

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages

Parameters:

• LightboxDocumentId: $request.path.LightboxDocumentId

The Lightbox document page resource is used to view and update the pages within a Lightbox document.

documentSharedToUserSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentSharedToUserSignals

Parameters:

• LightboxDocumentId: $request.path.LightboxDocumentId

The resource is used to view the signals captured when a document is shared with a user.

documentUnsharedFromUserSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentUnsharedFromUserSignals

Parameters:

• LightboxDocumentId: $request.path.LightboxDocumentId

The resource is used to view the signals captured when a document share with a user is deleted.

documentViewedInLightboxSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedInLightboxSignals

Parameters:

• LightboxDocumentId: $request.path.LightboxDocumentId

The resource is used to view the signals that the document is viewed within Lightbox.

documentViewedOutsideLightboxSignals

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals

Parameters:

• LightboxDocumentId: $request.path.LightboxDocumentId

The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.

sharedPersons

Operation: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons

Parameters:

• LightboxDocumentId: $request.path.LightboxDocumentId

The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.

Back to Top

Examples

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

Create a document placeholder

cURL Command

curl --basic --user user_name:passwd -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d '{"FileName":"16x4 Template.pptx"}' https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.0.0/lightboxDocuments

Example of Request Body

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

{
"FileName":"16x4 Template.pptx"
}

Example of Response Body

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

{
  "LightboxDocumentId": "96f6b368-115c-4e09-8072-d169f332a1b9",
  "DocumentTypeCode": "UNKNOWN",
  "FileName": "16x4 Template.pptx",
  "OriginalOwnerPartyId": 100010037456865,
  "OriginalOwnerName": "Matt Hooper",
  "OriginalOwnerEmailAddress": "sendmail-test-discard@your_org.com",
  "DocumentOwnerFlag": true,
  "CurrentRevision": "0 (Uploading)",
  "KeyPageSequenceNumber": 1,
  "IsDocumentReadyFlag": false,
  "SharedDate": null,
  "CurrencyCode": "USD",
  "DocumentPageCount": 0,
  "DocumentThumbnailURL": "https://servername.fa.us2.oraclecloud.com/crmCommon/images/qual_placeholdergeneric_210.png",
  "FileSize": -1,
  "DocumentDownloadURL": null,
  "DocumentType": "Unknown",
  "DocumentDownloadedCount": 0,
  "DocumentSharedToEntityCount": 0,
  "DocumentSharedToUserCount": 0,
  "DocumentViewedOutsideLightboxCount": 0,
  "DocumentViewedInLightboxCount": 0,
  "DocumentUnsharedFromUserCount": 0,
  "DeleteFlag": true,
  "IsSharedWithCurrentUserFlag": true,
  "IsDocumentUploadInProgressFlag": true,
  "UpdateFlag": false,
  "UploadDate": "2016-10-24T02:22:03-07:00",
  "CreationDate": "2016-10-24T02:22:03-07:00",
  "CreatedBy": "MHoope",
  "LastUpdateDate": "2016-10-24T02:22:03-07:00",
  "LastUpdatedBy": "MHoope",
  "LastUpdateLogin": "3F98DE06736C62FDE053DF00F40A2D76",
  "DocumentTitle": "16x4 Template",
 ...
}

Upload content for document placeholder

cURL Command

curl --basic --user user_name:passwd -H "Content-Type: application/octet-stream" --data-binary @"/path/to/16x4 Template.pptx" -X PUT https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.0.0/lightboxDocuments/{lightboxDocumentID}/enclosure/DocumentContents

Create a Lightbox document with base64-encoded content in the message payload

cURL Command

curl --basic --user user_name:passwd -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST --data-ascii @"/path/to/preparedfile/theSOAEssentialsPDF.json" https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.0.0/lightboxDocuments

Example of Request Body

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

{
"FileName":"The-SOA-Essentials.pdf","DocumentContents":"JVBERi0xLjIgDSXi48/TDQogDTEwIDAgb2JqDTw8DS9MZW5ndGggMTEgMCBSDS9GaWx0ZXIgL0ZsYXRlRGVjb2RlIA0+Pg1zdHJlYW0NCkiJJczBCYAwEATACq6HferDmAtJzreoFVwHAUUhiH5s30TZ37C7o5I4iI/GBUAnsqi5N1C/WDD/vhaHJnTWsJMqDxq00INmpQvEEkz4pjKYUnA81GWMvnDK5W3PjOmkF/t
…"
}

Example of Response Body

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

{
  "LightboxDocumentId": "a2084998-6a97-4d36-87b8-8dec1a7815a7",
  "DocumentTypeCode": "UNKNOWN",
  "FileName": "OMG-and-the-SOA-1.pdf",
  "OriginalOwnerPartyId": 100010034246683,
  "OriginalOwnerName": "Waternoose,Henry",
  "OriginalOwnerEmailAddress": "[e-mail]",
  "DocumentOwnerFlag": true,
  "CurrentRevision": "0 (Uploading)",
  "KeyPageSequenceNumber": 1,
  "IsDocumentReadyFlag": false,
  "SharedDate": null,
  "CurrencyCode": "USD",
  "DocumentPageCount": 0,
  "DocumentThumbnailURL": "https://servername.fa.us2.oraclecloud.com//crmCommon/images/qual_placeholdergeneric_210.png",
  "FileSize": -1,
  "DocumentDownloadURL": null,
  "DocumentType": "Unknown",
  "DocumentDownloadedCount": 0,
  "DocumentSharedToEntityCount": 0,
  "DocumentSharedToUserCount": 0,
  "DocumentViewedOutsideLightboxCount": 0,
  "DocumentViewedInLightboxCount": 0,
  "DocumentUnsharedFromUserCount": 0,
  "DeleteFlag": true,
  "IsSharedWithCurrentUserFlag": true,
  "IsDocumentUploadInProgressFlag": true,
  "UpdateFlag": false,
  "UploadDate": "2016-11-02T00:03:17-07:00",
  "CreationDate": "2016-11-02T00:03:16-07:00",
  "CreatedBy": "HWater",
  "LastUpdateDate": "2016-11-02T00:03:17-07:00",
  "LastUpdatedBy": "HWater",
  "LastUpdateLogin": "401BEDB4B0822D47E053DF00F40A1D0D",
  "DocumentTitle": "OMG-and-the-SOA-1",
 ...
}

Back to Top