機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. Lightbox文書
  4. Lightbox文書ページ

すべてのLightbox文書ページの取得

get

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

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • CurrentDocumentPagesLOVFinder : LOVファインダによって、ドキュメントの現在のバージョンのドキュメント・ページを検索します。
      ファインダ変数:
      • PrimaryKey : 主キーでLightbox文書ページを検索します。
        ファインダ変数:
        • LightboxDocumentPageId; string; Lightbox文書ページの一意の識別子。
    • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
    • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

      例:
      self,canonical
    • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
    • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
    • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
    • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

      フォーマット : ?q=expression1;expression2

      次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
      • CreatedBy; string; レコードを作成したユーザー。
      • CreationDate; string;レコードが作成された日付。
      • CurrencyCode; string; 文書ページに関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
      • DocumentCurrentVersion; string;文書の現在のバージョン。
      • DocumentPageCount; integer;ドキュメント内のページの合計数。
      • DocumentPageImageURL; string;高い忠実度のページ・イメージのURL。
      • DocumentPageThumbnailURL; string;ドキュメント・ページのサムネイルへのURL。
      • LastUpdateDate; string; レコードが最後に更新された日付。
      • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
      • LastUpdatedBy; string; レコードを最後に更新したユーザー。
      • LightboxDocumentPageId; string; Lightbox文書ページの一意の識別子。
      • LightboxDocumentRevision; string;文書の現在のバージョン。
      • PageAddedToCartCount; integer; Lightboxドキュメントのページがカートに追加された回数。
      • PageDownloadedInCartCount; integer; Lightboxドキュメントのページがカートにダウンロードされた回数。
      • PageSequenceNumber; integer;ドキュメント内のページの順序番号。
      • PageTitle; string;ページのタイトル。
      • PageViewedOutsideLightboxCount; integer;ページがLightbox以外で表示された回数。
      • SharedDate; string;ドキュメントが共有された日付。
      • UpdateFlag; boolean;レコードを更新できるかどうかを示します。 デフォルト値はtrueです。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : lightboxDocuments-documentPages
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : lightboxDocuments-documentPages-item-response
    タイプ: object
    ソースを表示
    ネストされたスキーマ : ページ追加からカートへのシグナル
    タイプ: array
    タイトル: Page-added-to-cart Signals
    リソースは、文書のページがカートに追加されたときに取得されたシグナルを表示するために使用されます。
    ソースを表示
    ネストされたスキーマ : カートからダウンロードしたシグナル
    タイプ: array
    タイトル: Downloaded-from-cart Signals
    リソースは、カート内のページがユーザーによってダウンロードされたときに取得されたシグナルを表示するために使用されます。
    ソースを表示
    ネストされたスキーマ : Page-viewed-outside-Lightboxシグナル
    タイプ: array
    タイトル: Page-viewed-outside-Lightbox Signals
    このリソースは、LightboxドキュメントのページがLightboxの外部に表示されるシグナルを表示および作成するために使用されます。
    ソースを表示
    ネストされたスキーマ : lightboxDocuments-documentPages-pageAddedToCartSignals-item-response
    タイプ: object
    ソースを表示
    ネストされたスキーマ : lightboxDocuments-documentPages-pageDownloadedInCartSignals-item-response
    タイプ: object
    ソースを表示
    ネストされたスキーマ : lightboxDocuments-documentPages-pageViewedOutsideLightboxSignals-item-response
    タイプ: object
    ソースを表示
    トップに戻る

    例:

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

    cURLコマンド

    curl --basic --user user_name:passwd -X GET http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/lightboxDocuments/a801c1fb-bd81-4d4f-a639-9740b72514fc/child/documentPages

    レスポンス本文の例

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

    {
  "items": [
    {
      "LightboxDocumentPageId": "a801c1fb-bd81-4d4f-a639-9740b72514fc",
      "PageSequenceNumber": 1,
      "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_1~.jpg",
      "PageAddedToCartCount": 0,
      "PageDownloadedInCartCount": 0,
      "PageViewedOutsideLightboxCount": 0,
      "CreationDate": "2016-09-26T08:32:20-07:00",
      "CreatedBy": "MHoope",
      "LastUpdateDate": "2016-09-26T08:32:22-07:00",
      "LastUpdatedBy": "MHoope",
      "LastUpdateLogin": "3D66BE490BF85D7DE053DF00F40AC044",
      "DocumentPageImageURL": "https://servername.fa.us2.oraclecloud.com/crmRestApi/lightboxresource/img/UCMFA081778_1_1-C~.png",
      "DocumentCurrentVersion": "1",
      "PageTitle": null,
      "PageDisplayTitle": "1 of 2",
      "SimplePageDisplayTitle": "1 of 2",
      "UpdateFlag": "true",
  ...
    },
    {
      "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": null,
      "PageDisplayTitle": "2 of 2",
      "SimplePageDisplayTitle": "2 of 2",
      "UpdateFlag": "true",
 ...
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
 ...
}
    「トップに戻る」