Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

Lightbox文書の更新

patch

/crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}

リクエスト

パス・パラメータ

LightboxDocumentId(required): string

Lightbox文書の一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

CurrencyCode: string

タイトル: Currency

最大長: 15

LightBox文書に関連付けられた通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
DocumentContents: 文字列(バイト)

サービスを介してドキュメントをアップロードおよびダウンロードするために使用するフィールド。
documentDownloadSignals: array Lightbox Scoring Signals

タイトル: Lightbox Scoring Signals

リソースは、ドキュメントのダウンロード時に取得されたシグナルを表示するために使用されます。
documentPages: array Lightbox Document Pages

タイトル: Lightbox Document Pages

Lightbox文書ページ・リソースは、Lightbox文書内のページを表示および更新するために使用します。
documentSharedToUserSignals: array Document-shared-with-user Signals

タイトル: Document-shared-with-user Signals

リソースは、ドキュメントがユーザーと共有されるときに取得されるシグナルを表示するために使用されます。
DocumentTitle: string

タイトル: Document Title

最大長: 255

ドキュメントのタイトル。デフォルト値は、ファイル拡張子なしのファイル名です。タイトルは更新メソッドを使用して変更できます。
documentUnsharedFromUserSignals: array Document-unshared-with-user Signals

タイトル: Document-unshared-with-user Signals

リソースは、ユーザーとのドキュメント共有が削除されたときに取得されたシグナルを表示するために使用されます。
documentViewedInLightboxSignals: array Document-Viewed-Within-Lightbox Signals

タイトル: Document-Viewed-Within-Lightbox Signals

リソースは、文書がLightbox内で表示されるシグナルを表示するために使用されます。
documentViewedOutsideLightboxSignals: array Document-viewed-outside-Lightbox Signals

タイトル: Document-viewed-outside-Lightbox Signals

リソースは、Lightbox外部のプロセスによってドキュメントが表示されたときに取得されるシグナルを表示および作成するために使用されます。
KeyPageSequenceNumber: integer

タイトル: Thumbnail Page Number

サムネイルのページ番号。
PublicDocumentFlag: boolean

タイトル: Public Document

最大長: 1

デフォルト値: false

ドキュメントが公開としてマークされているかどうかを示します。
sharedPersons: array Shared-person Instances

タイトル: Shared-person Instances

共有個人リソースは、文書共有の表示、作成および削除に使用されます。文書共有を使用すると、Lightbox文書を別のユーザーと共有できます。

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "KeyPageSequenceNumber":{
            "title":"Thumbnail Page Number",
            "type":"integer",
            "description":"The page number of the thumbnail.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DocumentDefaultKeyPageSequenceNum",
                    "PersonalKeyPageSequenceNumber",
                    "UserKeyPageSequenceNumber"
                ]
            }
        },
        "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-patch-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"
                ]
            }
        },
        "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-patch-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-patch-request"
            }
        },
        "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-patch-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
        },
        "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-patch-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-patch-request"
            }
        },
        "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-patch-request"
            }
        }
    }
}

ネストされたスキーマ : Lightboxスコアリング・シグナル

タイプ: array

タイトル: Lightbox Scoring Signals

リソースは、ドキュメントのダウンロード時に取得されたシグナルを表示するために使用されます。

ソースを表示

Array of: object lightboxDocuments-documentDownloadSignals-item-patch-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-patch-request"
    }
}

ネストされたスキーマ : Lightbox文書ページ

タイプ: array

タイトル: Lightbox Document Pages

Lightbox文書ページ・リソースは、Lightbox文書内のページを表示および更新するために使用します。

ソースを表示

Array of: object lightboxDocuments-documentPages-item-patch-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-patch-request"
    }
}

ネストされたスキーマ : 文書共有ユーザー・シグナル

タイプ: array

タイトル: Document-shared-with-user Signals

リソースは、ドキュメントがユーザーと共有されるときに取得されるシグナルを表示するために使用されます。

ソースを表示

Array of: object lightboxDocuments-documentSharedToUserSignals-item-patch-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-patch-request"
    }
}

ネストされたスキーマ : 文書非共有ユーザー・シグナル

タイプ: array

タイトル: Document-unshared-with-user Signals

リソースは、ユーザーとのドキュメント共有が削除されたときに取得されたシグナルを表示するために使用されます。

ソースを表示

Array of: object lightboxDocuments-documentUnsharedFromUserSignals-item-patch-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-patch-request"
    }
}

ネストされたスキーマ : Document-Viewed-Within-Lightboxシグナルを表示

タイプ: array

タイトル: Document-Viewed-Within-Lightbox Signals

リソースは、文書がLightbox内で表示されるシグナルを表示するために使用されます。

ソースを表示

Array of: object lightboxDocuments-documentViewedInLightboxSignals-item-patch-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-patch-request"
    }
}

ネストされたスキーマ : Document-viewed-outside-Lightboxシグナル

タイプ: array

タイトル: Document-viewed-outside-Lightbox Signals

リソースは、Lightbox外部のプロセスによってドキュメントが表示されたときに取得されるシグナルを表示および作成するために使用されます。

ソースを表示

Array of: object lightboxDocuments-documentViewedOutsideLightboxSignals-item-patch-request

{
    "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-patch-request"
    }
}

ネストされたスキーマ : 共有個人インスタンス

タイプ: array

タイトル: Shared-person Instances

共有個人リソースは、文書共有の表示、作成および削除に使用されます。文書共有を使用すると、Lightbox文書を別のユーザーと共有できます。

ソースを表示

Array of: object lightboxDocuments-sharedPersons-item-patch-request

{
    "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-patch-request"
    }
}

ネストされたスキーマ : lightboxDocuments-documentDownloadSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentPages-item-patch-request

タイプ: object

ソースを表示

CurrencyCode: string

タイトル: Currency

最大長: 15

記入票ページに関連付けられた通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
pageAddedToCartSignals: array Page-added-to-cart Signals

タイトル: Page-added-to-cart Signals

リソースは、文書のページがカートに追加されたときに取得されたシグナルを表示するために使用されます。
pageDownloadedInCartSignals: array Downloaded-from-cart Signals

タイトル: Downloaded-from-cart Signals

リソースは、カート内のページがユーザーによってダウンロードされたときに取得されたシグナルを表示するために使用されます。
PageTitle: string

タイトル: Page Title

最大長: 255

ページのタイトル。
pageViewedOutsideLightboxSignals: array Page-viewed-outside-Lightbox Signals

タイトル: Page-viewed-outside-Lightbox Signals

このリソースは、LightboxドキュメントのページがLightboxの外部に表示されるシグナルを表示および作成するために使用されます。
UpdateFlag: boolean

レコードを更新できるかどうかを示します。デフォルト値はtrueです。

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

ネストされたスキーマ : ページ追加からカートへのシグナル

タイプ: array

タイトル: Page-added-to-cart Signals

リソースは、文書のページがカートに追加されたときに取得されたシグナルを表示するために使用されます。

ソースを表示

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

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

ネストされたスキーマ : カートからダウンロードしたシグナル

タイプ: array

タイトル: Downloaded-from-cart Signals

リソースは、カート内のページがユーザーによってダウンロードされたときに取得されたシグナルを表示するために使用されます。

ソースを表示

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

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

ネストされたスキーマ : Page-viewed-outside-Lightboxシグナル

タイプ: array

タイトル: Page-viewed-outside-Lightbox Signals

このリソースは、LightboxドキュメントのページがLightboxの外部に表示されるシグナルを表示および作成するために使用されます。

ソースを表示

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

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

ネストされたスキーマ : lightboxDocuments-documentPages-pageAddedToCartSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentSharedToUserSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentUnsharedFromUserSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentViewedInLightboxSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentViewedOutsideLightboxSignals-item-patch-request

タイプ: object

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-sharedPersons-item-patch-request

タイプ: object

ソースを表示

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

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : lightboxDocuments-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
CurrencyCode: string

タイトル: Currency

最大長: 15

LightBox文書に関連付けられた通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
CurrentRevision: string

タイトル: Current Version

読取り専用: true

ドキュメントの現在のバージョン。
DeleteFlag: boolean

読取り専用: true

現在のユーザーが文書を削除できるかどうかを示します。デフォルト値はtrueです。
DocumentContents: 文字列(バイト)

サービスを介してドキュメントをアップロードおよびダウンロードするために使用するフィールド。
DocumentDownloadedCount: integer

タイトル: Downloads

読取り専用: true

ドキュメントがダウンロードされた回数。
documentDownloadSignals: array Lightbox Scoring Signals

タイトル: Lightbox Scoring Signals

リソースは、ドキュメントのダウンロード時に取得されたシグナルを表示するために使用されます。
DocumentDownloadURL: string

タイトル: Document Download URL

読取り専用: true

ドキュメントへのURL。
DocumentOwnerFlag: boolean

タイトル: Owner

読取り専用: true

最大長: 1

デフォルト値: true

ドキュメントの所有者。
DocumentPageCount: 整数(int32)

タイトル: Page Count

読取り専用: true

デフォルト値: 0

ユーザーのページ数。
documentPages: array Lightbox Document Pages

タイトル: Lightbox Document Pages

Lightbox文書ページ・リソースは、Lightbox文書内のページを表示および更新するために使用します。
DocumentSharedToEntityCount: integer

タイトル: Object Shares

読取り専用: true

ドキュメントがオブジェクトと共有された回数。
DocumentSharedToUserCount: integer

タイトル: User Shares

読取り専用: true

ドキュメントがユーザーに共有された回数。
documentSharedToUserSignals: array Document-shared-with-user Signals

タイトル: Document-shared-with-user Signals

リソースは、ドキュメントがユーザーと共有されるときに取得されるシグナルを表示するために使用されます。
DocumentThumbnailURL: string

タイトル: Document Thumbnail URL

読取り専用: true

ドキュメントのサムネイルへのURL。
DocumentTitle: string

タイトル: Document Title

最大長: 255

ドキュメントのタイトル。デフォルト値は、ファイル拡張子なしのファイル名です。タイトルは更新メソッドを使用して変更できます。
DocumentType: string

タイトル: Type Description

読取り専用: true

文書タイプの摘要。
DocumentTypeCode: string

タイトル: File Type

読取り専用: true

最大長: 30

Lightbox文書のタイプ。たとえば、イメージ、PPTX、PDF、サイトなどです。
DocumentUnsharedFromUserCount: integer

タイトル: User Share Count Removed

読取り専用: true

ドキュメントがユーザーから共有解除された回数。
documentUnsharedFromUserSignals: array Document-unshared-with-user Signals

タイトル: Document-unshared-with-user Signals

リソースは、ユーザーとのドキュメント共有が削除されたときに取得されたシグナルを表示するために使用されます。
DocumentViewedInLightboxCount: integer

タイトル: Inside Document Views

読取り専用: true

Lightboxで文書が閲覧された回数。
documentViewedInLightboxSignals: array Document-Viewed-Within-Lightbox Signals

タイトル: Document-Viewed-Within-Lightbox Signals

リソースは、文書がLightbox内で表示されるシグナルを表示するために使用されます。
DocumentViewedOutsideLightboxCount: integer

タイトル: Outside Document Views

読取り専用: true

Lightbox外部で文書が閲覧された回数。
documentViewedOutsideLightboxSignals: array Document-viewed-outside-Lightbox Signals

タイトル: Document-viewed-outside-Lightbox Signals

リソースは、Lightbox外部のプロセスによってドキュメントが表示されたときに取得されるシグナルを表示および作成するために使用されます。
FileName: string

タイトル: File Name

最大長: 1000

ドキュメントのファイル名。
FileSize: integer (int64)

タイトル: File Size

読取り専用: true

デフォルト値: -1

ドキュメントのファイル・サイズ。
IsDocumentReadyFlag: boolean

タイトル: Document Ready

読取り専用: true

文書を共有する準備ができているかどうかを示します。デフォルト値はtrueです。
IsDocumentUploadInProgressFlag: boolean

タイトル: Document Upload in Progress

読取り専用: true

最大長: 1

ドキュメントのアップロードが進行中かどうかを示します。アップロード・プロセス中は、特定の機能にアクセスできません。
IsSharedWithCurrentUserFlag: boolean

タイトル: Shared with Current User

読取り専用: true

最大長: 1

文書が現在のユーザーと共有されるかどうかを示します。ドキュメントは、現在のユーザーが所有者または管理者である場合、またはドキュメントが自分または自分の組織の部下と共有されている場合に表示されます。
KeyPageSequenceNumber: integer

タイトル: Thumbnail Page Number

サムネイルのページ番号。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OriginalOwnerEmailAddress: string

タイトル: Original Owner Email Address

読取り専用: true

最大長: 320

Sales Lightbox文書を最初にアップロードした従業員リソースのEメール・アドレス。
OriginalOwnerName: string

タイトル: Original Owner Name

読取り専用: true

最大長: 450

文書を最初にアップロードした従業員リソースの名前。
OriginalOwnerPartyId: integer (int64)

タイトル: Original Owner Party ID

読取り専用: true

ドキュメントの元の所有者の一意の識別子。元の所有者は、最初にドキュメントをアップロードしたユーザーです。
PublicDocumentDate: string

タイトル: Public Document Date

読取り専用: true

文書が最後に公開された日付。
PublicDocumentFlag: boolean

タイトル: Public Document

最大長: 1

デフォルト値: false

ドキュメントが公開としてマークされているかどうかを示します。
SharedDate: string (date-time)

タイトル: Shared Date

読取り専用: true

文書が共有された日付。
sharedPersons: array Shared-person Instances

タイトル: Shared-person Instances

共有個人リソースは、文書共有の表示、作成および削除に使用されます。文書共有を使用すると、Lightbox文書を別のユーザーと共有できます。
サムネイル: 文字列(バイト)

読取り専用: true

サービスを介した文書サムネイルの取得に使用されるフィールド。
UpdateFlag: boolean

読取り専用: true

レコードを更新できるかどうかを示します。デフォルト値はtrueです。
UploadDate: string (date-time)

タイトル: Upload Date

読取り専用: true

ドキュメントが最初に現在のユーザーと共有された日付、または最後に更新された日付。デフォルトのソート順序を指定するために使用されます。

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

ネストされたスキーマ : Lightboxスコアリング・シグナル

タイプ: array

タイトル: Lightbox Scoring Signals

リソースは、ドキュメントのダウンロード時に取得されたシグナルを表示するために使用されます。

ソースを表示

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

ネストされたスキーマ : Lightbox文書ページ

タイプ: array

タイトル: Lightbox Document Pages

Lightbox文書ページ・リソースは、Lightbox文書内のページを表示および更新するために使用します。

ソースを表示

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

ネストされたスキーマ : 文書共有ユーザー・シグナル

タイプ: array

タイトル: Document-shared-with-user Signals

リソースは、ドキュメントがユーザーと共有されるときに取得されるシグナルを表示するために使用されます。

ソースを表示

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

ネストされたスキーマ : 文書非共有ユーザー・シグナル

タイプ: array

タイトル: Document-unshared-with-user Signals

リソースは、ユーザーとのドキュメント共有が削除されたときに取得されたシグナルを表示するために使用されます。

ソースを表示

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

ネストされたスキーマ : Document-Viewed-Within-Lightboxシグナルを表示

タイプ: array

タイトル: Document-Viewed-Within-Lightbox Signals

リソースは、文書がLightbox内で表示されるシグナルを表示するために使用されます。

ソースを表示

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

ネストされたスキーマ : Document-viewed-outside-Lightboxシグナル

タイプ: array

タイトル: Document-viewed-outside-Lightbox Signals

リソースは、Lightbox外部のプロセスによってドキュメントが表示されたときに取得されるシグナルを表示および作成するために使用されます。

ソースを表示

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : 共有個人インスタンス

タイプ: array

タイトル: Shared-person Instances

共有個人リソースは、文書共有の表示、作成および削除に使用されます。文書共有を使用すると、Lightbox文書を別のユーザーと共有できます。

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentDownloadSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SignalDate: string (date-time)

タイトル: Signal Date

シグナルが取得された日付。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

ネストされたスキーマ : lightboxDocuments-documentPages-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
CurrencyCode: string

タイトル: Currency

最大長: 15

記入票ページに関連付けられた通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
DocumentCurrentVersion: string

タイトル: Current Version

読取り専用: true

最大長: 30

ドキュメントの現在のバージョン。
DocumentPageCount: 整数(int32)

タイトル: Page Count

読取り専用: true

ドキュメント内のページの合計数。
DocumentPageImageURL: string

読取り専用: true

忠実度の高いページ・イメージのURL。
DocumentPageThumbnailURL: string

タイトル: Document Page Thumbnail URL

読取り専用: true

ドキュメント・ページのサムネイルへのURL。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentPageId: string

タイトル: Document Page ID

最大長: 64

Lightbox文書ページの一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

読取り専用: true

ドキュメントの現在のバージョン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PageAddedToCartCount: integer

タイトル: Lightbox Document Page Added to Cart Count

読取り専用: true

Lightbox文書のページがカートに追加された回数。
pageAddedToCartSignals: array Page-added-to-cart Signals

タイトル: Page-added-to-cart Signals

リソースは、文書のページがカートに追加されたときに取得されたシグナルを表示するために使用されます。
PageDisplayTitle: string

タイトル: Page Display Title

読取り専用: true

最大長: 255

ページ表示タイトルは、ページ番号と、ページ・タイトルまたはページ合計数で構成されます。
PageDownloadedInCartCount: integer

タイトル: Lightbox Document Page Downloaded to Cart Count

読取り専用: true

Lightbox文書のページがカートにダウンロードされた回数。
pageDownloadedInCartSignals: array Downloaded-from-cart Signals

タイトル: Downloaded-from-cart Signals

リソースは、カート内のページがユーザーによってダウンロードされたときに取得されたシグナルを表示するために使用されます。
PageSequenceNumber: 整数(int32)

タイトル: Page Sequence Number

文書内のページの連番。
PageThumbnail: 文字列(バイト)

読取り専用: true

サービスを介したページ・サムネイルの取得に使用されるフィールド。
PageTitle: string

タイトル: Page Title

最大長: 255

ページのタイトル。
PageViewedOutsideLightboxCount: integer

タイトル: Outside Page Views

読取り専用: true

Lightbox外部でページが表示された回数。
pageViewedOutsideLightboxSignals: array Page-viewed-outside-Lightbox Signals

タイトル: Page-viewed-outside-Lightbox Signals

このリソースは、LightboxドキュメントのページがLightboxの外部に表示されるシグナルを表示および作成するために使用されます。
SharedDate: string (date-time)

タイトル: Shared Date

読取り専用: true

文書が共有された日付。
SimplePageDisplayTitle: string

タイトル: Simplified Page Display Title

読取り専用: true

最大長: 255

ページ・タイトルまたはページ番号と合計ページ数で構成される簡易ページ表示タイトル。
UpdateFlag: boolean

レコードを更新できるかどうかを示します。デフォルト値は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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : ページ追加からカートへのシグナル

タイプ: array

タイトル: Page-added-to-cart Signals

リソースは、文書のページがカートに追加されたときに取得されたシグナルを表示するために使用されます。

ソースを表示

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

ネストされたスキーマ : カートからダウンロードしたシグナル

タイプ: array

タイトル: Downloaded-from-cart Signals

リソースは、カート内のページがユーザーによってダウンロードされたときに取得されたシグナルを表示するために使用されます。

ソースを表示

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

ネストされたスキーマ : Page-viewed-outside-Lightboxシグナル

タイプ: array

タイトル: Page-viewed-outside-Lightbox Signals

このリソースは、LightboxドキュメントのページがLightboxの外部に表示されるシグナルを表示および作成するために使用されます。

ソースを表示

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

ネストされたスキーマ : lightboxDocuments-documentPages-pageAddedToCartSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PageSequenceNumber: 整数(int32)

タイトル: Page Sequence Number

文書内のページの連番。
SignalDate: string (date-time)

タイトル: Signal Date

シグナルが取得された日付。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PageSequenceNumber: 整数(int32)

タイトル: Page Sequence Number

文書内のページの連番。
SignalDate: string (date-time)

タイトル: Signal Date

シグナルが取得された日付。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PageSequenceNumber: 整数(int32)

タイトル: Page Sequence Number

文書内のページの連番。
SignalDate: string (date-time)

タイトル: Signal Date

シグナルが取得された日付。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : lightboxDocuments-documentSharedToUserSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SignalDate: string (date-time)

タイトル: Signal Date

シグナルが取得された日付。
SignalSubjectIdentifier: string

タイトル: Party ID

最大長: 1000

シグナルのサブジェクトの一意の識別子。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : lightboxDocuments-documentUnsharedFromUserSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SignalDate: string (date-time)

タイトル: Signal Date

シグナルが取得された日付。
SignalSubjectIdentifier: string

タイトル: Party ID

最大長: 1000

信号の件名。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : lightboxDocuments-documentViewedInLightboxSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SignalDate: string (date-time)

タイトル: Signal Date

文書内のページの連番。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : lightboxDocuments-documentViewedOutsideLightboxSignals-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
LightboxDocumentRevision: string

タイトル: Version

最大長: 64

ドキュメントの現在のリビジョン。
LightboxSignalId: integer (int64)

タイトル: Lightbox Signal ID

Lightbox文書のシグナルの一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SignalDate: string (date-time)

タイトル: Signal Date

シグナルが取得された日付。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : lightboxDocuments-sharedPersons-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DeleteFlag: boolean

読取り専用: true

現在のユーザーに共有個人レコードを削除する権限があるかどうかを示します。
EmailAddress: string

タイトル: Primary Email

読取り専用: true

最大長: 320

文書が共有された個人のEメールID。
IsJointOwnerFlag: boolean

タイトル: Owner

最大長: 1

文書が共有されたパーティが文書の所有者の1人であるかどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

レコードを最後に更新したユーザー。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードが最後に更新された日付。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OrganizationName: string

タイトル: Organization

読取り専用: true

最大長: 240

文書が共有された個人の組織名。
PersonFirstName: string

タイトル: First Name

読取り専用: true

最大長: 150

文書が共有された個人の名。
PersonLastName: string

タイトル: Last Name

読取り専用: true

最大長: 150

文書が共有された個人の姓。
PersonName: string

タイトル: Name

読取り専用: true

最大長: 450

文書が共有された個人の名前。
PersonTitle: string

タイトル: Title

読取り専用: true

最大長: 60

文書が共有された個人のタイトル。
ReportsTo: string

タイトル: Manager

読取り専用: true

最大長: 360

文書が共有された個人のマネージャ。
SharedDate: string (date-time)

タイトル: Shared Date

読取り専用: true

文書が共有された日付。
SharedUserPartyId: integer (int64)

タイトル: Party ID

文書が共有されたパーティの一意の識別子。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

リンク

LightboxDocumentTypeVO

操作: /crmRestApi/resources/11.13.18.05/lightboxDocumentTypesLOV

文書タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: DocumentTypeCode;ターゲット属性: LightboxDocumentType
表示属性: 意味

RatedCurrenciesVO

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

USDやGBPなど、組織で使用される通貨コードを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
表示属性: CurrencyCode

YesNoLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

文書が公開としてマークされたかどうかを示す値リスト(trueまたはfalseなど)。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: PublicDocumentFlag;ターゲット属性: LookupCode
表示属性: 意味

documentDownloadSignals

操作: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentDownloadSignals

パラメータ:

LightboxDocumentId: $request.path.LightboxDocumentId

リソースは、ドキュメントのダウンロード時に取得されたシグナルを表示するために使用されます。

documentPages

操作: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages

パラメータ:

LightboxDocumentId: $request.path.LightboxDocumentId

Lightbox文書ページ・リソースは、Lightbox文書内のページを表示および更新するために使用します。

documentSharedToUserSignals

操作: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentSharedToUserSignals

パラメータ:

LightboxDocumentId: $request.path.LightboxDocumentId

リソースは、ドキュメントがユーザーと共有されるときに取得されるシグナルを表示するために使用されます。

documentUnsharedFromUserSignals

操作: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentUnsharedFromUserSignals

パラメータ:

LightboxDocumentId: $request.path.LightboxDocumentId

リソースは、ユーザーとのドキュメント共有が削除されたときに取得されたシグナルを表示するために使用されます。

documentViewedInLightboxSignals

操作: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedInLightboxSignals

パラメータ:

LightboxDocumentId: $request.path.LightboxDocumentId

リソースは、文書がLightbox内で表示されるシグナルを表示するために使用されます。

documentViewedOutsideLightboxSignals

操作: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals

パラメータ:

LightboxDocumentId: $request.path.LightboxDocumentId

リソースは、Lightbox外部のプロセスによってドキュメントが表示されたときに取得されるシグナルを表示および作成するために使用されます。

sharedPersons

操作: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons

パラメータ:

LightboxDocumentId: $request.path.LightboxDocumentId

共有個人リソースは、文書共有の表示、作成および削除に使用されます。文書共有を使用すると、Lightbox文書を別のユーザーと共有できます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行してLightboxドキュメントを更新する方法を示しています。

cURLコマンド

curl --basic --user user_name:passwd -H "Content-Type: application/octet-stream" --request PATCH --data-binary @"/path/to/input/binaryFile.pptx" "http://servername.fa.us2.oraclecloud.com /crmRestApi/resources/11.13.18.05/lightboxDocuments/{lightboxDocumentID}/enclosure/DocumentContents???

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "LightboxDocumentId": "e8c92910-9a95-4060-a205-dcdcb5ebf3e9",
  "DocumentTypeCode": "PDF",
  "FileName": "ADF String_Editor.pdf",
  "OriginalOwnerPartyId": 100010037456865,
  "OriginalOwnerName": "Matt Hooper",
  "OriginalOwnerEmailAddress": "sendmail-test-discard@your_org.com???,
  "DocumentOwnerFlag": true,
  "CurrentRevision": "3 (Uploading)",
  "KeyPageSequenceNumber": 1,
  "IsDocumentReadyFlag": true,
  "SharedDate": "2016-10-24T04:47:51-07:00",
  "CurrencyCode": "USD",
  "DocumentPageCount": 2,
  "DocumentThumbnailURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/tn/UCMFA092457_2_1~.jpg",
  "FileSize": 100302,
  "DocumentDownloadURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/doc/UCMFA092457~",
  "DocumentType": "PDF",
  "DocumentDownloadedCount": 0,
  "DocumentSharedToEntityCount": 0,
  "DocumentSharedToUserCount": 0,
  "DocumentViewedOutsideLightboxCount": 0,
  "DocumentViewedInLightboxCount": 0,
  "DocumentUnsharedFromUserCount": 0,
  "DeleteFlag": true,
  "IsSharedWithCurrentUserFlag": true,
  "IsDocumentUploadInProgressFlag": true,
  "UpdateFlag": false,
  "UploadDate": "2016-10-24T04:47:51-07:00",
  "CreationDate": "2016-10-07T12:03:11-07:00",
  "CreatedBy": "MHoope",
  "LastUpdateDate": "2016-10-26T04:47:53-07:00",
  "LastUpdatedBy": "MHoope",
  "LastUpdateLogin": "3FC090BE9CDC68AAE053DF00F40A57E0",
  "DocumentTitle": "ADF String_Editor",
 ...
}

cURLコマンド

Lightbox文書のプロパティの更新

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、Lightboxドキュメントのプロパティを更新する方法を示しています。

curl --basic --user user_name:passwd -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" --request PATCH ?d ???{???DocumentTitle???:???My New Title???}??? "http://servername.fa.us2.oraclecloud.com /crmRestApi/resources/11.13.18.05/lightboxDocuments/{lightboxDocumentID}???

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
???DocumentTitle???:???My New Title???
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "LightboxDocumentId": "e8c92910-9a95-4060-a205-dcdcb5ebf3e9",
  "DocumentTypeCode": "PDF",
  "FileName": "ADF String_Editor.pdf",
  "OriginalOwnerPartyId": 100010037456865,
  "OriginalOwnerName": "Matt Hooper",
  "OriginalOwnerEmailAddress": "sendmail-test-discard@your_org.com???,
  "DocumentOwnerFlag": true,
  "CurrentRevision": "3 (Uploading)",
  "KeyPageSequenceNumber": 1,
  "IsDocumentReadyFlag": true,
  "SharedDate": "2016-10-24T04:47:51-07:00",
  "CurrencyCode": "USD",
  "DocumentPageCount": 2,
  "DocumentThumbnailURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/tn/UCMFA092457_2_1~.jpg",
  "FileSize": 100302,
  "DocumentDownloadURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/doc/UCMFA092457~",
  "DocumentType": "PDF",
  "DocumentDownloadedCount": 0,
  "DocumentSharedToEntityCount": 0,
  "DocumentSharedToUserCount": 0,
  "DocumentViewedOutsideLightboxCount": 0,
  "DocumentViewedInLightboxCount": 0,
  "DocumentUnsharedFromUserCount": 0,
  "DeleteFlag": true,
  "IsSharedWithCurrentUserFlag": true,
  "IsDocumentUploadInProgressFlag": true,
  "UpdateFlag": false,
  "UploadDate": "2016-10-24T04:47:51-07:00",
  "CreationDate": "2016-10-07T12:03:11-07:00",
  "CreatedBy": "MHoope",
  "LastUpdateDate": "2016-10-26T04:47:53-07:00",
  "LastUpdatedBy": "MHoope",
  "LastUpdateLogin": "3FC090BE9CDC68AAE053DF00F40A57E0",
  "DocumentTitle": "My New Title",
 ...
}

「トップに戻る」