{ "swagger":"2.0", "info":{ "description":"The REST API for Content Preview provides access to preview the latest version of management assets. In Oracle Content Management, management assets include content items, digital assets (including CDT and multi-lingual) as well as their renditions.\n\n

Last updated: May 2023.

", "version":"2023.05.25", "title":"REST API for Content Preview", "x-summary":"The REST API for Content Preview provides access to preview the latest version of management assets." }, "basePath":"/content", "tags":[ { "name":"Item", "description":"The resources used to preview an item (includes Content Item, Digital asset/Custom Digital Asset and Multi Lingual Assets)" }, { "name":"Item variations", "description":"The resources used to preview item variations." }, { "name":"Items", "description":"The resources used to search across the preview of items." }, { "name":"Items by slug", "description":"The resources used to preview an item (includes Content Item, Digital asset/Custom Digital Asset and Multi Lingual Assets) by slug" }, { "name":"Recommendations", "description":"The resources used to preview recommendation results." }, { "name":"Renditions", "description":"The resources used to preview digital asset renditions and native files (includes Custom and Multi Lingual digital assets)." }, { "name":"Renditions by slug", "description":"The resources used to preview digital asset renditions and native files by slug (includes Custom and Multi Lingual digital assets)." }, { "name":"Taxonomies", "description":"The resources used to preview taxonomies and their respective categories." }, { "name":"Version Catalog", "description":"Version resources in the preview API." } ], "paths":{ "/preview/api":{ "get":{ "tags":[ "Version Catalog" ], "summary":"Get available versions of the Content Preview API", "description":"Returns information about the available versions of the API.
It is a collection resource, and each item within the collection is a version resource.

Headers (Optional) :
Header NameHeader Value
Acceptapplication/json
", "operationId":"getPreviewVersions", "produces":[ "application/json" ], "parameters":[ { "name":"offset", "in":"query", "description":"Start index of response rows.", "required":false, "type":"integer", "default":0, "format":"int32" }, { "name":"limit", "in":"query", "description":"This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.", "required":false, "type":"integer", "default":100, "format":"int32" }, { "name":"totalResults", "in":"query", "description":"Accepts a Boolean value. Setting it to true displays the total results field in the response.", "required":false, "type":"boolean", "default":false }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby, first, last, prev, next.
Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/CollectionProperties" } }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-get", "x-filename-id":"preview-api-get" } }, "/preview/api/v1.1":{ "get":{ "tags":[ "Version Catalog" ], "summary":"Get v1.1 API information", "description":"Returns information about the v1.1 API.
A version resource has the following properties:
  1. version: Version of the resource.
  2. lifecycle: Whether a version is actively supported or deprecated.
  3. isLatest: Whether it is the latest version.
  4. terminationDate (Optional): Date of termination.
  5. catalog: A child resource that serves as a metadata catalog for all the resources supported in that version.
Headers (Optional):
Header NameHeader Value
Acceptapplication/json
", "operationId":"getPreviewVersion", "produces":[ "application/json" ], "parameters":[ { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/Version" } }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-get", "x-filename-id":"preview-api-v1.1-get" } }, "/preview/api/v1.1/items":{ "get":{ "tags":[ "Items" ], "summary":"Preview items using search", "description":"Use this query to filter the latest management content. You can control the number of items to be fetched, paginated, and sorted. Additionally, this resource can fetch field values of matching items.
Query expression syntax supports conditions that match the field values. You can also query across all fields for a specific phrase. Many such query conditions can be joined by using AND/OR operators and grouped with parenthesis. Below are general examples of queries.

Query expression ?q=(type eq \"Employee\" AND (fields.emails co \"example.com\" OR fields.emails co \"example.org\"))
Query expression usage with this resource /preview/api/v1.1/items?q=(type eq \"Employee\" AND (fields.emails co \"example.com\" OR fields.emails co \"example.org\"))&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51

Notes: Field names used in the query are case-sensitive.

In general two forms of filtering are supported by this resource.

In either form, it is possible to search by matching anywhere (any field) by specifying a default match criteria. Such a criteria is a generic query that matches values of the items across all fields.
For example:
/preview/api/v1.1/items?default=\"coffee\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51
/preview/api/v1.1/items?q=(type eq \"Employee\")&default=\"senior\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51

In either form, while querying using standard fields, name, description, type, typeCategory, slug, language are to be considered as a text data type (single valued), id as reference data type (single valued), createdDate, updatedDate as a datetime data type (single valued) and taxonomies as a reference data type (multi valued).

OperatorExampleSupported data typesDescription
eq?q=(name eq \"John\")

?q=(type eq \"DigitalAsset\")

?q=(type eq \"Employee\" and fields.DOB eq \"1994/09/26T16:23:45.208\")

?q=(type eq \"File\" and fileextension eq \"docx\")

?q=(taxonomies.categories.id eq \"B9F568DC43C54803AC76012783FA5101\")

?q=(taxonomies.categories.name eq \"Cars\")

?q=(taxonomies.categories.apiName eq \"cars-unique\")

?q=(taxonomies.categories.nodes.id eq \"B9F568DC43C54803AC76012783FA5101\")

?q=(taxonomies.categories.nodes.name eq \"red\")

?q=(taxonomies.categories.nodes.apiName eq \"cars\")		text, reference, number, decimal, boolean, datetime.Equals operator (eq) matches the exact value supplied in the query. This operator is not applicable to multivalued data types. The value provided with this operator is not case-sensitive except for standard fields (type). This operator considers even special characters in the value.
ne?q=(name ne \"John\")text, reference, number, decimal, boolean, datetime.Not Equals operator (ne) matches items that do not match the exact value supplied in the query. This operator is not applicable to multivalued data types. The value provided with this operator is not case-sensitive except for standard fields. This operator considers even special characters in the value.
co?q=(type eq \"Employee\" AND name co \"john alex\")

?q=(type eq \"Car\" AND fields.features co \"manual\")

?q=(taxonomies.categories.name co \"red\")

?q=(taxonomies.categories.nodes.name co \"cars\")		text, reference, number, decimal, datetime, largetextContains operator (co) matches every word given in the criteria. The words are formed by splitting the value by special characters. It gives the results that have at least one of the words (in this example, john or alex or both). This operator does not consider special characters in the value while searching. This operator does not perform a search on stop words.

This operator is applicable to text, largetext in case of single-valued attributes, whereas for multivalued attributes, it is applicable to text, reference, number, decimal, datetime, largetext. To understand the possible datetime formats, refer to the Supported date/datetime formats (24Hrs) table below. The value provided with this operator is not case-sensitive.
nc?q=(name nc \"john alex\")text, reference, number, decimal, datetime, largetextNot Contains operator (nc) matches items that would not match a co operator with the same criteria.
sw?q=(type eq \"Employee\" AND name sw \"Joh\")

?q=(type eq \"Employee\" AND fields.city sw \"Los\")

?q=(taxonomies.categories.name sw \"cat\")

?q=(taxonomies.categories.nodes.name sw \"red\")		textStarts With operator (sw) matches only the initial character values given in the field condition. This operator is not applicable to multivalued data types. The value provided with this operator is not case-sensitive.
ge?q=(type eq \"Employee\" AND fields.age ge \"40\")

?q=(type eq \"DigitalAsset\" AND updatedDate ge \"20171026\")		number, decimal, datetimeGreater than or equal to operator (ge) matches only numeric and datetime values. To understand the possible datetime formats, refer to the Supported date/datetime formats (24Hrs) table below. This operator is not applicable to multivalued data types.
le?q=(type eq \"Employee\" AND fields.weight le \"60.6\")number, decimal, datetimeLess than or equal to operator (le) matches only numeric and datetime values. To understand the possible datetime formats, refer to the Supported date/datetime formats (24Hrs) table below. This operator is not applicable to multivalued data types.
gt?q=(type eq \"Employee\" AND fields.age gt \"20\")number, decimal, datetimeGreater than operator (gt) matches only numeric and datetime values. To understand the possible datetime formats, refer to the Supported date/datetime formats (24Hrs) table below. This operator is not applicable to multivalued data types.
lt?q=(type eq \"Employee\" AND fields.age lt \"20\")

?q=(type eq \"Employee\" AND createdDate lt \"1994/09/26T16:23:45.208\")		number, decimal, datetimeLesser than operator (lt) matches only numeric and datetime values. To understand the possible datetime formats, refer to the Supported date/datetime formats (24Hrs) table below. This operator is not applicable to multivalued data types.
mt?q=(type eq \"Car\" AND fields.review mt \"petrol 20KMPL\")

?q=(type eq \"Employee\" AND name mt \"Jo?n\")

?q=(type eq \"Employee\" AND name mt \"Jo*\")

?q=(type eq \"Employee\" AND fields.role mt \"senior*\")		text, largetextPhrase query or proximity search (matches) operator (mt) enables you to find words that are within a specific distance to one another. Results are sorted by best match. It is useful for searching items when values given in the criteria \"petrol 20kmpl\" need to discover actual content that may contain \"petrol fuel mileage runs 20KMPL in the speed way\".

Matches operator can use a wildcard (? or *) to match multiple characters within the given value. This operator is applicable to both single valued and multivalued data types. This operator does not perform a search on stop words. The value provided with this operator is not case-sensitive. For matching exact phrases surround search terms by double quotes. Enclosing double quotes will be treated as part of the search term in all other contexts.
sm?q=(type eq \"Employee\" And fields.city sm \"Rome\")text, largetextSimilarity query operator. This operator allows searching for values that sound like specified criteria - also called fuzzy search, which use by default maximum two edits to match result. \"Rome\" is similar to \"Dome\". This operator is applicable to both single valued and multivalued data types. The value provided with this operator is not case-sensitive.
AND?q=(type eq \"Employee\" AND name eq \"John\" AND fields.age ge \"40\")-NA-AND operator, can be used to put an AND condition between multiple query conditions. This takes precedence over OR.
OR?q=(type eq \"Employee\" AND (name eq \"John\" OR fields.age ge \"40\"))-NA-OR operator can be used to put an OR condition between multiple query conditions.
( )?q=(type eq \"Employee\" AND (name eq \"John\" AND fields.age ge \"40\"))

?q=(type eq \"Employee\" AND ((name eq \"John\" AND fields.age ge \"40\") OR fields.weight ge 60))		-NA-Parenthesis, enclosing operator to group the conditions in the criteria. This takes highest precedence, followed by AND, and then by OR.



Request Headers :
Is requiredHeader NameHeader Value
RequiredchannelToken{valid channel token value}
OptionalAcceptapplication/json

\n\n\n
Additional Notes
Type specific queryThis query always uses only the eq operator. eq works with a case-sensitive type name. Multitype query is supported, however it will be query across types.
Example:
q=(type eq \"Employee\") or q=(type eq \"DigitalAsset\") is single type search and q=(type eq \"Employee\" OR type eq \"Address\") is multitype search and considered as query across types.
Date queryDate query is a special type of query because of various date formats associated to it. All the datetime values are in the UTC (timezone) only. So query results will always be in UTC timezone format for all datetime fields. Fields with the datatype datetime should use the operators ge, gt, le, lt for range query and use eq for an equals match.

Example:
Query Products by manufactureDate (datetime) field using the ge operator.
https://cecsdomain/content/preview/api/v1.1/items?q=(type eq \"Product\" AND fields.manufactureDate ge \"1989-03-26\")&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51. The given date format is YYYY-MM-DD.

Explore more date/datetime specific query examples in the Examples section and also to understand the accepted date/datetime formats in the section below (supported date/datetime formats).
Decimal valuesDecimal number query is supported up to 3 digits after decimal points, and the rest of the digits after 3 will be ignored. https://cecsdomain/content/preview/api/v1.1/items?q=(type eq \"Product\" AND fields.price ge 425.3214)&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51, will result in all the Product where price is greater than equals to 425.321.
Large text datatype queryFields with the datatype largetext are not stored, so the query result cannot return its value. But the field value can be used in a query condition.
Generic query searchGeneric query search is a default search query, this can be used when the user can search by only value without using any field name or operators. Internally generic search uses the co operator. This query does not support wildcard characters. This search does not perform search on stop words.
Example:
?q=(type eq \"Employee\")&fields=all&default=John. This will return the search results for the Employee type where the value John matches to field names , descriptions or any user-defined fields.
Example:
?q=(type eq \"Article\")&default=skating. This will return the search results for Article type where value skating matches to fields name, description or any user defined fields.
ID searchSearch query using ID attribute.
Example:
?q=(type eq \"Employee\" AND id eq \"COREAF29AC6ACA9644F9836E36C7B558F316\"). The value of id belongs to the item being queried itself, here id of type Employee.
It is possible to include multiple item ids in the query expression
Example:
?q=(type eq \"Employee\" AND (id eq \"COREAF29AC6ACA9644F9836E36C7B558F316\" OR id eq \"COREAF29AC6ACA9644F9836E36C7B558F987\")).
Category searchSearch items categorized with given category id, category name, category apiName, category node id, category node name or category node apiName attributes.
Note: Taxonomy related information in the response will not be shown until the taxonomy is published to the specified channel although filtering categorized assets using rules with promoted version of taxonomies and it's categories is allowed
Example:
?q=(taxonomies.categories.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\")
The value of taxonomies.categories.id belongs to the category assigned to items being queried. It is possible to include multiple category ids or names in the query expression.
Example:
?q=(taxonomies.categories.name co \"cars\" OR taxonomies.categories.name sw \"red\")
Example:
?q=(taxonomies.categories.apiName eq \"All-furnitures\")
The value of taxonomies.categories.apiName belongs to the category assigned to items being queried. It is possible to include multiple category apiName values in the query expression.
Example:
?q=(taxonomies.categories.nodes.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\")
The value of taxonomies.categories.nodes.id belongs to any node of categories assigned to items being queried. It is possible to include multiple category node ids or node names in the query expression.
Example:
?q=(taxonomies.categories.nodes.name co \"cars\" OR taxonomies.categories.nodes.name sw \"red\")
Example:
?q=(taxonomies.categories.nodes.apiName eq \"All-furnitures\" OR taxonomies.categories.nodes.apiName eq \"all-accessories\")
The value of taxonomies.categories.nodes.apiName belongs to any node of categories assigned to items being queried. It is possible to include multiple category node apiName values in the query expression.
Reference field searchSearch query using reference attribute.
Example:
?q=(type eq \"Employee\" AND fields.department eq \"COREAF29AC6ACA9644F9836E36C7B558F412\").
The value of department belongs to id of an item of type Department.
Query matching text in binary fileSearching in binary file text (typed searches for digital assets only). Searching in the digital assets' binary file's text is supported using metadata.extractedText parameter in the search query within a type or across specific types. Supported operators are co, nc and mt.
Example:
?q=(type eq \"File\" AND metadata.extractedText co \"Employee\")
?q=((type eq \"cdt1\" or type eq \"cdt2\") AND metadata.extractedText mt \"installed\")
Query matching text in any field and the binary fileSearching in the fields and binary file text (typed searches for content or digital assets). Searching in the fields and binary file's text is supported using anyField parameter in the search query within a type or across specific types. Supported operators are co, nc and mt.
Example:
?q=(type eq \"contentType1\" AND anyField co \"Employee\")
?q=({type eq \"contentType1\" AND anyField mt \"installed\"} OR {type eq \"cdt1\" AND anyField mt \"installed\"})


Supported date/datetime formats (24Hrs)
FormatExample
YYYY-MM-DD1989-03-26
YYYY/MM/DD1989/03/26
DD-MM-YYYY26-03-1989
DD/MM/YYYY26/03/1989
YYYY-MM-DD''T''hh:mm:ss1989-03-26T18:32:38
YYYY/MM/DD''T''hh:mm:ss1989/03/26T18:32:38
DD-MM-YYYY''T''hh:mm:ss26-03-1989T18:32:38
DD/MM/YYYY''T''hh:mm:ss26/03/1989T18:32:38
YYYY-MM-DD''T''hh:mm:ss.SSS1989-03-26T18:32:38.840
YYYY/MM/DD''T''hh:mm:ss.SSS1989/03/26T18:32:38.840
DD-MM-YYYY''T''hh:mm:ss.SSS26-03-1989T18:32:38.840
DD/MM/YYYY''T''hh:mm:ss.SSS26/03/1989T18:32:38.840
YYYYMMDD19890326
YYYYMMDDhhmmss19890326183238
YYYYMMDDhhmmssSSS19880326183238840
", "operationId":"getItemsForPreview", "produces":[ "application/json" ], "parameters":[ { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"q", "in":"query", "description":"This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using AND/OR operators and grouped with parentheses. The value of query condition follows the format of {fieldName} {operator} \"{fieldValue}\". In case of query across type the field names are limited to standard fields (id, type, name, description, typeCategory, slug, language, createdDate, updatedDate, taxonomies). However in case of type specific query the field names are limited to standard fields and user defined fields (except fields of largeText data type). The only values allowed in the operator are eq (Equals), co (Contains), sw (Startswith), ge (Greater than or equals to), le (Less than or equals to), gt (Greater than), lt (Less than), mt (Matches), sm (Similar).
Example:
https://{cecsdomain}/content/preview/api/v1.1/items?q=(name eq \"John\")&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51
Example:
https://{cecsdomain}/content/preview/api/v1.1/items?q=(type eq \"Employee\" AND name eq \"John\")&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51
Example:
https://{cecsdomain}/content/preview/api/v1.1/items?q=(type eq \"Employee\" AND ((name eq \"John\" AND field.age ge \"40\") OR fields.weight gt \"70\"))&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51
Example:
https://{cecsdomain}/content/preview/api/v1.1/items?q=(taxonomies.categories.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\" OR (taxonomies.categories.name co \"cat\" AND taxonomies.categories.name co \"red\"))&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51
Example:
https://{cecsdomain}/content/preview/api/v1.1/items?q=(taxonomies.categories.nodes.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\" OR taxonomies.categories.nodes.name co \"cars\")&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51", "required":false, "type":"string" }, { "name":"default", "in":"query", "description":"Default search query expression.", "required":false, "type":"string" }, { "name":"defaultOperator", "in":"query", "description":"Default search query operator. This parameter is optional. It accepts 'or' and 'and' operators. If not provided, defaultOperator would be considered as 'or'.", "required":false, "type":"string" }, { "name":"fields", "in":"query", "description":"The fields parameter is used to control the returned fields and values in the queried item. This parameter accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). These fields will be returned for each queried item. As all the field names are case-sensitive, users must provide the correct field names in the search query. When fields is specified as all (case-insensitive), in case of a type-specific query, all the standard fields, and user-defined fields except largetext, json, location datatype are returned for each queried item, whereas in case of a query across all types, only all standard fields are returned. The standard fields id and type are always returned in the response and cannot be filtered out. This parameter is optional in the query and by default query result shows only id, name, description, and type in the response. Any incorrect or invalid field name given in the query will be ignored.

In the context of a brace style cross-type query, type specific fields may be specified using syntax name,{typename1:fields.userdefinedfieldname1,fields.userdefinedfieldname2},{typename2:fields.userdefinedfieldname1}.In the preceding example, all items of type typename1 will have fields - name, userdefinedfieldname1 and userdefinedfieldname2, while all items of type typename2 will have fields - name, userdefinedfieldname1. If the cross-type query does not resolve to types referenced in the typed fields clause(s), an error will be thrown. Example: ?q=(type eq \"LocationType\")&fields=fields.state,fields.country,updatedDate
This returns id, type, state, country, updatedDate in the search results for a LocationType with state and country fields.
Example: ?q=(type eq \"LocationType\")&fields=all
This will return all standard fields and all user-defined fields except largetext, json, location data types
Example: ?fields=all
This will return only standard fields (id, type, typeCategory, name, description, slug, language, createdDate, updatedDate, taxonomies, renditions) since Type is not used in the search query (acts as a Global query)
", "required":false, "type":"string", "default":"name,description,slug,language,translatable,createdDate,updatedDate,fileExtension" }, { "name":"offset", "in":"query", "description":"Start index of response rows.", "required":false, "type":"integer", "default":0, "format":"int32" }, { "name":"limit", "in":"query", "description":"This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.", "required":false, "type":"integer", "default":100, "format":"int32" }, { "name":"scroll", "in":"query", "description":"Specifying this parameter indicates that scroll behavior is expected from the search api. Scrolling is the recommended method for retrieving large result sets. Scrolling is not available when returnMaster is enabled. hasMore will always return false when scrolling is enabled. offset parameter value, if specified, will be ignored on scroll requests. limit parameter value will be interpreted in the context of scroll and be fixed for a scroll session. Subsequent changes to limit will be ignored for the scroll session. A limit that results in too large a response will result in a 413 (Payload Too Large) response status.", "required":false, "type":"boolean", "default":false }, { "name":"scrollTTL", "in":"query", "description":"scrollTTL (in milliseconds - default and maximum value 30000 ms) specifies the period of inactivity allowed between the current and next scroll request. All responses to search with scroll include a scrollId. Subsequent scroll requests must include the scrollId returned from the previous response since the scrollId returned could change across requests. Since all scroll requests are stateless, scrollTTL is always expected. Value of scrollTTL does not have to be the same across requests. The original search query (q) is also expected with each subsequent scroll request. An invalid or expired scrollId will result in a 400 (Bad Request) response status.", "required":false, "type":"integer", "default":30000, "format":"int32" }, { "name":"scrollId", "in":"query", "description":"This parameter is used to specify the scroll id. scrollTTL and the original value of the q parameter are always required with requests that use a scrollId to get consistent results. Note that the requirement to always include the q parameter in subsequent scroll requests is currently not validated against previous requests and changes to the parameter within the same scroll session are ignored.", "required":false, "type":"string" }, { "name":"totalResults", "in":"query", "description":"Accepts a Boolean value. Setting it to true displays the total results field in the response.", "required":false, "type":"boolean", "default":false }, { "name":"orderBy", "in":"query", "description":"The orderBy parameter is used to control the order (ascending or descending) of queried items. This parameter is optional in the query and by default the results are sorted in the descending order of updatedDate. This parameter accepts featured() or field names separated by a colon (:), which the user wants to sort the results and sort order. Multiple sort orders are separated by semicolon (;).
format : orderBy={fieldName1}:{asc/desc};{fieldName2}:{asc/desc} (*Note: asc stands for ascending and des for descending. asc and des are always in lower case.)
In a type specific query, field names can be name, createdDate, updatedDate (standard fields) or user-defined fields (single-valued data types - number, decimal, datetime). All the user-defined field names should be provided with prefix fields and followed by a period (.). In the context of a cross-type search, this parameter can also have a typed section and takes the form {typename1:fields.userdefinedfieldname1:asc|desc};{typename2:fields.userdefinedfieldname1:asc|desc}. The order by parameter only supports one order by field per set of matching braces.The sort order is optional and by default it is ascending. Any incorrect or invalid field name given in the query will be ignored.When featured() is given, the results are sorted by the relevance of the items to the applied filter.

OrderBy parameter also supports sorting by a two level field. If there is a two level sort field, then it can be the only sort field in the OrderBy parameter.
OrderBy parameter also supports sorting by taxonomy root categories and sub-categories of a root category. The additional sorting parameters are
taxonomies.shortName[\"short name of taxonomy\"]:{asc/desc}; taxonomies.categories.nodes.name[\"short name of taxonomy\"|\"taxonomy name\",\"category1\",\"category2\",\"category3\"] where category1,category2,category3, etc.
are sub-categories of a given taxonomy \"taxonomy name\".

Example: orderBy=name:asc
Returns all the items in the ascending order of name.
Example: orderBy=updateDate:asc
Returns all the items in the ascending order of updateDate.
Example : orderBy=fields.age:des
Returns all the items in the descending order of age.
Example: orderBy=fields.age
Returns all the items in the ascending order of age.
Example : default=apples&orderBy=featured()
Returns all the items sorted by the relevance of the items to the apples
Example : orderBy=fields.blogauthor.authorage
Returns all the items in the ascending order of age of the author referred by referenced field \"blogauthor\".
Example : orderBy=fields.blogauthor.fields.authorage&twolvl_v1_1=true
Returns all the items in the ascending order of age of the author referred by referenced field \"blogauthor\".
Example : orderBy=taxonomies.shortName[\"loc\"];taxonomies.categories.nodes.name[\"loc\"|\"Location\",\"emea\",\"china\",\"industry\"];
taxonomies.categories.nodes.name[\"loc\"|\"Location\",\"americas\",\"brazil\",\"industry\"]
Returns all the items sorted in ascending order of root category of \"loc\", sub-categories of category having path \"/Location/emea/china/industry\", sub-categories of category having path \"/Location/americas/brazil/industry\".
", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby, first, last, prev, next.
Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" }, { "name":"twolvl_v1_1", "in":"query", "description":"This parameter does not need a value and when used indicates that the two level search api uses (i) fields.refname.fieldname to search on system fields such as name, description, etc of the referred type; and (ii) fields.refname.fields.userfieldname to search on user defined fields of the referred type. When this parameter is not used, two level search behaves in compatibility mode and only supports searches like fields.reftype.fieldname. Furthermore, when fieldname is the same as a system defined field name, two level search behaves the same as fields.reftype.fields.fieldname.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/CollectionProperties" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-get", "x-filename-id":"preview-api-v1.1-items-get" } }, "/preview/api/v1.1/items/{id}":{ "get":{ "tags":[ "Item" ], "summary":"Preview an item", "description":"Previews the latest management version of the item that is ready for publishing or published. An item is uniquely identified by an ID.
Each preview item has the following information:
  1. Standard fields: These are fields created by the system.
  2. User-defined fields: These are fields created by the user when the type is defined. All user fields are available under the fields node.

    3. Request Headers :
    Is requiredHeader NameHeader Value
    RequiredchannelToken{valid channel token value}
    OptionalAcceptapplication/json
    ", "operationId":"getItemPreview_1", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand parameter provides the option of getting child resources (referenced items) inline with the item's response. Accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). If these fields are of a reference type, then the resource expands their data inline in the response. Field names are case-sensitive. When expand is specified as all (in lowercase), all the fields of the reference type of the requested item are expanded. When expand is not specified, the item response contains links to the referenced items.
    Expansion of this form is supported for one level only, a request to expand beyond the first level of referenced fields will produce response HTTP 400. When the expand contains a non-existing field as per the type definition of the requested item, the resource produces HTTP 400.
    Examples:
      expand=fields.field1,fields.field2
      expand=all
    where field1, field2 are names of the user-defined fields in the type to which this item belongs.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
    Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/Item" } }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-{id}-get", "x-filename-id":"preview-api-v1.1-items-id-get" } }, "/preview/api/v1.1/assets/{id}/{rendition}":{ "get":{ "tags":[ "Renditions" ], "summary":"Preview a specific rendition of the digital asset", "description":"Renders a specific rendition of latest version of a digital asset. The content-type header received in the response has the media type information.

    Request Headers (Optional):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getDeliveryRendition", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"rendition", "in":"path", "description":"Rendition name of the Digital Asset.", "required":true, "type":"string" }, { "name":"format", "in":"query", "description":"Media type extension of the Digital Asset file. When the rendition has only one format, the format query parameter can be omitted.", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"Rendition type of the Digital Asset.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-{id}-{rendition}-get", "x-filename-id":"preview-api-v1.1-assets-id-rendition-get" } }, "/preview/api/v1.1/assets/{id}/{rendition}/{filename}":{ "get":{ "tags":[ "Renditions" ], "summary":"Preview a specific rendition of the digital asset using filename", "description":"Get the rendition of latest version of a digital asset using both the ID and filename. The content-type header received in the response has the media type information.

    Request Headers (Optional):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getDeliveryRenditionWithFileName", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"rendition", "in":"path", "description":"Rendition name of the Digital Asset.", "required":true, "type":"string" }, { "name":"filename", "in":"path", "description":"Name of the Digital item, special characters in name must be encoded", "required":true, "type":"string" }, { "name":"format", "in":"query", "description":"Media type extension of the Digital Asset file. When the rendition has only one format, the format query parameter can be omitted.", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"Rendition type of the Digital Asset.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-{id}-{rendition}-{filename}-get", "x-filename-id":"preview-api-v1.1-assets-id-rendition-filename-get" } }, "/preview/api/v1.1/assets/{id}/native":{ "get":{ "tags":[ "Renditions" ], "summary":"Preview digital asset's native file", "description":"Renders the native file. In the content-type header received in the response has the media type information.

    Request Headers (Required):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getNativePreview_2", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-{id}-native-get", "x-filename-id":"preview-api-v1.1-assets-id-native-get" } }, "/preview/api/v1.1/assets/{id}/native/{filename}":{ "get":{ "tags":[ "Renditions" ], "summary":"Preview digital asset's native file using filename", "description":"Renders the native file of a digital asset using both the ID and filename. The content-type header received in the response has the media type information.

    Request Headers (Required):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getNativePreviewWithFileName_2", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"filename", "in":"path", "description":"Name of the Digital item, special characters in name must be encoded", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-{id}-native-{filename}-get", "x-filename-id":"preview-api-v1.1-assets-id-native-filename-get" } }, "/preview/api/v1.1/assets/.by.slug/{slug}/native":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview digital asset's native file by slug", "description":"Renders the native file. In the content-type header received in the response has the media type information.

    Request Headers (Optional):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getNativePreview", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-.by.slug-{slug}-native-get", "x-filename-id":"preview-api-v1.1-assets-slug-slug-native-get" } }, "/preview/api/v1.1/assets/.by.slug/{slug}/native/{filename}":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview digital asset's native file by slug using filename", "description":"Renders the native file of latest version of a digital asset using both the slug and filename. The content-type header received in the response has the media type information.

    Request Headers (Optional):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getNativePreviewWithFileName", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"filename", "in":"path", "description":"Name of the Digital item, special characters in name must be encoded", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-.by.slug-{slug}-native-{filename}-get", "x-filename-id":"preview-api-v1.1-assets-slug-slug-native-filename-get" } }, "/preview/api/v1.1/assets/.by.slug/{slug}/{rendition}":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview a specific rendition of the digital asset by slug", "description":"Renders a specific rendition of latest version of a digital asset. The content-type header received in the response has the media type information.

    Request Headers (Optional):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getPreviewRendition", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"rendition", "in":"path", "description":"Rendition name of the Digital Asset.", "required":true, "type":"string" }, { "name":"format", "in":"query", "description":"Media type extension of the Digital Asset file. When the rendition has only one format, the format query parameter can be omitted.", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"Rendition type of the Digital Asset.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-.by.slug-{slug}-{rendition}-get", "x-filename-id":"preview-api-v1.1-assets-slug-slug-rendition-get" } }, "/preview/api/v1.1/assets/.by.slug/{slug}/{rendition}/{filename}":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview a specific rendition of the digital asset by slug using filename", "description":"Get the rendition of latest version of a digital asset using both the slug and filename. The content-type header received in the response has the media type information.

    Request Headers (Optional):
    Header NameHeader Value
    channelToken{valid channel token value}
    ", "operationId":"getPreviewRenditionWithFileName", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"rendition", "in":"path", "description":"Rendition name of the Digital Asset.", "required":true, "type":"string" }, { "name":"filename", "in":"path", "description":"Name of the Digital item, special characters in name must be encoded", "required":true, "type":"string" }, { "name":"format", "in":"query", "description":"Media type extension of the Digital Asset file. When the rendition has only one format, the format query parameter can be omitted.", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"Rendition type of the Digital Asset.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-assets-.by.slug-{slug}-{rendition}-{filename}-get", "x-filename-id":"preview-api-v1.1-assets-slug-slug-rendition-filename-get" } }, "/preview/api/v1.1/items/.by.slug/{slug}":{ "get":{ "tags":[ "Items by slug" ], "summary":"Preview an item by slug", "description":"Previews the latest management version of the item by slug value that is ready for publishing or published. An item is uniquely identified by slug.
    Each preview item has the following information:
    1. Standard fields: These are fields created by the system.
      • id: ID of the item.
      • type: Type of the item.
      • name: Name of the item.
      • typeCategory: Category of the type.
      • description: Description of the item.
      • slug : A URL part that identifies the item in human-readable format.
      • language : Language of the Item.
      • createdDate: Created date of the item on the channel requested.
      • updatedDate: Updated date of the item on the channel requested.
    2. User-defined fields: These are fields created by the user when the type is defined. All user fields are available under the fields node.

      3. Request Headers :
      Is requiredHeader NameHeader Value
      RequiredchannelToken{valid channel token value}
      OptionalAcceptapplication/json
      ", "operationId":"getItemPreview", "produces":[ "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand parameter provides the option of getting child resources (referenced items) inline with the item's response. Accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). If these fields are of a reference type, then the resource expands their data inline in the response. Field names are case-sensitive. When expand is specified as all (in lowercase), all the fields of the reference type of the requested item are expanded. When expand is not specified, the item response contains links to the referenced items.
      Expansion of this form is supported for one level only, a request to expand beyond the first level of referenced fields will produce response HTTP 400. When the expand contains a non-existing field as per the type definition of the requested item, the resource produces HTTP 400.
      Examples:
        expand=fields.field1,fields.field2
        expand=all
      where field1, field2 are names of the user-defined fields in the type to which this item belongs.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/Item" } }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-.by.slug-{slug}-get", "x-filename-id":"preview-api-v1.1-items-slug-slug-get" } }, "/preview/api/v1.1/items/.by.slug/{slug}/taxonomies":{ "get":{ "tags":[ "Items by slug" ], "summary":"Preview taxonomies and categories of an item by slug", "description":"Lists all promoted versions of taxonomies and categories of an item targeted to the specific channel by slug.", "operationId":"getItemTaxonomiesBySlug", "produces":[ "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/TaxonomiesBean" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-.by.slug-{slug}-taxonomies-get", "x-filename-id":"preview-api-v1.1-items-slug-slug-taxonomies-get" } }, "/preview/api/v1.1/items/.by.slug/{slug}/variations":{ "get":{ "tags":[ "Items by slug" ], "summary":"Preview item variations by slug", "description":"Preview of all variations of an Item by slug.", "operationId":"previewItemVariationsBySlug", "produces":[ "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/ItemSubResourceListVariationsInfo" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-.by.slug-{slug}-variations-get", "x-filename-id":"preview-api-v1.1-items-slug-slug-variations-get" } }, "/preview/api/v1.1/items/.by.slug/{slug}/variations/{variationType}":{ "get":{ "tags":[ "Items by slug" ], "summary":"Preview item variations by variation type by slug", "description":"Preview of all item variations by slug filtered by variation type.", "operationId":"previewItemVariationsByTypeBySlug", "produces":[ "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"variationType", "in":"path", "description":"Type of the variation. Possible value: language", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/VariationsInfo" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-.by.slug-{slug}-variations-{variationType}-get", "x-filename-id":"preview-api-v1.1-items-slug-slug-variations-variationtype-get" } }, "/preview/api/v1.1/items/.by.slug/{slug}/variations/{variationType}/{varValue}":{ "get":{ "tags":[ "Items by slug" ], "summary":"Preview a specific item variation by variation type and value by slug", "description":"Previews the latest version of item variation by slug filtered by variation type and variation value.", "operationId":"previewItemByVariationValueBySlug", "produces":[ "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"variationType", "in":"path", "description":"Type of the variation. Possible value: language", "required":true, "type":"string" }, { "name":"varValue", "in":"path", "description":"Value of the variation type. Example: en-US, fr etc.", "required":true, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand parameter provides the option of getting child resources (referenced items) inline with the item's response. Accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). If these fields are of a reference type, then the resource expands their data inline in the response. Field names are case-sensitive. When expand is specified as all (in lowercase), all the fields of the reference type of the requested item are expanded. When expand is not specified, the item response contains links to the referenced items.
      Expansion of this form is supported for one level only, a request to expand beyond the first level of referenced fields will produce response HTTP 400. When the expand contains a nonexisting field as per the type definition of the requested item, the resource produces HTTP 400.
      Examples:
        expand=fields.field1,fields.field2
        expand=all
      where field1, field2 are names of the user-defined fields in the type to which this item belongs.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/Item" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-.by.slug-{slug}-variations-{variationType}-{varValue}-get", "x-filename-id":"preview-api-v1.1-items-slug-slug-variations-variationtype-varvalue-get" } }, "/preview/api/v1.1/items/{id}/taxonomies":{ "get":{ "tags":[ "Item" ], "summary":"Preview taxonomies and categories of an item", "description":"Lists all promoted versions of taxonomies and categories of an item targeted to the specific channel.", "operationId":"getItemTaxonomies", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/TaxonomiesBean" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-{id}-taxonomies-get", "x-filename-id":"preview-api-v1.1-items-id-taxonomies-get" } }, "/preview/api/v1.1/items/{id}/variations":{ "get":{ "tags":[ "Item variations" ], "summary":"Preview item variations", "description":"Preview of all item variations.", "operationId":"previewItemVariations", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/ItemSubResourceListVariationsInfo" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-{id}-variations-get", "x-filename-id":"preview-api-v1.1-items-id-variations-get" } }, "/preview/api/v1.1/items/{id}/variations/{variationType}":{ "get":{ "tags":[ "Item variations" ], "summary":"Preview item variations by variation type", "description":"Preview of all item variations filtered by variation type.", "operationId":"previewItemVariationsByType", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"variationType", "in":"path", "description":"Type of the variation. Possible value: language", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/VariationsInfo" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-{id}-variations-{variationType}-get", "x-filename-id":"preview-api-v1.1-items-id-variations-variationtype-get" } }, "/preview/api/v1.1/items/{id}/variations/{variationType}/{varValue}":{ "get":{ "tags":[ "Item variations" ], "summary":"Preview a specific item variation by variation type and value", "description":"Previews the latest version of item variation filtered by variation type and variation value.", "operationId":"previewItemByVariationValue", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of an item.", "required":true, "type":"string" }, { "name":"variationType", "in":"path", "description":"Type of the variation. Possible value: language", "required":true, "type":"string" }, { "name":"varValue", "in":"path", "description":"Value of the variation type. Example: en-US, fr etc.", "required":true, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand parameter provides the option of getting child resources (referenced items) inline with the item's response. Accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). If these fields are of a reference type, then the resource expands their data inline in the response. Field names are case-sensitive. When expand is specified as all (in lowercase), all the fields of the reference type of the requested item are expanded. When expand is not specified, the item response contains links to the referenced items.
      Expansion of this form is supported for one level only, a request to expand beyond the first level of referenced fields will produce response HTTP 400. When the expand contains a nonexisting field as per the type definition of the requested item, the resource produces HTTP 400.
      Examples:
        expand=fields.field1,fields.field2
        expand=all
      where field1, field2 are names of the user-defined fields in the type to which this item belongs.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/Item" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-items-{id}-variations-{variationType}-{varValue}-get", "x-filename-id":"preview-api-v1.1-items-id-variations-variationtype-varvalue-get" } }, "/preview/api/v1.1/personalization/recommendationResults/.by.id/{id}":{ "post":{ "tags":[ "Recommendations" ], "summary":"Preview the results from the recommendation by id.", "description":"Preview the results of the recommendation specified by the recommendation id. This endpoint is used to run and preview the recommendation by specifying values for the audience attributes defined in the recommendation.

      Audience attributes must be specified as part of the query parameters as name value pairs prepended with the keyword attribute as follows: attribute.\\.\\=\\

      Example: ?attribute.custom.myAttribute1=value1&attribute.custom.myAttribute2=value2

      \n

      Where multivalued audience attributes are allowed, they should be provided in the query by repeating the name value pairs.

      Example: ?attribute.custom.myMultiValue=value1&attribute.custom.myMultiValue=value2 etc.

      \nNote: Taxonomy related information in the response will not be shown until the taxonomy is published to the specified channel although filtering categorized assets using rules with promoted version of taxonomies and it's categories is allowed", "operationId":"invokeRecommendationById", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Id of the recommendation.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Array of audience attribute name value pairs. These will be used as input to the recommendation.

      Attribute entries can be provided as a single value:
      \"\\.\\\" : \"\\\"
      or as an array in the case of multi value attributes:
      \"\\.\\\" : [\"\\\", \"\\\", ... ]

      NOTE: Audience attributes specified in the query will override audience attributes specified in the body.
      For preview of recommendations, only valid value for asset state is PREVIEW", "required":false, "schema":{ "$ref":"#/definitions/RecommendationTest" } }, { "name":"attribute.category.attributeName", "in":"query", "description":"List of audience attributes. Any special characters present must be encoded.The audience attributes should be prefixed with the keyword attribute:

      attribute.\\.\\=\\

      Example: ?attribute.custom.myAttribute1=value1&attribute.custom.myAttribute2=value2

      ", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }, { "name":"fields", "in":"query", "description":"The fields parameter is used to control the returned fields and values in the queried item. This parameter accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). These fields will be returned for each queried item. As all the field names are case-sensitive, users must provide the correct field names in the search query. When fields is specified as all (case-insensitive), in case of a type-specific query, all the standard fields, and user-defined fields except largetext, json, location datatype are returned for each queried item, whereas in case of a query across all types, only all standard fields are returned. The standard fields id and type are always returned in the response and cannot be filtered out. This parameter is optional in the query and by default query result shows only id, name, description, and type in the response. Any incorrect or invalid field name given in the query will be ignored.

      In the context of a brace style cross-type query, type specific fields may be specified using syntax name,{typename1:fields.userdefinedfieldname1,fields.userdefinedfieldname2},{typename2:fields.userdefinedfieldname1}.In the preceding example, all items of type typename1 will have fields - name, userdefinedfieldname1 and userdefinedfieldname2, while all items of type typename2 will have fields - name, userdefinedfieldname1. If the cross-type query does not resolve to types referenced in the typed fields clause(s), an error will be thrown. Example: ?q=(type eq \"LocationType\")&fields=fields.state,fields.country,updatedDate
      This returns id, type, state, country, updatedDate in the search results for a LocationType with state and country fields.
      Example: ?q=(type eq \"LocationType\")&fields=all
      This will return all standard fields and all user-defined fields except largetext, json, location data types
      Example: ?fields=all
      This will return only standard fields (id, type, typeCategory, name, description, slug, language, createdDate, updatedDate, taxonomies, renditions) since Type is not used in the search query (acts as a Global query)
      ", "required":false, "type":"string", "default":"name,description" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Start index of response rows.", "required":false, "type":"integer", "default":0, "format":"int32" }, { "name":"limit", "in":"query", "description":"This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.", "required":false, "type":"integer", "default":100, "format":"int32" }, { "name":"totalResults", "in":"query", "description":"Accepts a boolean value. This value is always set to true and displays the total results in the response.", "required":false, "type":"boolean", "default":true }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby, first, last, prev, next.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/CollectionProperties" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-personalization-recommendationResults-.by.id-{id}-post", "x-filename-id":"preview-api-v1.1-personalization-recommendationresults-id-id-post" } }, "/preview/api/v1.1/personalization/recommendationResults/{apiName}":{ "post":{ "tags":[ "Recommendations" ], "summary":"Preview the results from the recommendation by apiName.", "description":"Preview the results of the recommendation specified by the apiName. This endpoint is used to run and preview the recommendation by specifying values for the audience attributes defined in the recommendation.

      Audience attributes must be specified as part of the query parameters as name value pairs prepended with the keyword attribute as follows: attribute.\\.\\=\\

      Example: ?attribute.custom.myAttribute1=value1&attribute.custom.myAttribute2=value2

      \n

      Where multivalued audience attributes are allowed, they should be provided in the query by repeating the name value pairs.

      Example: ?attribute.custom.myMultiValue=value1&attribute.custom.myMultiValue=value2 etc.

      \nNote: Taxonomy related information in the response will not be shown until the taxonomy is published to the specified channel although filtering categorized assets using rules with promoted version of taxonomies and it's categories is allowed", "operationId":"previewRecommendation", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"apiName", "in":"path", "description":"API name of the recommendation. Any special characters present must be encoded.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Array of audience attribute name value pairs. These will be used as input to the recommendation.

      Attribute entries can be provided as a single value:
      \"\\.\\\" : \"\\\"
      or as an array in the case of multi value attributes:
      \"\\.\\\" : [\"\\\", \"\\\", ... ]

      NOTE: Audience attributes specified in the query will override audience attributes specified in the body.
      For preview of recommendations, only valid value for asset state is PREVIEW", "required":false, "schema":{ "$ref":"#/definitions/RecommendationTest" } }, { "name":"attribute.category.attributeName", "in":"query", "description":"List of audience attributes. Any special characters present must be encoded.The audience attributes should be prefixed with the keyword attribute:

      attribute.\\.\\=\\

      Example: ?attribute.custom.myAttribute1=value1&attribute.custom.myAttribute2=value2

      ", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }, { "name":"fields", "in":"query", "description":"The fields parameter is used to control the returned fields and values in the queried item. This parameter accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). These fields will be returned for each queried item. As all the field names are case-sensitive, users must provide the correct field names in the search query. When fields is specified as all (case-insensitive), in case of a type-specific query, all the standard fields, and user-defined fields except largetext, json, location datatype are returned for each queried item, whereas in case of a query across all types, only all standard fields are returned. The standard fields id and type are always returned in the response and cannot be filtered out. This parameter is optional in the query and by default query result shows only id, name, description, and type in the response. Any incorrect or invalid field name given in the query will be ignored.

      In the context of a brace style cross-type query, type specific fields may be specified using syntax name,{typename1:fields.userdefinedfieldname1,fields.userdefinedfieldname2},{typename2:fields.userdefinedfieldname1}.In the preceding example, all items of type typename1 will have fields - name, userdefinedfieldname1 and userdefinedfieldname2, while all items of type typename2 will have fields - name, userdefinedfieldname1. If the cross-type query does not resolve to types referenced in the typed fields clause(s), an error will be thrown. Example: ?q=(type eq \"LocationType\")&fields=fields.state,fields.country,updatedDate
      This returns id, type, state, country, updatedDate in the search results for a LocationType with state and country fields.
      Example: ?q=(type eq \"LocationType\")&fields=all
      This will return all standard fields and all user-defined fields except largetext, json, location data types
      Example: ?fields=all
      This will return only standard fields (id, type, typeCategory, name, description, slug, language, createdDate, updatedDate, taxonomies, renditions) since Type is not used in the search query (acts as a Global query)
      ", "required":false, "type":"string", "default":"name,description" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Start index of response rows.", "required":false, "type":"integer", "default":0, "format":"int32" }, { "name":"limit", "in":"query", "description":"This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.", "required":false, "type":"integer", "default":100, "format":"int32" }, { "name":"totalResults", "in":"query", "description":"Accepts a boolean value. This value is always set to true and displays the total results in the response.", "required":false, "type":"boolean", "default":true }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby, first, last, prev, next.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "201":{ "description":"Successfully created", "schema":{ "$ref":"#/definitions/CollectionProperties" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-personalization-recommendationResults-{apiName}-post", "x-filename-id":"preview-api-v1.1-personalization-recommendationresults-apiname-post" } }, "/preview/api/v1.1/taxonomies":{ "get":{ "tags":[ "Taxonomies" ], "summary":"List taxonomies", "description":"Returns promoted versions of all the taxonomies published to the specified channel.", "operationId":"previewTaxonomies", "produces":[ "application/json" ], "parameters":[ { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Start index of response rows.", "required":false, "type":"integer", "default":0, "format":"int32" }, { "name":"limit", "in":"query", "description":"This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.", "required":false, "type":"integer", "default":100, "format":"int32" }, { "name":"totalResults", "in":"query", "description":"Accepts a Boolean value. Setting it to true displays the total results field in the response.", "required":false, "type":"boolean", "default":false }, { "name":"orderBy", "in":"query", "description":"The orderBy parameter is used to control the order (ascending or descending) of queried taxonomies. This parameter is optional in the query and by default there is no order of results. This parameter accepts field names separated by a colon (:), which the user wants to sort the results and sort order.
      format: orderBy={fieldName}:{asc/des} (*Note: asc stands for ascending and des for descending. asc and des are always in lower case.)
      Field names can be name, createdDate, updatedDate (standard fields). The sort order is optional and by default it is ascending. Any incorrect or invalid field name given in the query will be ignored.

      Example: orderBy=name:asc
      Returns all the taxonomies in the ascending order of name.
      Example: orderBy=updatedDate:asc
      Returns all the taxonomies in the ascending order of updatedDate.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand parameter provides the option of getting child resources (referenced items) inline with the taxonomy's response. Accepts a comma-separated list of field names or all. This field is currently ignored.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby, first, last, prev, next.
      Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/CollectionProperties" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-taxonomies-get", "x-filename-id":"preview-api-v1.1-taxonomies-get" } }, "/preview/api/v1.1/taxonomies/{id}":{ "get":{ "tags":[ "Taxonomies" ], "summary":"Preview of a taxonomy", "description":"Returns promoted version of taxonomy if its published to the specified channel. A taxonomy is uniquely identified by an id.
      Each published taxonomy has the following information:
      1. Standard fields: These are fields created by the system.
        • id: ID of the taxonomy.
        • name: Name of the taxonomy.
        • description : Description of the taxonomy.
        • shortName: Short name of the taxonomy.
        • customProperties: Custom properties defined for the taxonomy.
        • updatedDate : Last published date of the taxonomy on the channel requested.

        2. Request Headers:
        Is requiredHeader NameHeader Value
        RequiredchannelToken{valid channel token value}
        OptionalAcceptapplication/json
        ", "operationId":"previewTaxonomy", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of a taxonomy.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand parameter provides the option of getting child resources (referenced items) inline with the taxonomy's response. Accepts a comma-separated list of field names or all. This field is currently ignored.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
        Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/Taxonomy" } }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-taxonomies-{id}-get", "x-filename-id":"preview-api-v1.1-taxonomies-id-get" } }, "/preview/api/v1.1/taxonomies/{id}/categories":{ "get":{ "tags":[ "Taxonomies" ], "summary":"List categories", "description":"Returns promoted versions of all categories if taxonomy is published to the specified channel. Use this query to preview the list of categories. You can control the number of categories to be fetched, paginated, and sorted. Additionally, this resource can fetch field values of matching items.
        Query expression syntax supports conditions that match the field values. Query conditions can be joined by using AND/OR operators and grouped with parenthesis. Below are general examples of queries.

        Query expression ?q=(name co \"car\")
        Query expression usage with this resource /preview/api/v1.1/taxonomies/{id}/categories?q=(name co \"car\")


        In general one form of filtering is supported by this resource.
        • Query all categories within a taxonomy: All categories of the taxonomy are queried. However, query conditions are limited to standard fields (id, name, parent.id) and/or optional fields (ancestors.id, ancestors.name, ancestors.apiName).
          For example: /preview/api/v1.1/taxonomies/{id}/categories?q=(id eq \"B0A39B47122C4CE88A6CD52B90C15263\")





        OperatorExampleSupported data typesDescription
        eqq=(id eq \"B0A39B47122C4CE88A6CD52B90C15263\")

        q=(name eq \"Cars\")

        q=(parent.id eq \"C7117D407B1845DEAABBE00526D112FB\")

        q=(ancestors.id eq \"C7117D407B1845DEAABBE00526D112FB\")

        q=(ancestors.name eq \"car\")

        q=(ancestors.apiName eq \"tax-c-c1\")        		textEquals operator (eq) matches the exact value supplied in the query. The value provided with this operator is not case-sensitive (name) except for identifier fields (id, parent.id, ancestors.id). This operator considers even special characters in the value.
        coq=(name co \"car red\")

        q=(ancestors.name co \"car\")

        		textContains operator (co) matches every word given in the criteria. It gives the results that have at least one of the words (in this example, car or red or both). This operator does not consider special characters in the value while searching.

        This operator is applicable to text in case of single-valued attributes. The value provided with this operator is not case-sensitive.
        swq=(name sw \"Car\")

        q=(ancestors.name sw \"ca\")        		textStarts With operator (sw) matches only the initial character values given in the field condition. The value provided with this operator is not case-sensitive.



        Request Headers:
        Is requiredHeader NameHeader Value
        RequiredchannelToken{valid channel token value}
        OptionalAcceptapplication/json
        ", "operationId":"previewCategories", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of a taxonomy.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"q", "in":"query", "description":"This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using AND/OR operators and grouped with parentheses. The value of query condition follows the format of {fieldName} {operator} \"{fieldValue}\". The only values allowed in the operator are eq (Equals), co (Contains), sw (Startswith) and mt (Matches).
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(name eq \"Furnitures\")
        This will return all categories matching exactly the name \"Furnitures\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(name co \"chairs\" OR name co \"red\")
        This will return all categories containing the words \"chairs\" or \"red\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(name sw \"cars\")
        This will return all categories which name start with \"cars\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(apiName eq \"cars-apiname\")
        This will return all categories which apiName matches \"cars-apiname\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(id eq \"B0A39B47122C4CE88A6CD52B90C15263\")
        This will return a category with the given identifier.
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(ancestors.id eq \"B0A39B47122C4CE88A6CD52B90C15263\")
        This will return the categories with an ancestor with the given identifier.
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(ancestors.name eq \"Furnitures\")
        This will return all categories with an ancestor matching exactly the name \"Furnitures\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(ancestors.name co \"chairs\" OR ancestors.name co \"red\")
        This will return all categories with an ancestor containing the words \"chairs\" or \"red\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(ancestors.name sw \"cars\")
        This will return all categories with an ancestor which name starts with \"cars\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(ancestors.apiName eq \"cars-apiname\")
        This will return all categories which apiName matches \"cars-apiname\".
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(parent.id eq \"C7117D407B1845DEAABBE00526D112FB\")&orderBy=position:asc
        This will return all children categories underneath the given parent identifier sorted by their position in ascending order.
        Example:
        https://{cecsdomain}/content/preview/api/v1.1/taxonomies/{id}/categories?q=(parent.id eq \"C7117D407B1845DEAABBE00526D112FB\" AND name co \"blue\")
        This will return all children categories underneath the given parent identifier which contains the word \"blue\" in their names.", "required":false, "type":"string" }, { "name":"fields", "in":"query", "description":"The fields parameter is used to control the returned fields and values in the queried category. This parameter accepts a comma-separated list of field names or all. These fields will be returned for each queried category. As all the field names are case-sensitive, users must provide the correct field names in the search query. When fields is specified as all (case-insensitive), all the standard fields and optional fields are returned for each category. Each category has both standard fields (id, name, description, parent) and optional fields (ancestors, children). The standard field id is always returned in the response and cannot be filtered out. This parameter is optional in the query and by default query result shows only id, name and description in the response. Any incorrect or invalid field name given will result in an error.

        Example: ?q=(name co \"car\")&fields=name,description,parent,ancestors
        This returns id, name, description, parent and ancestors in the search results for a category containing \"car\" in the name field.
        Example: ?fields=name,parent
        This will return only standard fields (such as id, name and parent) for all categories within the default limit.
        Example: ?fields=name,children
        This will return only id, name and the children count for all categories within the default limit.
        ", "required":false, "type":"string", "default":"name,description" }, { "name":"offset", "in":"query", "description":"Start index of response rows.", "required":false, "type":"integer", "default":0, "format":"int32" }, { "name":"limit", "in":"query", "description":"This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.", "required":false, "type":"integer", "default":100, "format":"int32" }, { "name":"totalResults", "in":"query", "description":"Accepts a Boolean value. Setting it to true displays the total results field in the response.", "required":false, "type":"boolean", "default":false }, { "name":"orderBy", "in":"query", "description":"The orderBy parameter is used to control the order (ascending or descending) of queried items. This parameter is optional in the query and by default there is no order of results. This parameter accepts field names separated by a colon (:), which the user wants to sort the results and sort order.
        format: orderBy={fieldName}:{asc/des} (*Note: asc stands for ascending and des for descending. asc and des are always in lower case.)
        In a category query, fieldName can be name or position (standard field). When sorting results by position it is important to remember that only searches by parent.id can actually benefit from it. The category position is unique only within a given level or under a given parent category. There will be different categories with the same position value at different levels of the taxonomy. The sort order is optional and by default it is ascending. Any incorrect or invalid field name given will result in an error.

        Example: orderBy=name:asc
        Returns all categories in ascending order of name.

        Example: orderBy=name:des
        Returns all categories in descending order of name.

        Example: orderBy=position:asc
        Returns all categories in ascending order of position.

        Example: orderBy=position:des
        Returns all categories in descending order of position.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby, first, last, prev, next.
        Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/CollectionProperties" } }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-taxonomies-{id}-categories-get", "x-filename-id":"preview-api-v1.1-taxonomies-id-categories-get" } }, "/preview/api/v1.1/taxonomies/{id}/categories/{categoryId}":{ "get":{ "tags":[ "Taxonomies" ], "summary":"Preview a category", "description":"Returns promoted version of category if taxonomy is published to the specified channel. A category is uniquely identified by an id.
        Each category has the following information:
        1. Standard fields: These are fields created by the system.
          • id: ID of the category.
          • name: Name of the category.
          • description : Description of the category.
          • parent: Parent of the category.
          • ancestors: Ancestors of the category. Each position in this array represents an ancestor category from first to last position. First category in the array represents the root category and the last category in the array represents the immediate parent of the requested resource.

          2. Request Headers:
          Is requiredHeader NameHeader Value
          RequiredchannelToken{valid channel token value}
          OptionalAcceptapplication/json
          ", "operationId":"previewCategory", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier (ID) of a taxonomy.", "required":true, "type":"string" }, { "name":"categoryId", "in":"path", "description":"Unique identifier (ID) for a category.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand parameter provides the option of getting child resources (referenced items) inline with the category's response. Accepts a comma-separated list of field names or all. Field names are case-sensitive. When expand is specified as all (with all in lower case), all the fields of the requested category are expanded. When expand is not specified, the category response contains links to the referenced children. Expansion of this form is supported for one level only. When the expand parameter contains a nonexistent field as per category definition, the resource produces HTTP 400.

          Example : expand=children
          Returns children categories sorted by their respective position ascending. This sort order cannot be changed in this request.
          Example : expand=all
          Returns child resources (children) available for this category. Only the first 1000 children categories will be expanded.", "required":false, "type":"string" }, { "name":"links", "in":"query", "description":"Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
          Example: links=self,canonical will only return the links with the rel property self or canonical.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation.", "schema":{ "$ref":"#/definitions/CategoryInformation" } }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-api-v1.1-taxonomies-{id}-categories-{categoryId}-get", "x-filename-id":"preview-api-v1.1-taxonomies-id-categories-categoryid-get" } }, "/preview/assets/{slug}/native":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview digital asset's native file by slug using Vanity URL", "description":"Renders the native file. In the content-type header received in the response has the media type information.

          Request Headers (Optional):
          Header NameHeader Value
          channelToken{valid channel token value}
          ", "operationId":"getNativePreview_1", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-assets-{slug}-native-get", "x-filename-id":"preview-assets-slug-native-get" } }, "/preview/assets/{slug}/native/{filename}":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview digital asset's native file by slug using filename by Vanity URL", "description":"Renders the native file of latest version of a digital asset using both the slug and filename. The content-type header received in the response has the media type information.

          Request Headers (Optional):
          Header NameHeader Value
          channelToken{valid channel token value}
          ", "operationId":"getNativePreviewWithFileName_1", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"filename", "in":"path", "description":"Name of the Digital item, special characters in name must be encoded", "required":true, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-assets-{slug}-native-{filename}-get", "x-filename-id":"preview-assets-slug-native-filename-get" } }, "/preview/assets/{slug}/{rendition}":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview a specific rendition of the digital asset by slug using Vanity URL", "description":"Renders a specific rendition of latest version of a digital asset. The content-type header received in the response has the media type information.

          Request Headers (Optional):
          Header NameHeader Value
          channelToken{valid channel token value}
          ", "operationId":"getPreviewRendition_1", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"rendition", "in":"path", "description":"Rendition name of the Digital Asset.", "required":true, "type":"string" }, { "name":"format", "in":"query", "description":"Media type extension of the Digital Asset file. When the rendition has only one format, the format query parameter can be omitted.", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"Rendition type of the Digital Asset.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-assets-{slug}-{rendition}-get", "x-filename-id":"preview-assets-slug-rendition-get" } }, "/preview/assets/{slug}/{rendition}/{filename}":{ "get":{ "tags":[ "Renditions by slug" ], "summary":"Preview a specific rendition of the digital asset by slug using filename by Vanity URL", "description":"Get the rendition of latest version of a digital asset using both the slug and filename. The content-type header received in the response has the media type information.

          Request Headers (Optional):
          Header NameHeader Value
          channelToken{valid channel token value}
          ", "operationId":"getPreviewRenditionWithFileName_1", "produces":[ "application/octet-stream", "application/json" ], "parameters":[ { "name":"slug", "in":"path", "description":"Slug value of the item to be previewed.", "required":true, "type":"string" }, { "name":"rendition", "in":"path", "description":"Rendition name of the Digital Asset.", "required":true, "type":"string" }, { "name":"filename", "in":"path", "description":"Name of the Digital item, special characters in name must be encoded", "required":true, "type":"string" }, { "name":"format", "in":"query", "description":"Media type extension of the Digital Asset file. When the rendition has only one format, the format query parameter can be omitted.", "required":false, "type":"string" }, { "name":"type", "in":"query", "description":"Rendition type of the Digital Asset.", "required":false, "type":"string" }, { "name":"channelToken", "in":"query", "description":"Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.", "required":false, "type":"string" }, { "name":"download", "in":"query", "description":"By default, media types such as image, audio, and video are set to inline for the content-disposition header. For all other media types, content-disposition is set to download. Users can specify the query parameter download as true/false in a request to override the default value.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation." }, "304":{ "description":"Not changed. The request honors requests with e-tag." }, "400":{ "description":"Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing." }, "403":{ "description":"Forbidden. Client is not authorized to perform this request." }, "404":{ "description":"The requested resource was not found." }, "500":{ "description":"Internal server error. An unexpected error condition encountered in the system." } }, "x-internal-id":"preview-assets-{slug}-{rendition}-{filename}-get", "x-filename-id":"preview-assets-slug-rendition-filename-get" } } }, "definitions":{ "CategoryItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the category." }, "name":{ "type":"string", "description":"The name of the category" }, "apiName":{ "type":"string", "description":"The apiName of the category" }, "nodes":{ "type":"array", "description":"The nodes of the category assigned to the item.", "items":{ "$ref":"#/definitions/CategoryNodeItem" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } } }, "description":"CategoryItem" }, "CategoryNodeItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the Category node." }, "name":{ "type":"string", "description":"The name of the Category node." }, "apiName":{ "type":"string", "description":"The apiName of the Category node." } }, "description":"CategoryNodeBean" }, "Link":{ "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." }, "TaxonomiesBean":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"Item taxonomies.", "items":{ "$ref":"#/definitions/TaxonomyItem" } }, "links":{ "type":"array", "description":"Resource links.", "items":{ "$ref":"#/definitions/Link" } } } }, "TaxonomyCategories":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"Taxonomy Categories", "items":{ "$ref":"#/definitions/CategoryItem" } } }, "description":"CategoriesBean" }, "TaxonomyItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the taxonomy." }, "name":{ "type":"string", "description":"The name of the taxonomy" }, "shortName":{ "type":"string", "description":"The short name of the taxonomy" }, "categories":{ "description":"The categories of the taxonomy", "$ref":"#/definitions/TaxonomyCategories" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } } }, "description":"TaxonomyItem" }, "Item":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"ID of the item." }, "type":{ "type":"string", "description":"Type of the item." }, "typeCategory":{ "type":"string", "readOnly":true }, "name":{ "type":"string", "description":"Name of the item." }, "description":{ "type":"string", "description":"Description of the item." }, "slug":{ "type":"string" }, "language":{ "type":"string" }, "translatable":{ "type":"boolean" }, "createdDate":{ "type":"object", "description":"Created date of the item. Map having value, timezone, and description" }, "updatedDate":{ "type":"object", "description":"Last updated date of the item. Map having value, timezone, and description" }, "fileExtension":{ "type":"string", "description":"Extension of the file." }, "fields":{ "type":"object", "description":"User-defined fields data. Map", "additionalProperties":{ "type":"object" } }, "itemVariations":{ "type":"array", "items":{ "$ref":"#/definitions/ItemVariation" } }, "taxonomies":{ "$ref":"#/definitions/TaxonomiesBean" }, "renditions":{ "$ref":"#/definitions/RenditionsBean" }, "mimeType":{ "type":"string" }, "fileGroup":{ "type":"string" }, "links":{ "type":"array", "description":"Links of the resource.", "items":{ "$ref":"#/definitions/Link" } } }, "description":"Item." }, "ItemVariation":{ "type":"object", "properties":{ "sourceVersion":{ "type":"integer", "format":"int32" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } }, "sourceId":{ "type":"string" }, "status":{ "type":"string" }, "varType":{ "type":"string" }, "slug":{ "type":"string" }, "isPublished":{ "type":"boolean" }, "setId":{ "type":"string" }, "isMaster":{ "type":"boolean" }, "type":{ "type":"string" }, "lastModified":{ "type":"string", "format":"date-time" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "value":{ "type":"string" } } }, "RenditionBean":{ "type":"object", "properties":{ "apiName":{ "type":"string" }, "formats":{ "type":"array", "items":{ "$ref":"#/definitions/RenditionFormatBean" } }, "type":{ "type":"string" } } }, "RenditionFormatBean":{ "type":"object", "properties":{ "format":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } } } }, "RenditionsBean":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"Item renditions.", "items":{ "$ref":"#/definitions/RenditionBean" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } } } }, "ItemSubResourceListVariationsInfo":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/definitions/VariationsInfo" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } } }, "description":"Variations" }, "Language":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"id of the item." }, "value":{ "type":"string", "description":"Language value" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } } }, "description":"LanguageItem" }, "VariationsInfo":{ "type":"object", "properties":{ "setId":{ "type":"string", "description":"Variation set id." }, "varType":{ "type":"string", "description":"Variation type name." }, "masterItem":{ "type":"string", "description":"Master item." }, "items":{ "type":"array", "description":"Content item variations.", "items":{ "$ref":"#/definitions/Language" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/Link" } } }, "description":"Variations Info." }, "AggregationResult":{ "type":"object", "properties":{ "name":{ "type":"string", "readOnly":true } } }, "CollectionProperties":{ "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." }, "properties":{ "type":"object", "description":"additional collection properties.", "additionalProperties":{ "type":"object" } }, "items":{ "type":"array", "description":"Singular resources contained in the collection.", "items":{ "type":"object" } }, "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":"CollectionProperties." }, "RecommendationTest":{ "type":"object", "required":[ "assetState", "audienceAttributes" ], "properties":{ "audienceAttributes":{ "type":"object", "description":"Array of audience attributes to be used in testing the recommendation. Each attribute can be proprovided as a single value:
          \"\\.\\\" : \"\\\"
          or as an array for multi value attributes:
          \"\\.\\\" : [\"\\\", \"\\\" ... ]", "additionalProperties":{ "type":"array", "items":{ "type":"string" } } }, "assetState":{ "type":"string", "description":"A Enum that is used to determine if only published assets should be returned in the testing of the recommendation. Valida values are ALL and PUBLISHED. Default value is ALLe.", "enum":[ "PUBLISHED", "ALL", "PREVIEW" ] } }, "description":"Recommendation Test" }, "CategoryAncestorBean":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the Category ancestor." }, "name":{ "type":"string", "description":"The name of the Category ancestor." }, "apiName":{ "type":"string", "description":"The apiName of the Category ancestor" } } }, "CategoryChildBean":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the child Category." }, "name":{ "type":"string", "description":"The name of the child Category." }, "description":{ "type":"string", "description":"The description of the child Category." }, "apiName":{ "type":"string", "description":"The apiName of the child Category." }, "position":{ "type":"integer", "format":"int32", "description":"The position of the child Category among its siblings.", "minimum":0 }, "links":{ "type":"array", "description":"Links", "items":{ "$ref":"#/definitions/Link" } } } }, "CategoryInformation":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the Category." }, "name":{ "type":"string", "description":"The name of the Category." }, "description":{ "type":"string", "description":"The description of the Category." }, "apiName":{ "type":"string", "description":"The apiName of the Category." }, "position":{ "type":"integer", "format":"int32", "description":"The position of the Category among its siblings.", "minimum":0 }, "parent":{ "description":"The parent of the Category.", "$ref":"#/definitions/CategoryAncestorBean" }, "ancestors":{ "type":"array", "description":"The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.", "items":{ "$ref":"#/definitions/CategoryAncestorBean" } }, "children":{ "description":"The children of the Category. Children categories are sorted by position starting from lowest to highest value. Only the first 1000 children categories will be expanded.", "$ref":"#/definitions/CollectionPropertiesCategoryChildBean" }, "keywords":{ "type":"array", "description":"The keywords of the Category.", "items":{ "type":"string" } }, "synonyms":{ "type":"array", "description":"The synonyms of the Category.", "items":{ "type":"string" } }, "relatedCategories":{ "type":"array", "description":"The related categories of the Category.", "items":{ "$ref":"#/definitions/RelatedCategory" } }, "customProperties":{ "type":"object", "description":"The custom properties' values of the Category.", "additionalProperties":{ "$ref":"#/definitions/CustomPropertyValuesBean" } }, "links":{ "type":"array", "description":"Links", "items":{ "$ref":"#/definitions/Link" } } }, "description":"Category Information" }, "CollectionPropertiesCategoryChildBean":{ "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." }, "properties":{ "type":"object", "description":"additional collection properties.", "additionalProperties":{ "type":"object" } }, "items":{ "type":"array", "description":"Singular resources contained in the collection.", "items":{ "$ref":"#/definitions/CategoryChildBean" } }, "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":"CollectionProperties." }, "CustomPropertyValue":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the custom property value.", "readOnly":true }, "value":{ "type":"string", "description":"The value of the custom property." } } }, "CustomPropertyValuesBean":{ "type":"object", "properties":{ "values":{ "type":"array", "description":"The list of values of the custom property.", "items":{ "$ref":"#/definitions/CustomPropertyValue" } } } }, "RelatedCategory":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the category." }, "name":{ "type":"string", "description":"The name of the category." }, "apiName":{ "type":"string", "description":"The apiName of the category." }, "taxonomy":{ "description":"The taxonomy of the category.", "$ref":"#/definitions/RelatedTaxonomyBean" }, "nodes":{ "type":"array", "description":"The path of the category.", "items":{ "$ref":"#/definitions/CategoryNodeItem" } } }, "description":"Related Category" }, "RelatedTaxonomyBean":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the taxonomy." }, "name":{ "type":"string", "description":"The name of the taxonomy." }, "shortName":{ "type":"string", "description":"The short name of the taxonomy." } } }, "Taxonomy":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the taxonomy." }, "name":{ "type":"string", "description":"The name of the taxonomy." }, "description":{ "type":"string", "description":"The description of the taxonomy." }, "shortName":{ "type":"string", "description":"The short name of the taxonomy." }, "customProperties":{ "type":"object", "description":"Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.", "additionalProperties":{ "type":"string" } }, "createdDate":{ "description":"Created date of the taxonomy.", "$ref":"#/definitions/date" }, "updatedDate":{ "description":"Last updated date of the taxonomy.", "$ref":"#/definitions/date" }, "links":{ "type":"array", "description":"Links", "items":{ "$ref":"#/definitions/Link" } } }, "description":"Taxonomy" }, "date":{ "type":"object", "properties":{ "value":{ "type":"string" }, "timezone":{ "type":"string" }, "description":{ "type":"string" } }, "description":"date" }, "Version":{ "type":"object", "required":[ "catalog", "isLatest", "lifecycle", "links", "version" ], "properties":{ "version":{ "type":"string", "description":"Version of the resource." }, "lifecycle":{ "type":"string", "description":"Whether a version is actively supported or deprecated." }, "isLatest":{ "type":"boolean", "description":"Whether it is latest version." }, "catalog":{ "description":"A child resource that serves as a metadata catalog for all the resources supported in the version.", "$ref":"#/definitions/Version" }, "links":{ "type":"array", "description":"Links of the resource.", "items":{ "$ref":"#/definitions/Link" } }, "terminationDate ":{ "type":"string", "format":"date-time", "description":"When a version is not supported anymore." } }, "description":"Version." } } }