機械翻訳について

テンプレートのイメージの一覧表示

get

/sites/management/api/v1/templates/{id}/images

COLLECTION

テンプレートに関連付けられたサムネイルおよびプレビュー・イメージをリストします。 テンプレート・イメージには、必須のサムネイル・イメージおよび追加のプレビュー・イメージのオプション・セットが含まれます。 これらのイメージは、ユーザーが選択するテンプレートのリストを表示する際に使用でき、サイトがどのように表示されるかを示します。 デフォルトのソート順では、作成日によってイメージが昇順で表示され、最も古いものが最初に表示されます。

パス代替識別子

「テンプレート」リソースのデフォルトの識別子は、「テンプレート識別子」です。 テンプレート・リソースは代替識別子をサポートしています。

nameテンプレート名

テンプレート識別子のかわりに、テンプレート名を使用してリソース・パスでテンプレートを一意に識別できます。 テンプレートのデフォルトのリソース・パス・パラメータはテンプレート識別子ですが、テンプレートでの作業時には、判読可能なテンプレート名が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo/images

リリース19.4.1.での導入。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK - List the Template Images

テンプレートには、プライマリ・サムネイル・イメージが1つと、3つまでのプレビュー・サムネイル・イメージがあります。 レスポンスにリンクは含まれません。

リクエスト

GET https://api.example.com/sites/management/api/v1/templates/{id}/images?links=none

レスポンス本文

{
  "hasMore": false,
  "items": [
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543593693",
        "imageType": "thumbnail"
      },
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F53C0F71A6486C299A98F57C9AF14F3D4CB1C0F3C73F&dRevLabel=3&noSaveAs=1",
        "imageType": "preview"
      },
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F6A7AB65AF31C573457EA63F4E5FCE0654CE4B094E00&dRevLabel=3&noSaveAs=1",
        "imageType": "preview"
      },
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:FCF4875E7D15182738AD4EF4818C818AFA91FD27F465&dRevLabel=3&noSaveAs=1",
        "imageType": "preview"
      }
  ]
}

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

404Not Found - Template Not Found

サイト・テンプレートが存在しないか、削除されたか、認証済ユーザーまたはクライアント・アプリケーションがテンプレートへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009000

解決 - 識別子のチェック

テンプレート識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証済ユーザーがテンプレートのメンバーまたはサイト管理者であることを確認してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
template存在しないか、認証されたユーザーに表示されないテンプレート。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのTemplateNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Not Found",
  "status": "404",
  "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
  "o:errorCode": "OCE-SITEMGMT-009000",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

リクエスト

パス・パラメータ
問合せパラメータ
  • レスポンスに使用しないフィールド名のカンマ区切り文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。 コレクションのフィールドを参照するために、フィールド名の先頭に@文字(@hasMoreなど)を付加できます。

  • レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。

  • レスポンスに必要なフィールド名のカンマ区切り文字列。 フィールド名を区切るためにドットを使用して、ネストされたプロパティを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。 コレクションのフィールドを参照するために、フィールド名の先頭に@文字(@hasMoreなど)を付加できます。

  • レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。

    次のリンクは、このリソースにより提供されます:

    リンク関係説明
    parent親リソースが読取り可能な場所を示します。 このリンクはupリンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
    selfリソースの現在の戻り表現を示します。 リソース自体を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
    canonicalリクエストされたリソースの優先表現を示します。 リソースの標準的な形式を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
    child関連リソースまたは子リソースの読取りが可能な場所を表します。 子リンクは展開可能なプロパティとして返され、展開されていない関係の詳細が読み取られるロケーションを提供します。
    describedByリソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。 スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。
  • レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。 表現が指定されない場合、fieldsexcludeFieldslinksexcludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

    次の表現は、return問合せパラメータでサポートされています:

    表現説明
    representationフル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
    defaultデフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
    basic基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
    minimal最小リソース表現。必須プロパティとリンクなしが含まれます。
トップに戻る

レスポンス

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

200レスポンス

OK
ヘッダー
本文()
ルート・スキーマ: schema
型: object
ソースを表示
すべてに一致
ソースを表示
  • CollectionResource

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

ネストされたスキーマ: items
型: array

「イメージ」要素のコレクション。

ソースを表示
ネストされたスキーマ : CollectionResource

REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • CollectionResource-allOf[1]
ネストされたスキーマ : SingularResource
型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示
  • links
ネストされたスキーマ : CollectionResource-allOf[1]
型: object
ソースを表示
  • レスポンス内のリソースの合計数。

  • コレクションには、リクエストに一致する多くの要素があります。 ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。

  • 実際のレスポンス・サイズ制限。 リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。

  • 使用される実際のレスポンス・オフセット。 リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。

  • リクエストに一致するリソースの合計数。 指定した場合は、使用可能なアイテムの合計数です。 指定されない場合、合計が不明か、または戻り不可能です。 この値を計算するとき、ページング制限またはオフセットは無視されます。 totalResultsパラメータがサポートされていて、クライアントがtrueに設定している場合にのみ返されます。

ネストされたスキーマ: items
すべてに一致
ソースを表示
  • Image

    サイトおよびサイト・テンプレートのサムネイルまたはプレビュー・イメージの詳細。

ネストされたスキーマ : イメージ

サイトおよびサイト・テンプレートのサムネイルまたはプレビュー・イメージの詳細。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Image-allOf[1]
ネストされたスキーマ : Image-allOf[1]
型: object
ソースを表示
  • イメージ・タイプ。

    有効な値は次のとおりです。

    • thumbnail - サイトまたはテンプレートのサムネイル表示
    • preview - サイトまたはテンプレートの外観のプレビュー・イメージ

  • このイメージのURL。

レスポンス例(テンプレート・イメージを表示)
{
    "hasMore":false,
    "items":[
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543593693",
            "imageType":"thumbnail"
        },
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F53C0F71A6486C299A98F57C9AF14F3D4CB1C0F3C73F&dRevLabel=3&noSaveAs=1",
            "imageType":"preview"
        },
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F6A7AB65AF31C573457EA63F4E5FCE0654CE4B094E00&dRevLabel=3&noSaveAs=1",
            "imageType":"preview"
        },
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:FCF4875E7D15182738AD4EF4818C818AFA91FD27F465&dRevLabel=3&noSaveAs=1",
            "imageType":"preview"
        }
    ]
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : TemplateNotFoundExceptionDetail
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ソースを表示
  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。

  • エラーに関する詳細を提供するリンクへのURI。

  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titledetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。

  • o:errorDetails

    階層構造に複数のエラーがある場合もあります。

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

  • 問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。

  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

ネストされたスキーマ : TemplateNotFoundExceptionDetail-allOf[1]
型: object
ソースを表示
ネストされたスキーマ: o:errorDetails
型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

レスポンスの例(テンプレートが見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Not Found",
    "status":"404",
    "detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
    "o:errorCode":"OCE-SITEMGMT-009000",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

406レスポンス

受入れられない

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト
先頭に戻る