機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

すべてのLightboxドキュメントを入手

get

/crmRestApi/resources/11.13.18.05/lightboxDocuments

リクエスト

問合せパラメータ

• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • LightboxDocumentById : LightboxドキュメントをLightboxDocumentIdで検索します。
    ファインダ変数:
    • LightboxDocumentId; string; Lightbox文書の一意の識別子。
  • MyLightboxDocumentsRF : 現在のユーザーが所有するLightboxドキュメントを検索します。
    ファインダ変数:
  • PrimaryKey : 主キーでLightbox文書を検索します。
    ファインダ変数:
    • LightboxDocumentId; string; Lightbox文書の一意の識別子。
  • SharedLightboxDocumentsRF : 現在のユーザーと共有されているLightboxドキュメントを検索します。
    ファインダ変数:
  • SubordinatesLightboxDocumentsRF : 現在のユーザーまたは部下と共有されているLightbox文書を検索します。
    ファインダ変数:
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • CreatedBy; string; レコードを作成したユーザー。
  • CreationDate; string;レコードが作成された日付。
  • CurrencyCode; string; Lightbox文書に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
  • CurrentRevision; string;文書の現在のバージョン。
  • DocumentDownloadURL; string;ドキュメントへのURL。
  • DocumentDownloadedCount; integer;ドキュメントがダウンロードされた回数。
  • DocumentOwnerFlag; boolean;ドキュメントの所有者。
  • DocumentPageCount; integer;ユーザーのページ数。
  • DocumentSharedToEntityCount; integer;ドキュメントがオブジェクトと共有された回数。
  • DocumentSharedToUserCount; integer;ドキュメントがユーザーに共有された回数。
  • DocumentThumbnailURL; string;文書のサムネイルへのURL。
  • DocumentTitle; string; ドキュメントのタイトル。 デフォルト値は、ファイル拡張子なしのファイル名です。 タイトルは更新メソッドを使用して変更できます。
  • DocumentType; string;ドキュメント・タイプの説明。
  • DocumentTypeCode; string;イメージ、PPTX、PDF、サイトなどのLightbox文書のタイプ。
  • DocumentUnsharedFromUserCount; integer;ドキュメントがユーザーから共有解除された回数。
  • DocumentViewedInLightboxCount; integer;ドキュメントがLightboxで表示された回数。
  • DocumentViewedOutsideLightboxCount; integer;ドキュメントがLightbox以外で表示された回数。
  • FileName; string;ドキュメントのファイル名。
  • FileSize; integer;ドキュメントのファイル・サイズ。
  • IsDocumentReadyFlag; boolean;ドキュメントを共有する準備ができているかどうかを示します。 デフォルト値はtrueです。
  • IsDocumentUploadInProgressFlag; boolean;ドキュメントのアップロードが進行中かどうかを示します。 アップロード・プロセス中は、特定の機能にアクセスできません。
  • IsSharedWithCurrentUserFlag; boolean;ドキュメントが現在のユーザーと共有されるかどうかを示します。 ドキュメントは、現在のユーザーが所有者または管理者である場合、またはドキュメントが自分または自分の組織の部下と共有されている場合に表示されます。
  • KeyPageSequenceNumber; integer;サムネイルのページ番号。
  • LastUpdateDate; string; レコードが最後に更新された日付。
  • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
  • LastUpdatedBy; string; レコードを最後に更新したユーザー。
  • LightboxDocumentId; string; Lightbox文書の一意の識別子。
  • OriginalOwnerEmailAddress; string; Sales Lightbox文書を最初にアップロードした従業員リソースのEメール・アドレス。
  • OriginalOwnerName; string; ドキュメントを最初にアップロードした従業員リソースの名前。
  • OriginalOwnerPartyId; integer; ドキュメントの元の所有者の一意の識別子。 元の所有者は、最初にドキュメントをアップロードしたユーザーです。
  • PublicDocumentDate; string;ドキュメントが最後に公開された日付。
  • PublicDocumentFlag; boolean;ドキュメントがパブリックとしてマークされているかどうかを示します。
  • SharedDate; string;ドキュメントが共有された日付。
  • UploadDate; string;ドキュメントが最初に現在のユーザーと共有された日付、または最後に更新された日付。 デフォルトのソート順序を指定するために使用されます。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : lightboxDocuments

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/lightboxDocuments-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object lightboxDocuments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/lightboxDocuments-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"
    }
}

ネストされたスキーマ : 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"
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのLightboxドキュメントを取得する方法を示しています。

cURLコマンド

curl --basic --user user_name:passwd -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.0.0/lightboxDocuments/

レスポンス本文の例

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

{
  "LightboxDocumentId": "a4aa6826-d372-4a43-8bee-e72fc3390fc3",
  "DocumentTypeCode": "PDF",
  "FileName": "ADF String_Editor.pdf",
  "OriginalOwnerPartyId": 100010025532672,
  "OriginalOwnerName": "Gabrielle   Lee",
  "OriginalOwnerEmailAddress": "sendmail-test-discard@your_org.com",
  "DocumentOwnerFlag": null,
  "CurrentRevision": "1",
  "KeyPageSequenceNumber": 1,
  "IsDocumentReadyFlag": true,
  "SharedDate": null,
  "CurrencyCode": "USD",
  "DocumentPageCount": 6,
  "DocumentThumbnailURL": "https://servername.fa.us2.oraclecloud.com/crmCommon/lightboxresource/tn/UCMFA099819_1_1~.jpg",
  "FileSize": 616768,
  "DocumentDownloadURL": "https://servername.fa.us2.oraclecloud.com/crmCommon/lightboxresource/doc/UCMFA099819~",
  "DocumentType": "PDF",
  "DocumentDownloadedCount": 0,
  "DocumentSharedToEntityCount": 0,
  "DocumentSharedToUserCount": 0,
  "DocumentViewedOutsideLightboxCount": 0,
  "DocumentViewedInLightboxCount": 2,
  "DocumentUnsharedFromUserCount": 0,
  "DeleteFlag": true,
  "IsSharedWithCurrentUserFlag": false,
  "IsDocumentUploadInProgressFlag": false,
  "UpdateFlag": true,
  "UploadDate": "2016-10-19T03:07:32-07:00",
  "CreationDate": "2016-10-19T03:04:26-07:00",
  "CreatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2016-10-19T03:07:32-07:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateLogin": "3F31475A98262516E053DF00F40A5937",
  "DocumentTitle": "MyPDF File",
 .....
    {
  "LightboxDocumentId": "37d01195-acfd-4d5e-887a-587663ba9cf7",
  "DocumentTypeCode": "PDF",
  "FileName": "AllegraFactLabel.pdf",
  "OriginalOwnerPartyId": 100010032752971,
  "OriginalOwnerName": "Calto,John",
  "OriginalOwnerEmailAddress": "sendmail-test-discard@your_org.com",
  "DocumentOwnerFlag": false,
  "CurrentRevision": "1",
  "KeyPageSequenceNumber": 1,
  "IsDocumentReadyFlag": true,
  "SharedDate": "2016-10-19T01:17:11-07:00",
  "CurrencyCode": "USD",
  "DocumentPageCount": 6,
  "DocumentThumbnailURL": "https://servername.fa.us2.oraclecloud.com/crmCommon/lightboxresource/tn/UCMFA092444_1_1~.jpg",
  "FileSize": 1124898,
  "DocumentDownloadURL": "https://servername.fa.us2.oraclecloud.com/crmCommon/lightboxresource/doc/UCMFA092444~",
  "DocumentType": "PDF",
  "DocumentDownloadedCount": 0,
  "DocumentSharedToEntityCount": 1,
  "DocumentSharedToUserCount": 1,
  "DocumentViewedOutsideLightboxCount": 0,
  "DocumentViewedInLightboxCount": 8,
  "DocumentUnsharedFromUserCount": 0,
  "DeleteFlag": true,
  "IsSharedWithCurrentUserFlag": true,
  "IsDocumentUploadInProgressFlag": false,
  "UpdateFlag": true,
  "UploadDate": "2016-10-19T01:17:11-07:00",
  "CreationDate": "2016-10-07T11:54:05-07:00",
  "CreatedBy": "JCalto",
  "LastUpdateDate": "2016-10-07T11:54:43-07:00",
  "LastUpdatedBy": "JCalto",
  "LastUpdateLogin": "3E4B078EF3CA5D9BE053DF00F40AF341",
  "DocumentTitle": "AllegraFactLabel",
....
}

「トップに戻る」