機械翻訳について

ジャンプ先

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

Lightbox文書ページの更新

patch

/crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}

リクエスト

パス・パラメータ

• LightboxDocumentId(required): string
  Lightbox文書の一意の識別子。
• LightboxDocumentPageId(required): string
  Lightbox文書ページの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• CurrencyCode: string
  タイトル: Currency

  最大長: 15

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

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

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

  最大長: 255

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

  このリソースは、LightboxドキュメントのページがLightboxの外部に表示されるシグナルを表示および作成するために使用されます。
• UpdateFlag: boolean
  レコードを更新できるかどうかを示します。 デフォルト値はtrueです。

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

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

タイプ: array

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

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

ソースを表示

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

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

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

タイプ: array

タイトル: Downloaded-from-cart Signals

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

ソースを表示

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

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

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

タイプ: array

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

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

ソースを表示

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

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

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

タイプ: object

ソースを表示

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

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

タイプ: object

ソースを表示

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

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

タイプ: object

ソースを表示

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

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : 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"
    }
}

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

タイプ: 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-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"
    }
}

リンク

RatedCurrenciesVO

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

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

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

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

pageAddedToCartSignals

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

パラメータ:

• LightboxDocumentId: $request.path.LightboxDocumentId
• LightboxDocumentPageId: $request.path.LightboxDocumentPageId

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

pageDownloadedInCartSignals

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

パラメータ:

• LightboxDocumentId: $request.path.LightboxDocumentId
• LightboxDocumentPageId: $request.path.LightboxDocumentPageId

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

pageViewedOutsideLightboxSignals

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

パラメータ:

• LightboxDocumentId: $request.path.LightboxDocumentId
• LightboxDocumentPageId: $request.path.LightboxDocumentPageId

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

トップに戻る

例:

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

cURLコマンド

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

リクエスト本文の例

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

{
???PageTitle???:???My New Page Title???
}

レスポンス本文の例

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

{
      {
      "LightboxDocumentPageId": "4be54bb2-d827-4438-b7a2-2e0b1dd4423d",
      "PageSequenceNumber": 2,
      "DocumentPageCount": 2,
      "LightboxDocumentRevision": "1",
      "SharedDate": "2016-09-26T08:32:21-07:00",
      "CurrencyCode": "USD",
      "DocumentPageThumbnailURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/tn/UCMFA081778_1_2~.jpg",
      "PageAddedToCartCount": 0,
      "PageDownloadedInCartCount": 0,
      "PageViewedOutsideLightboxCount": 0,
      "CreationDate": "2016-09-26T08:32:20-07:00",
      "CreatedBy": "MHoope",
      "LastUpdateDate": "2016-09-26T08:32:23-07:00",
      "LastUpdatedBy": "MHoope",
      "LastUpdateLogin": "3D66BE490BF85D7DE053DF00F40AC044",
      "DocumentPageImageURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/img/UCMFA081778_1_2-C~.png",
      "DocumentCurrentVersion": "1",
      "PageTitle": ???My New Page Title???,
      "PageDisplayTitle": "2 of 2",
      "SimplePageDisplayTitle": "2 of 2",
      "UpdateFlag": "true",
 ...
    }
}

「トップに戻る」