機械翻訳について

移動先

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

すべての推奨のリスト

get

/content/management/api/v1.1/personalization/recommendations

このリソースは、推奨名、apiNameおよびupdatedAtでフィルタできる使用可能な推奨のリストを返します。 フェッチ、ページ付け、並べ替えるアイテムの数を制御することができます。 制限を参照するには、問合せ構文の説明を参照してください。

リクエスト

問合せパラメータ

• default(optional): string
  デフォルトの検索問合せ式。
• fields(optional): string
  このパラメータは、推奨事項に対して返されるフィールドを制御するために使用されます。 このパラメータは、フィールド名または「すべて」のカンマ区切りリストを受け入れます。 これらのフィールドは、リストの各推奨に対して返されます。 すべてのフィールド名で大文字と小文字が区別されるため、問合せには正しいフィールド名を指定する必要があります。 各推奨事項には、標準フィールド(id、name、apiName、description、type、createdBy、createdAt、updatedBy、updatedAt、mainおよびdefaults)の両方があります。 fieldsを「すべて」 (大/小文字を区別しない)として指定すると、すべての標準フィールドおよび追加フィールドが返されます。 標準フィールドは常にレスポンスで返され、除外することはできません。 ユーザーがフィルタ処理できるのは、追加フィールドのみです。 このパラメータは問合せではオプションで、デフォルトではレスポンスの標準フィールドのみが表示されます。 問合せで指定されたフィールド名が正しくないか無効な場合は、エラーが発生します。
  
  例: ?fields=all
  このメソッドは、すべての標準フィールドと、各推奨のすべての追加フィールドを返します。
  
• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

  デフォルト値: 100
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
• offset(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。

  デフォルト値: 0
• orderBy(optional): string
  結果順。 現在、推奨を順序付けることはできません。

  デフォルト値: name:asc
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件は、AND演算子を使用して結合し、カッコでグループ化できます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 許可されるフィールド名は、repositoryIdのみです。 演算子の使用できる値は、eq (等しい)のみです。
  例:
  https://{cecsdomain}/content/management/api/v1.1/personalization/recommendations?q=(apiName eq "TestRecommendation")
  例 :
  https://{cecsdomain}/content/management/api/v1.1/personalization/recommendations?q=(repositoryId eq "EAQWER42DGKJ10PCNMGAE")
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : 推奨

型: object

Recommendations

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Recommendation"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Recommendations"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

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

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object Recommendation
  推奨事項

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Recommendation"
    }
}

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

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• name(optional): string
  読取り専用: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : 推奨

型: object

推奨事項

ソースを表示

• apiName(optional): string
  推奨の参照名。 拒否名が指定されていない場合は、サーバーによって生成されます。 参照名はすべての推奨事項で一意である必要があります。 これは、推奨を起動するAPIコールで使用される名前です。
• channels(optional): array channels
• contentTypes(optional): array contentTypes
  推奨されるコンテンツ・タイプが返されます。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• createdBy(optional): string
  推奨を作成したユーザー。
• createdDate(optional): object date
  date
• defaults(optional): array defaults
  デフォルト・ルール・セクション。
• description(optional): string
  推奨の説明。
• id: string
  推奨のid。 これは、レスポンス取得の必須プロパティであり、ポスト/putリクエストで無視されました。
• isPublished(optional): boolean
  推奨が公開される前かどうか。
• links(optional): array links
  リンク
• main(optional): array main
  メイン・ルール・セクション。
• name: string
  推奨の名前。 これはレスポンス取得の必須プロパティであり、投稿/書込みリクエストで空にはできません。
• publishedChannels(optional): array publishedChannels
• publishInfo(optional): object ItemSubResourceListPublishInfo
  アイテムSubResource。
• repositoryId: string
  推奨のリポジトリ。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• status(optional): string
  推奨の現在のステータス。
• type(optional): string
  ルール構造によって決定される推奨のタイプ。
• updatedBy(optional): string
  推奨を最後に更新したユーザー。
• updatedDate(optional): object date
  date
• version(optional): string
  このアイテムの現在のリビジョン・バージョン。

{
    "type":"object",
    "required":[
        "id",
        "name",
        "repositoryId"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Recommendation. This is a required propety in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Recommendation. It is a required property in the get response and cannot be empty in post/put request."
        },
        "description":{
            "type":"string",
            "description":"The description of the Recommendation."
        },
        "apiName":{
            "type":"string",
            "description":"The reference name of the Recommendation.  If a refrence name is not provided, one will be generated by the server. Reference names must be unique among all recommendations. This is the name that is used in API calls that invoke the recommendation."
        },
        "type":{
            "type":"string",
            "description":"The type of the Recommendation as determined by the rule structure."
        },
        "repositoryId":{
            "type":"string",
            "description":"Repositories of the Recommendation. It is a required property in the get response and post/put request."
        },
        "contentTypes":{
            "type":"array",
            "description":"Content types the Recommenation will return. It is a required property in the get response and post/put request.",
            "items":{
                "$ref":"#/definitions/ContentTypeId"
            }
        },
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "publishedChannels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the Recommendation."
        },
        "createdDate":{
            "description":"The creation date of the Recommendation.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the Recommendation."
        },
        "updatedDate":{
            "description":"The date the Recommendation was last updated.",
            "$ref":"#/definitions/date"
        },
        "status":{
            "type":"string",
            "description":"Current status of the recommendation."
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the recommendation is ever published."
        },
        "publishInfo":{
            "description":"All targets publish info.",
            "$ref":"#/definitions/ItemSubResourceListPublishInfo"
        },
        "main":{
            "type":"array",
            "description":"The main rule section.",
            "items":{
                "$ref":"#/definitions/MainRulesSection"
            }
        },
        "defaults":{
            "type":"array",
            "description":"The default rule section.",
            "items":{
                "$ref":"#/definitions/DefaultSection"
            }
        },
        "version":{
            "type":"string",
            "description":"The current revision version of this item."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Recommendation"
}

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

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

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

型: array

推奨されるコンテンツ・タイプが返されます。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。

ソースを表示

• Array of: object ContentTypeId

{
    "type":"array",
    "description":"Content types the Recommenation will return. It is a required property in the get response and post/put request.",
    "items":{
        "$ref":"#/definitions/ContentTypeId"
    }
}

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

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

ネストされたスキーマ : デフォルト

型: array

デフォルト・ルール・セクション。

ソースを表示

• Array of: object DefaultSection
  デフォルト・セクション

{
    "type":"array",
    "description":"The default rule section.",
    "items":{
        "$ref":"#/definitions/DefaultSection"
    }
}

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

メイン・ルール・セクション。

ソースを表示

• Array of: object MainRulesSection
  メイン・ルール・セクション

{
    "type":"array",
    "description":"The main rule section.",
    "items":{
        "$ref":"#/definitions/MainRulesSection"
    }
}

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

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

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

型: object

アイテムSubResource。

ソースを表示

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

型: object

ChannelId

ソースを表示

• id(optional): string
• isPrimaryChannel(optional): boolean
  チャネルがアセットのプライマリかどうかを示します。
• links(optional): array links
  リンク
• name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

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

型: object

ソースを表示

• name(optional): string
• typeCategory(optional): string
  アセット・タイプのtypeCategory。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "typeCategory":{
            "type":"string",
            "description":"typeCategory of the asset type."
        }
    }
}

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

型: object

デフォルト・セクション

ソースを表示

• items(optional): array items
  アイテムのリストです。 これはオプションであり、空にできます。
• sort(optional): array sort
  これは、標準的なクイズ構文に基づいた非常に単純なソートです。
  
  例: [systemField | userDefinedfield]<:>
  ここで:
  
  standardAssetField - ユーザーがソート対象として選択できるフィールドの事前定義済リストです。 これには、:ascまたは:descを追加することによって、上位プロパティと降順プロパティを付与できます。
  
  例:
  
  publishedDate:asc - 公開された日付昇順でソート
  userAssetField - ユーザーが作成したコンテンツ・タイプに定義されているフィールドを示します。
  field.myTextまたはfield.someThing:desc
  systemFieldまたはuserDefinedFieldが提供されない場合は、ランダムかつ関連性の可能性があります。
  
  :relevance - Default. 関連性で順序付けられたアセットが返されます。
  
  :ランダム - これによって、ルールやフィールドに関係なく、ランダムな順序でアセットが返されます。

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of items. This is optional and can be empty.",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "sort":{
            "type":"array",
            "description":"This is a very simple sort based of the normal quiery syntax.<br><br><b>Example:</b> [systemField | userDefinedfield]<:<random | relevance | asc | desc>><br>Where:<br><br><i>standardAssetField</i> - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding <i>:asc</i> or <i>:desc</i><br><br><b>Examples:</b> <br><br>publishedDate:asc - sort by published date ascneding<br>userAssetField - This refers to fields defined in the content type as created by the user.<br>field.myText or field.someThing:desc<br>If no systemField or userDefinedField is provided, :random and :relevance can be provided.<br><br><i>:relevance</i> - Default. This will return assets ordered by their relevance.<br><br><i>:random</i> - This will return assets in a random order irrespective of any rules or fields.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Default Section"
}

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

型: array

アイテムのリストです。 これはオプションであり、空にできます。

ソースを表示

• Array of: object ItemId

{
    "type":"array",
    "description":"List of items. This is optional and can be empty.",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

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

型: array

これは、標準的なクイズ構文に基づいた非常に単純なソートです。

例: [systemField | userDefinedfield]<:>
ここで:

standardAssetField - ユーザーがソート対象として選択できるフィールドの事前定義済リストです。 これには、:ascまたは:descを追加することによって、上位プロパティと降順プロパティを付与できます。

例:

publishedDate:asc - 公開された日付昇順でソート
userAssetField - ユーザーが作成したコンテンツ・タイプに定義されているフィールドを示します。
field.myTextまたはfield.someThing:desc
systemFieldまたはuserDefinedFieldが提供されない場合は、ランダムかつ関連性の可能性があります。

:relevance - Default. 関連性で順序付けられたアセットが返されます。

:ランダム - これによって、ルールやフィールドに関係なく、ランダムな順序でアセットが返されます。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"This is a very simple sort based of the normal quiery syntax.<br><br><b>Example:</b> [systemField | userDefinedfield]<:<random | relevance | asc | desc>><br>Where:<br><br><i>standardAssetField</i> - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding <i>:asc</i> or <i>:desc</i><br><br><b>Examples:</b> <br><br>publishedDate:asc - sort by published date ascneding<br>userAssetField - This refers to fields defined in the content type as created by the user.<br>field.myText or field.someThing:desc<br>If no systemField or userDefinedField is provided, :random and :relevance can be provided.<br><br><i>:relevance</i> - Default. This will return assets ordered by their relevance.<br><br><i>:random</i> - This will return assets in a random order irrespective of any rules or fields.",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• name(optional): string
  アイテムの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

アイテム・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"links of the item resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

メイン・ルール・セクション

ソースを表示

• properties(optional): object RulesProperties
  RulesProperties
• rules(optional): array rules
  ルールのメイン・リスト。 これはオプションであり、空にできます。
• sort(optional): array sort
  これは、標準的なクイズ構文に基づいた非常に単純なソートです。
  
  例: [systemField | userDefinedfield]<:>
  ここで:
  
  standardAssetField - ユーザーがソート対象として選択できるフィールドの事前定義済リストです。 これには、:ascまたは:descを追加することによって、上位プロパティと降順プロパティを付与できます。
  
  例:
  
  publishedDate:asc - 公開された日付昇順でソート
  userAssetField - ユーザーが作成したコンテンツ・タイプに定義されているフィールドを示します。
  field.myTextまたはfield.someThing:desc
  systemFieldまたはuserDefinedFieldが提供されない場合は、ランダムかつ関連性の可能性があります。
  
  :relevance - Default. 関連性で順序付けられたアセットが返されます。
  
  :ランダム - これによって、ルールやフィールドに関係なく、ランダムな順序でアセットが返されます。

{
    "type":"object",
    "properties":{
        "properties":{
            "description":"Properties for this rule section.",
            "$ref":"#/definitions/RulesProperties"
        },
        "rules":{
            "type":"array",
            "description":"Main list of Rules. This is optional and can be empty.",
            "items":{
                "$ref":"#/definitions/Rule"
            }
        },
        "sort":{
            "type":"array",
            "description":"This is a very simple sort based of the normal quiery syntax.<br><br><b>Example:</b> [systemField | userDefinedfield]<:<random | relevance | asc | desc>><br>Where:<br><br><i>standardAssetField</i> - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding <i>:asc</i> or <i>:desc</i><br><br><b>Examples:</b> <br><br>publishedDate:asc - sort by published date ascneding<br>userAssetField - This refers to fields defined in the content type as created by the user.<br>field.myText or field.someThing:desc<br>If no systemField or userDefinedField is provided, :random and :relevance can be provided.<br><br><i>:relevance</i> - Default. This will return assets ordered by their relevance.<br><br><i>:random</i> - This will return assets in a random order irrespective of any rules or fields.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Main Rules Section"
}

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

型: object

RulesProperties

ソースを表示

• operator(optional): string
  許容値: [ "ALL", "ANY" ]

  このグループ内のルールを結合するために使用される演算子。 これはオプションで、省略した場合はALLにデフォルト設定されます。

{
    "type":"object",
    "properties":{
        "operator":{
            "type":"string",
            "description":"The operator that will be used to combine the rules in this group. This is optional and defaults to ALL if omitted.",
            "enum":[
                "ALL",
                "ANY"
            ]
        }
    },
    "description":"RulesProperties"
}

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

型: array

ルールのメイン・リスト。 これはオプションであり、空にできます。

ソースを表示

• Array of: object Rule

{
    "type":"array",
    "description":"Main list of Rules. This is optional and can be empty.",
    "items":{
        "$ref":"#/definitions/Rule"
    }
}

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

型: array

これは、標準的なクイズ構文に基づいた非常に単純なソートです。

例: [systemField | userDefinedfield]<:>
ここで:

standardAssetField - ユーザーがソート対象として選択できるフィールドの事前定義済リストです。 これには、:ascまたは:descを追加することによって、上位プロパティと降順プロパティを付与できます。

例:

publishedDate:asc - 公開された日付昇順でソート
userAssetField - ユーザーが作成したコンテンツ・タイプに定義されているフィールドを示します。
field.myTextまたはfield.someThing:desc
systemFieldまたはuserDefinedFieldが提供されない場合は、ランダムかつ関連性の可能性があります。

:relevance - Default. 関連性で順序付けられたアセットが返されます。

:ランダム - これによって、ルールやフィールドに関係なく、ランダムな順序でアセットが返されます。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"This is a very simple sort based of the normal quiery syntax.<br><br><b>Example:</b> [systemField | userDefinedfield]<:<random | relevance | asc | desc>><br>Where:<br><br><i>standardAssetField</i> - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding <i>:asc</i> or <i>:desc</i><br><br><b>Examples:</b> <br><br>publishedDate:asc - sort by published date ascneding<br>userAssetField - This refers to fields defined in the content type as created by the user.<br>field.myText or field.someThing:desc<br>If no systemField or userDefinedField is provided, :random and :relevance can be provided.<br><br><i>:relevance</i> - Default. This will return assets ordered by their relevance.<br><br><i>:random</i> - This will return assets in a random order irrespective of any rules or fields.",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• fieldId(optional): string
• fieldName(optional): string
• fieldValue(optional): string
• operator(optional): string

{
    "type":"object",
    "properties":{
        "fieldId":{
            "type":"string"
        },
        "fieldName":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "fieldValue":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: object PublishInfo
  PublishInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishInfo"
    }
}

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

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

PublishInfo

ソースを表示

• channel (オプション): string
  ターゲット名
• links(optional): array links
  リンク
• publishedBy(optional): string
  パブリッシュしたユーザー
• publishedDate(optional): object date
  date
• slug(optional): string
  公開スラグ
• version(optional): string
  公開済のバージョン

{
    "type":"object",
    "properties":{
        "channel":{
            "type":"string",
            "description":"Target name"
        },
        "publishedBy":{
            "type":"string",
            "description":"Published by"
        },
        "version":{
            "type":"string",
            "description":"Published version"
        },
        "publishedDate":{
            "description":"date and time Item publishedAt.",
            "$ref":"#/definitions/date"
        },
        "slug":{
            "type":"string",
            "description":"Published slug"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PublishInfo"
}

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る