Jump to

• Request
• Response

Create a new Recommendation.

post

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

Create a new Recommendation with given payload.

Request

Supported Media Types

• application/json

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Create a Recommendation with the given information in the payload. The fields id, status, isPublished, createdBy, createdAt, updatedBy, updatedAt and links will be ignored even if given in the payload.

Root Schema : RecommendationInput

Type: object

Recommendation Input Bean

Show Source

• apiName(optional): string
  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.
• channels(optional): array channels
• contentTypes(optional): array contentTypes
  Content types the Recommenation will return. It is a required property in the get response and post/put request.
• defaults(optional): array defaults
  The default rule section.
• description(optional): string
  The description of the Recommendation.
• main(optional): array main
  The main rule section.
• name: string
  The name of the Recommendation. It is a required property in the get response and cannot be empty in post/put request.
• repositoryId: string
  Repositories of the Recommendation. It is a required property in the get response and post/put request.

{
    "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"
}

Nested Schema : channels

Type: array

Show Source

• Array of: object ChannelId
  ChannelId

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

Nested Schema : contentTypes

Type: array

Content types the Recommenation will return. It is a required property in the get response and post/put request.

Show Source

• 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"
    }
}

Nested Schema : defaults

Type: array

The default rule section.

Show Source

• Array of: object DefaultSection
  Default Section

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

Nested Schema : main

Type: array

The main rule section.

Show Source

• Array of: object MainRulesSection
  Main Rules Section

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

Nested Schema : ChannelId

Type: object

ChannelId

Show Source

• id(optional): string
• isPrimaryChannel(optional): boolean
  Indicates if channel is primary for an asset.
• links(optional): array links
  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"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "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."
}

Nested Schema : ContentTypeId

Type: object

Show Source

• name(optional): string
• typeCategory(optional): string
  typeCategory of the asset type.

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

Nested Schema : DefaultSection

Type: object

Default Section

Show Source

• items(optional): array items
  List of items. This is optional and can be empty.
• sort(optional): array sort
  This is a very simple sort based of the normal quiery syntax.
  
  Example: [systemField | userDefinedfield]<:>
  Where:
  
  standardAssetField - 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 :asc or :desc
  
  Examples:
  
  publishedDate:asc - sort by published date ascneding
  userAssetField - This refers to fields defined in the content type as created by the user.
  field.myText or field.someThing:desc
  If no systemField or userDefinedField is provided, :random and :relevance can be provided.
  
  :relevance - Default. This will return assets ordered by their relevance.
  
  :random - This will return assets in a random order irrespective of any rules or fields.

{
    "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"
}

Nested Schema : items

Type: array

List of items. This is optional and can be empty.

Show Source

• Array of: object ItemId

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

Nested Schema : sort

Type: array

This is a very simple sort based of the normal quiery syntax.

Example: [systemField | userDefinedfield]<:>
Where:

standardAssetField - 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 :asc or :desc

Examples:

publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.

:relevance - Default. This will return assets ordered by their relevance.

:random - This will return assets in a random order irrespective of any rules or fields.

Show Source

• 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"
    }
}

Nested Schema : ItemId

Type: object

Show Source

• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• name(optional): string
  name of the item.

{
    "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"
            }
        }
    }
}

Nested Schema : links

Type: array

links of the item resource

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : MainRulesSection

Type: object

Main Rules Section

Show Source

• properties(optional): object RulesProperties
  RulesProperties
• rules(optional): array rules
  Main list of Rules. This is optional and can be empty.
• sort(optional): array sort
  This is a very simple sort based of the normal quiery syntax.
  
  Example: [systemField | userDefinedfield]<:>
  Where:
  
  standardAssetField - 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 :asc or :desc
  
  Examples:
  
  publishedDate:asc - sort by published date ascneding
  userAssetField - This refers to fields defined in the content type as created by the user.
  field.myText or field.someThing:desc
  If no systemField or userDefinedField is provided, :random and :relevance can be provided.
  
  :relevance - Default. This will return assets ordered by their relevance.
  
  :random - This will return assets in a random order irrespective of any rules or fields.

{
    "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"
}

Nested Schema : RulesProperties

Type: object

RulesProperties

Show Source

• operator(optional): string
  Allowed Values: [ "ALL", "ANY" ]

  The operator that will be used to combine the rules in this group. This is optional and defaults to ALL if omitted.

{
    "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"
}

Nested Schema : rules

Type: array

Main list of Rules. This is optional and can be empty.

Show Source

• Array of: object Rule

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

Nested Schema : sort

Type: array

This is a very simple sort based of the normal quiery syntax.

Example: [systemField | userDefinedfield]<:>
Where:

standardAssetField - 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 :asc or :desc

Examples:

publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.

:relevance - Default. This will return assets ordered by their relevance.

:random - This will return assets in a random order irrespective of any rules or fields.

Show Source

• 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"
    }
}

Nested Schema : Rule

Type: object

Show Source

• 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created.

Body ()

Root Schema : Recommendation

Type: object

Recommendation

Show Source

• apiName(optional): string
  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.
• channels(optional): array channels
• contentTypes(optional): array contentTypes
  Content types the Recommenation will return. It is a required property in the get response and post/put request.
• createdBy(optional): string
  The user who created the Recommendation.
• createdDate(optional): object date
  date
• defaults(optional): array defaults
  The default rule section.
• description(optional): string
  The description of the Recommendation.
• id: string
  The id of the Recommendation. This is a required propety in the get response and ignored in post/put requests.
• isPublished(optional): boolean
  Whether the recommendation is ever published.
• links(optional): array links
  Links
• main(optional): array main
  The main rule section.
• name: string
  The name of the Recommendation. It is a required property in the get response and cannot be empty in post/put request.
• publishedChannels(optional): array publishedChannels
• publishInfo(optional): object ItemSubResourceListPublishInfo
  Item SubResource.
• repositoryId: string
  Repositories of the Recommendation. It is a required property in the get response and post/put request.
• status(optional): string
  Current status of the recommendation.
• type(optional): string
  The type of the Recommendation as determined by the rule structure.
• updatedBy(optional): string
  The user who last updated the Recommendation.
• updatedDate(optional): object date
  date
• version(optional): string
  The current revision version of this item.

{
    "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"
}

Nested Schema : channels

Type: array

Show Source

• Array of: object ChannelId
  ChannelId

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

Nested Schema : contentTypes

Type: array

Content types the Recommenation will return. It is a required property in the get response and post/put request.

Show Source

• 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"
    }
}

Nested Schema : date

Type: object

date

Show Source

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

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

Nested Schema : defaults

Type: array

The default rule section.

Show Source

• Array of: object DefaultSection
  Default Section

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

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : main

Type: array

The main rule section.

Show Source

• Array of: object MainRulesSection
  Main Rules Section

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

Nested Schema : publishedChannels

Type: array

Show Source

• Array of: object ChannelId
  ChannelId

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

Nested Schema : ItemSubResourceListPublishInfo

Type: object

Item SubResource.

Show Source

• 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."
}

Nested Schema : ChannelId

Type: object

ChannelId

Show Source

• id(optional): string
• isPrimaryChannel(optional): boolean
  Indicates if channel is primary for an asset.
• links(optional): array links
  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"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "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."
}

Nested Schema : ContentTypeId

Type: object

Show Source

• name(optional): string
• typeCategory(optional): string
  typeCategory of the asset type.

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

Nested Schema : DefaultSection

Type: object

Default Section

Show Source

• items(optional): array items
  List of items. This is optional and can be empty.
• sort(optional): array sort
  This is a very simple sort based of the normal quiery syntax.
  
  Example: [systemField | userDefinedfield]<:>
  Where:
  
  standardAssetField - 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 :asc or :desc
  
  Examples:
  
  publishedDate:asc - sort by published date ascneding
  userAssetField - This refers to fields defined in the content type as created by the user.
  field.myText or field.someThing:desc
  If no systemField or userDefinedField is provided, :random and :relevance can be provided.
  
  :relevance - Default. This will return assets ordered by their relevance.
  
  :random - This will return assets in a random order irrespective of any rules or fields.

{
    "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"
}

Nested Schema : items

Type: array

List of items. This is optional and can be empty.

Show Source

• Array of: object ItemId

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

Nested Schema : sort

Type: array

This is a very simple sort based of the normal quiery syntax.

Example: [systemField | userDefinedfield]<:>
Where:

standardAssetField - 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 :asc or :desc

Examples:

publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.

:relevance - Default. This will return assets ordered by their relevance.

:random - This will return assets in a random order irrespective of any rules or fields.

Show Source

• 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"
    }
}

Nested Schema : ItemId

Type: object

Show Source

• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• name(optional): string
  name of the item.

{
    "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"
            }
        }
    }
}

Nested Schema : links

Type: array

links of the item resource

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : MainRulesSection

Type: object

Main Rules Section

Show Source

• properties(optional): object RulesProperties
  RulesProperties
• rules(optional): array rules
  Main list of Rules. This is optional and can be empty.
• sort(optional): array sort
  This is a very simple sort based of the normal quiery syntax.
  
  Example: [systemField | userDefinedfield]<:>
  Where:
  
  standardAssetField - 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 :asc or :desc
  
  Examples:
  
  publishedDate:asc - sort by published date ascneding
  userAssetField - This refers to fields defined in the content type as created by the user.
  field.myText or field.someThing:desc
  If no systemField or userDefinedField is provided, :random and :relevance can be provided.
  
  :relevance - Default. This will return assets ordered by their relevance.
  
  :random - This will return assets in a random order irrespective of any rules or fields.

{
    "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"
}

Nested Schema : RulesProperties

Type: object

RulesProperties

Show Source

• operator(optional): string
  Allowed Values: [ "ALL", "ANY" ]

  The operator that will be used to combine the rules in this group. This is optional and defaults to ALL if omitted.

{
    "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"
}

Nested Schema : rules

Type: array

Main list of Rules. This is optional and can be empty.

Show Source

• Array of: object Rule

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

Nested Schema : sort

Type: array

This is a very simple sort based of the normal quiery syntax.

Example: [systemField | userDefinedfield]<:>
Where:

standardAssetField - 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 :asc or :desc

Examples:

publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.

:relevance - Default. This will return assets ordered by their relevance.

:random - This will return assets in a random order irrespective of any rules or fields.

Show Source

• 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"
    }
}

Nested Schema : Rule

Type: object

Show Source

• 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"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object PublishInfo
  PublishInfo

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : PublishInfo

Type: object

PublishInfo

Show Source

• channel(optional): string
  Target name
• links(optional): array links
  Links
• publishedBy(optional): string
  Published by
• publishedDate(optional): object date
  date
• slug(optional): string
  Published slug
• version(optional): string
  Published version

{
    "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"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

400 Response

Bad request.

403 Response

Forbidden.

500 Response

Internal server error.

Back to Top