機械翻訳について

移動先

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

新規推奨を作成します。

post

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

指定されたペイロードで新しい推奨を作成します。

リクエスト

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

• application/json

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内の指定された情報で推奨事項を作成します。 ペイロード内に指定されている場合でも、id、status、isPublished、createdBy、createdAt、updatedBy、updatedAtおよびlinksフィールドは無視されます。

ルート・スキーマ : RecommendationInput

型: object

推奨入力Bean

ソースを表示

• apiName(optional): string
  推奨の参照名。 拒否名が指定されていない場合は、サーバーによって生成されます。 参照名はすべての推奨事項で一意である必要があります。 これは、推奨を起動するAPIコールで使用される名前です。
• channels(optional): array channels
• contentTypes(optional): array contentTypes
  推奨されるコンテンツ・タイプが返されます。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• defaults(optional): array defaults
  デフォルト・ルール・セクション。
• description(optional): string
  推奨の説明。
• main(optional): array main
  メイン・ルール・セクション。
• name: string
  推奨の名前。 これはレスポンス取得の必須プロパティであり、投稿/書込みリクエストで空にはできません。
• repositoryId: string
  推奨のリポジトリ。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。

{
    "type":"object",
    "required":[
        "name",
        "repositoryId"
    ],
    "properties":{
        "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."
        },
        "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"
            }
        },
        "main":{
            "type":"array",
            "description":"The main rule section.",
            "items":{
                "$ref":"#/definitions/MainRulesSection"
            }
        },
        "defaults":{
            "type":"array",
            "description":"The default rule section.",
            "items":{
                "$ref":"#/definitions/DefaultSection"
            }
        }
    },
    "description":"Recommendation Input Bean"
}

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

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

型: array

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

ソースを表示

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

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

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

型: array

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

ソースを表示

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

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

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

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : 推奨

型: 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レスポンス

内部サーバー・エラー

先頭に戻る