The REST API for Content Management provides access to manage assets in Oracle Content Management. Assets include content items and digital assets and their renditions.
\n\nLast updated: July 2023.
", "version":"2023.07.17", "title":"REST API for Content Management", "x-summary":"The REST API for Content Management provides access to manage assets in Oracle Content Management." }, "basePath":"/content", "tags":[ { "name":"Archive", "description":"The resource to manage archived assets" }, { "name":"Archive Bulk Operations", "description":"The resource to manage bulk operations on archived assets" }, { "name":"Archive Items Search", "description":"The resource to manage archived items search" }, { "name":"Asset Refresh Bulk Operations", "description":"The resource to manage bulk operations for asset refresh." }, { "name":"Assign Primary Channel to Asset Bulk Operations", "description":"The resource to manage bulk operations for assigning primary channel." }, { "name":"AutoSuggestions", "description":"The operations from the AutoSuggestions category." }, { "name":"Channel Secret", "description":"The operations from the Channel Secret category." }, { "name":"Channels", "description":"The resources to manage channels." }, { "name":"Collections", "description":"The resources to manage collections." }, { "name":"Connectors", "description":"The operations from the Connectors category." }, { "name":"Digital Item Renditions", "description":"The resources to manage digital item renditions." }, { "name":"Digital Item Renditions by slug", "description":"The resources to manage digital item renditions by slug." }, { "name":"Editorial Roles", "description":"The operations from the Editorial Roles category." }, { "name":"File Extensions", "description":"The operations from the File Extensions category." }, { "name":"Item Revisions", "description":"The operations from the Item Revisions category." }, { "name":"Item Variations", "description":"The resources to manage items variations." }, { "name":"Items", "description":"The resources to manage items." }, { "name":"Items Bulk Download", "description":"The operations from the Items Bulk Download category." }, { "name":"Items Bulk Operations", "description":"The resources to manage bulk items operations." }, { "name":"Items Search", "description":"The resources to manage items search." }, { "name":"Items by slug", "description":"The resources to manage items by slug." }, { "name":"Language codes", "description":"The resources to manage language codes" }, { "name":"Languages", "description":"The resources to manage languages." }, { "name":"Localization Policies", "description":"The resources to manage localization policies." }, { "name":"OAuth Tokens", "description":"The operations from the OAuth Tokens category." }, { "name":"Permission Operations", "description":"The operations from the Permission Operations category." }, { "name":"Permission Sets", "description":"The operations from the Permission Sets category." }, { "name":"Provider Tokens", "description":"The operations from the Provider Tokens category." }, { "name":"Recommendations", "description":"The resource to manage recommendations." }, { "name":"Repositories", "description":"The resources to manage repositories." }, { "name":"Scheduled Jobs", "description":"The operations from the Scheduled Jobs category." }, { "name":"Taxonomies", "description":"Management taxonomies resources provides access to management taxonomies and categories." }, { "name":"Tokens", "description":"The resource to read token." }, { "name":"Types", "description":"The resources to manage types." }, { "name":"Workflow Roles", "description":"The resources to manage workflow roles." }, { "name":"Workflow Tasks", "description":"The resources to manage workflow tasks." }, { "name":"Workflows", "description":"The resources to manage workflows." } ], "paths":{ "/management/api/v1.1/archive/items":{ "get":{ "tags":[ "Archive Items Search" ], "summary":"Query Archived Items", "description":"This resource enables filtering of management content by query. 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 | ?q=(type eq \"Employee\" AND (fields.emails co \"example.com\" OR fields.emails co \"example.org\")) |
| Query expression usage with this resource | /management/api/v1.1/archive/items?q=(type eq \"Employee\" AND (fields.emails co \"example.com\" OR fields.emails co \"example.org\")) |
| Operator | Example | Supported data types | Description |
|---|---|---|---|
| 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.id eq \"773CDF9B048E429D856F3CA2A14A9CEA\") ?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 \"cars\") ?q=(taxonomies.categories.nodes.apiName eq \"cars\") ?q=(suggestedTaxonomies.categories.id eq \"B9F568DC43C54803AC76012783FA5101\") ?q=(colorTags.tagName eq \"#ff0000\") | 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. 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 \"car\") | text, reference, number, decimal, datetime, largetext | Contains 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, largetext | Not 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\") | text | Starts 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, datetime | Greater 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, datetime | Less 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, datetime | Greater 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. 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, datetime | Less than operator (lt) matches only numeric and datetime values. To understand the possible datetime formats, please refer to the section: Supported date/datetime formats (24Hrs). 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, largetext | Phrase 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 content 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 enclose search terms in 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, largetext | Similarity query operator. This operator allows searching for values that sound like specified criteria - also called fuzzy search, which uses by default a maximum of two edits to match the 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 | 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. |
| Additional Notes | |
|---|---|
| Type specific query | This query always uses only the eq operator. eq works with case-sensitive type name. Multitype query is supported, such as q=(type eq \"Employee\" OR type eq \"Address\"), however, it will be query across types. Example: q=(type eq \"Employee\" OR type eq \"DigitalAsset\") is supported because of single type search. |
| Date query | Date query is a special type of query because of various date formats associated with it. All the datetime values in the query are assumed to be in the UTC (timezone) only, unless the offset is added in ISO 8901 format. The 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/management/api/v1.1/archive/items?q=(type eq \"Product\" AND fields.manufactureDate ge \"1989-03-26\"). 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 values | \r\nDecimal 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/management/api/v1.1/archive/items?q=(type eq \"Product\" AND fields.price ge 425.3214), will result in all the products where price is greater than or equal to 425.321. | \r\n
| Large text datatype query | Fields 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 search | Generic query search is a default search query, which 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 name , description or any user-defined fields. Example: ?q=(type eq \"Article\")&default=skating. This will return the search results for Article type where the value skating matches to fields name, description or any user-defined fields. |
| ID search | Search 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 the 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\")). |
| Taxonomy search | Search items with given taxonomy id. Example: ?q=(taxonomies.id eq \"773CDF9B048E429D856F3CA2A14A9CEA\") The value of taxonomies.id belongs to the taxonomy assigned to items being queried. It is possible to include multiple taxonomy ids in the query expression. |
| Category search | Search items categorized with given category id, category name, category apiName, category node id, category node name or category node apiName attributes. 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. |
| Scheduled Restore status search | Search items by scheduled for restore status. Example: ?q=isRestoreScheduled eq \"true\" Lists all the archived items that are scheduled for restore. Example: ?q=isRestoreScheduled eq \"false\" Lists all the archived items that are not scheduled for restore. |
| Reference field search | Search query using reference attribute. Example: ?q=(type eq \"Employee\" AND fields.department eq \"COREAF29AC6ACA9644F9836E36C7B558F412\"). The value of department belongs to the id of an item of type Department. |
| Query matching text in binary file | Searching 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\") |
| Supported date/datetime formats (24Hrs) | |
|---|---|
| Format | Example |
| YYYY-MM-DD | 1989-03-26 |
| YYYY/MM/DD | 1989/03/26 |
| DD-MM-YYYY | 26-03-1989 |
| DD/MM/YYYY | 26/03/1989 |
| YYYY-MM-DD''T''hh:mm:ss | 1989-03-26T18:32:38 |
| YYYY/MM/DD''T''hh:mm:ss | 1989/03/26T18:32:38 |
| DD-MM-YYYY''T''hh:mm:ss | 26-03-1989T18:32:38 |
| DD/MM/YYYY''T''hh:mm:ss | 26/03/1989T18:32:38 |
| YYYY-MM-DD''T''hh:mm:ss.SSS | 1989-03-26T18:32:38.840 |
| YYYY/MM/DD''T''hh:mm:ss.SSS | 1989/03/26T18:32:38.840 |
| DD-MM-YYYY''T''hh:mm:ss.SSS | 26-03-1989T18:32:38.840 |
| DD/MM/YYYY''T''hh:mm:ss.SSS | 26/03/1989T18:32:38.840 |
| YYYYMMDD | 19890326 |
| YYYYMMDDhhmmss | 19890326183238 |
| YYYYMMDDhhmmssSSS | 19880326183238840 |
| YYYY-MM-DD''T''hh:mm:ss.SSS+/-HH:mm | 1989-03-26T18:32:38.840+05:30 |
| YYYY-MM-DD''T''hh:mm:ss+/-HH:mm | 1989-03-26T18:32:38+05:30 |
| Query expression | ?q=(type eq \"Employee\" AND (fields.emails co \"example.com\" OR fields.emails co \"example.org\")) |
| Query expression usage with this resource | /management/api/v1.1/items?q=(type eq \"Employee\" AND (fields.emails co \"example.com\" OR fields.emails co \"example.org\")) |
| Operator | Example | Supported data types | Description |
|---|---|---|---|
| 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.id eq \"773CDF9B048E429D856F3CA2A14A9CEA\") ?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 \"cars\") ?q=(taxonomies.categories.nodes.apiName eq \"cars\") ?q=(suggestedTaxonomies.categories.id eq \"B9F568DC43C54803AC76012783FA5101\") ?q=(colorTags.tagName eq \"#ff0000\") | 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. 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 \"car\") | text, reference, number, decimal, datetime, largetext | Contains 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, largetext | Not 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\") | text | Starts 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, datetime | Greater 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, datetime | Less 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, datetime | Greater 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. 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, datetime | Less than operator (lt) matches only numeric and datetime values. To understand the possible datetime formats, please refer to the section: Supported date/datetime formats (24Hrs). 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, largetext | Phrase 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 content 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 enclose search terms in 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, largetext | Similarity query operator. This operator allows searching for values that sound like specified criteria - also called fuzzy search, which uses by default a maximum of two edits to match the 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 | 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. |
| Additional Notes | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Type specific query | This query always uses only the eq operator. eq works with case-sensitive type name. Multitype query is supported, such as q=(type eq \"Employee\" OR type eq \"Address\"), however, it will be query across types. Example: q=(type eq \"Employee\" OR type eq \"DigitalAsset\") is supported because of single type search. | ||||||||||||
| Date query | Date query is a special type of query because of various date formats associated with it. All the datetime values in the query are assumed to be in the UTC (timezone) only, unless the offset is added in ISO 8901 format. The 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/management/api/v1.1/items?q=(type eq \"Product\" AND fields.manufactureDate ge \"1989-03-26\"). 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 values | \r\nDecimal 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/management/api/v1.1/items?q=(type eq \"Product\" AND fields.price ge 425.3214), will result in all the products where price is greater than or equal to 425.321. | \r\n||||||||||||
| Large text datatype query | Fields 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 search | Generic query search is a default search query, which 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 name , description or any user-defined fields. Example: ?q=(type eq \"Article\")&default=\"skating\". This will return the search results for Article type where the value skating matches to fields name, description or any user-defined fields. We can connect multiple search terms in default query expression by using defaultOperator with it. Search terms should be comma separated. defaultOperator takes ???or??? and ???and??? operators. Example: ?q=(type eq \"Employee\")&fields=all&default=\"John\",\"skating\"&defaultOperator=\"and\". This will return search results for the employee type where the values John and skating matches to field name, description or any user-defined fields. Example: ?q=(type eq \"Employee\")&fields=all&default=\"John\",\"skating\"&defaultOperator=\"or\". This will return search results for the employee type where the values John or skating matches to field name, description or any user-defined fields. | ||||||||||||
| ID search | Search 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 the 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\")). | ||||||||||||
| Taxonomy search | Search items with given taxonomy id. Example: ?q=(taxonomies.id eq \"773CDF9B048E429D856F3CA2A14A9CEA\") The value of taxonomies.id belongs to the taxonomy assigned to items being queried. It is possible to include multiple taxonomy ids in the query expression. | ||||||||||||
| Category search | Search items categorized with given category id, category name, category apiName, category node id, category node name or category node apiName attributes. 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. | ||||||||||||
| Suggested Category search | Search items that could be categorized into a given category with category id, rejected status and language. Only one category id can be used for filtering at a time. repositoryId is mandatory when filtering on suggestedTaxonomy. Default status is NOT rejected. When no language is specified items from all languages are returned. Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND suggestedTaxonomies.categories.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\") Lists all the items from all languages that are suggested for the given category id for the given repository and not rejected. Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND suggestedTaxonomies.categories.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\" AND suggestedTaxonomies.categories.isRejected eq \"false\") Lists all the items from all languages that are suggested for the given category id for the given repository and not rejected. Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND suggestedTaxonomies.categories.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\" AND suggestedTaxonomies.categories.isRejected eq \"false\" AND language co \"en-US\") Lists all the items from the given language that are suggested for the given category id for the given repository. Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND suggestedTaxonomies.categories.id eq \"9E1A79EE600C4C4BB727FE3E39E95489\" AND suggestedTaxonomies.categories.isRejected eq \"true\" AND language co \"en-US\") Lists all the items from the given language that are previously rejected for the given category id for the given repository. | ||||||||||||
| EXIF search | Search items containing EXIF metadata. EXIF handle (metadata.exif.handle) and EXIF value (metadata.exif.value) are the only fields that can be used in queries and they must be enclosed within the same parenthesis. The EXIF value field can also be used in one of the three formats available: text (metadata.exif.stringValue), integer (metadata.exif.integerValue) or float (metadata.exif.floatValue).
Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND (metadata.exif.handle eq \"Make\" AND metadata.exif.value eq \"Apple\")) Lists all assets containing EXIF field \"Model\" with a string value equals to \"Apple\". Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND (metadata.exif.handle eq \"Orientation\" AND metadata.exif.stringValue mt \"Horizontal\")) Lists all assets containing EXIF field \"Orientation\" with a string value matching the word \"Horizontal\". Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND (metadata.exif.handle eq \"ImageWidth\" AND metadata.exif.integerValue lt \"640\")) Lists all assets containing EXIF field \"ImageWidth\" with an integer value less than \"640\". Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND (metadata.exif.handle eq \"Aperture\" AND metadata.exif.floatValue gt \"1.4\")) Lists all assets containing EXIF field \"Aperture\" with a float value greater than \"1.4\". Example: ?q=(repositoryId eq \"86E125F3D78B409EBF61737636599FE1\" AND (metadata.exif.handle eq \"ImageDescription\" AND metadata.exif.stringValue mt \"*office*\")) Lists all assets containing EXIF field \"ImageDescription\" containing the word \"office\" using wild card search. | ||||||||||||
| Lock Status search | Search items by locked status. Example: ?q=(lockInfo.isLocked eq \"true\") Lists all the items that are in locked status. Example: ?q=(lockInfo.isLocked eq \"false\") or ?q=(lockInfo.isLocked ne \"true\") Lists all the items that are in unlocked status. Example: ?q=(lockInfo.lockedBy eq \"userName\")&fields=lockInfo Lists all the items that are locked by the user specified and displays the lock information in results. | ||||||||||||
| ConnectorFileInfo search | Search items by ConnectorFileInfo.
Example: ?q=(connectorFileInfo.inUse eq \"true\") Lists all the items whose connectorFileInfo.inUse is true. Example: ?q=(connectorFileInfo.version gt \"2\")&fields=connectorFileInfo Lists all the items whose connectorFileInfo.version is greater than 2 and displays the connectorFileInfo in results. | ||||||||||||
| Workflow search | Search items by workflows. Workflow id (workflowInstances.id) and Workflow name (workflowInstances.name) and Workflow completed (workflowInstances.isCompleted) are the only fields that can be used in queries and they must be enclosed within the same parenthesis.
Example: ?q=(workflowInstances.id eq \"51305C2E60E84A949F0E86506405995A\" AND workflowInstances.isCompleted eq \"true\") Lists all assets containing workflow id as \"51305C2E60E84A949F0E86506405995A\" and the workflowInstances isCompleted field is \"true\". Example: ?q=(workflowInstances.name eq \"Travel Approval Process\") Lists all assets containing workflow name as \"Travel Approval Process\" Example: ?q=(workflowInstances.name sw \"Tra\" AND workflowInstances.isCompleted eq \"false\") Lists all assets whose workflow name starts with \"Tra\" and the workflowInstances isCompleted field is \"false\". | ||||||||||||
| Reference field search | Search query using reference attribute. Example: ?q=(type eq \"Employee\" AND fields.department eq \"COREAF29AC6ACA9644F9836E36C7B558F412\"). The value of department belongs to the id of an item of type Department. | ||||||||||||
| Query matching text in binary file | Searching 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\") |
| Supported date/datetime formats (24Hrs) | |
|---|---|
| Format | Example |
| YYYY-MM-DD | 1989-03-26 |
| YYYY/MM/DD | 1989/03/26 |
| DD-MM-YYYY | 26-03-1989 |
| DD/MM/YYYY | 26/03/1989 |
| YYYY-MM-DD''T''hh:mm:ss | 1989-03-26T18:32:38 |
| YYYY/MM/DD''T''hh:mm:ss | 1989/03/26T18:32:38 |
| DD-MM-YYYY''T''hh:mm:ss | 26-03-1989T18:32:38 |
| DD/MM/YYYY''T''hh:mm:ss | 26/03/1989T18:32:38 |
| YYYY-MM-DD''T''hh:mm:ss.SSS | 1989-03-26T18:32:38.840 |
| YYYY/MM/DD''T''hh:mm:ss.SSS | 1989/03/26T18:32:38.840 |
| DD-MM-YYYY''T''hh:mm:ss.SSS | 26-03-1989T18:32:38.840 |
| DD/MM/YYYY''T''hh:mm:ss.SSS | 26/03/1989T18:32:38.840 |
| YYYYMMDD | 19890326 |
| YYYYMMDDhhmmss | 19890326183238 |
| YYYYMMDDhhmmssSSS | 19880326183238840 |
| YYYY-MM-DD''T''hh:mm:ss.SSS+/-HH:mm | 1989-03-26T18:32:38.840+05:30 |
| YYYY-MM-DD''T''hh:mm:ss+/-HH:mm | 1989-03-26T18:32:38+05:30 |
| Parameter Name | Required | Description |
|---|---|---|
| kw | No | Partial search term. Defaults to empty string \"\". |
| language | No | Language tag with variants.\"\". |
| limit | No | This parameter limits size of the results.Defaults to 10 |
| repositoryId | No | This parameter limits results to specific repository.Defaults to ALL. |
| links | No | This parameter accepts a comma-separated list of link names. By default,this parameter gives all the links applicable. Possible values are: self, canonical, describedby |
| displayName | The displayName field is mandatory and it cannot be deleted. Example: ```{ \"displayName\" : \"this is the updated display name\" }``` This payload will replace the displayName of the category property definition. The same uniqueness rules and server formatting used on create still apply. |
| description | The description field is optional. It can be added, updated or removed. Example: ```{ \"description\" : \"adding/updating description\" }``` This payload will add or update the description of the category property definition. The same rules used on create still apply. Example: ```{ \"description\" : null }``` This payload will remove the description of the category property definition. |
| isPublishable | The isPublishable field is mandatory and it cannot be deleted. Example: ```{ \"isPublishable\" : true }``` This payload will replace the isPublishable of the category property definition. The same rules used on create still apply. |
| valueCount | The valueCount field is mandatory and it cannot be deleted. Allowed values for valueCount are 'single' and 'list'. Example: ```{ \"valueCount\" : \"list\" }``` This payload will replace the valueCount of the category property definition. The same rules used on create still apply. |
| defaultValues | The defaultValues array is optional. It can be added, updated or removed. Example: ```{ \"defaultValues\" : [\"default value 1\", \"default value 2\"] }``` This payload will add or update the defaultValues of the category property definition. The same rules used on create still apply. Example: ```{ \"defaultValues\" : null }``` This payload will remove the defaultValues of the category property definition. |
| settings.caas.valueCountRange | The settings.caas.valueCountRange field is optional. It can be added, updated or removed. Example: ```{ \"settings\" : {\"caas\" : { \"valueCountRange\" : {\"min\" : 1, \"max\" : 50} } } }``` This payload will replace the settings.caas.valueCountRange of the category property definition. The same rules used on create still apply. Example: ```{ \"settings\" : {\"caas\" : { \"valuecountRange\" : null } } }``` This payload will remove the settings.caas.valueCountRange of the category property definition. |
| settings.caas.valueCountRange.min | The settings.caas.valueCountRange.min field is optional. It can be added, updated or removed. Example: ```{ \"settings\" : {\"caas\" : { \"valueCountRange\" : {\"min\" : 10} } } }``` This payload will replace the settings.caas.valueCountRange.min of the category property definition. The same rules used on create still apply. Example: ```{ \"settings\" : {\"caas\" : { \"valueCountRange\" : {\"min\" : null} } } }``` This payload will remove the settings.caas.valueCountRange.min of the category property definition. |
| settings.caas.valueCountRange.max | The settings.caas.valueCountRange.max field is optional. It can be added, updated or removed. Example: ```{ \"settings\" : {\"caas\" : { \"valueCountRange\" : {\"max\" : 100} } } }``` This payload will replace the settings.caas.valueCountRange.max of the category property definition. The same rules used on create still apply. Example: ```{ \"settings\" : {\"caas\" : { \"valueCountRange\" : {\"max\" : null} } } }``` This payload will remove the settings.caas.valueCountRange.max of the category property definition. |
| settings.caas.customValidators | The settings.caas.customValidators array is optional. It can be added, updated or removed. Example: ```{ \"settings\" : {\"caas\" : { \"customValidators\" : [{ \"type\" : \"length\", \"options\" : {\"validateOnEachValue\":true, \"ignoreEmpty\":true, \"min\":10, \"max\":1000} }] } } }``` This payload will replace the settings.caas.customValidators of the category property definition. The same rules used on create still apply. Example: ```{ \"settings\" : {\"caas\" : { \"customValidators\" : null } } }``` This payload will remove the settings.caas.customValidators of the category property definition. |
| settings.caas.editor | The settings.caas.editor field is mandatory and it cannot be deleted. Example: ```{ \"settings\" : {\"caas\" : { \"editor\" : {\"name\" : \"multi-selectbox\", \"options\" : {\"multiple\":true} } } } }``` This payload will replace the settings.caas.editor of the category property definition. The same rules used on create still apply. |
| settings.caas.editor.name | The settings.caas.editor.name field is mandatory and it cannot be deleted. Example: ```{ \"settings\" : {\"caas\" : { \"editor\" : {\"name\" : \"multi-selectbox\" } } } }``` This payload will replace the settings.caas.editor.name of the category property definition. The same rules used on create still apply. |
| settings.caas.editor.options | The settings.caas.editor.options field is optional. It can be added, updated or removed. Example: ```{ \"settings\" : {\"caas\" : { \"editor\" : { \"options\" : {\"multiple\":true} } } } }``` This payload will replace the settings.caas.editor.options of the category property definition. The same rules used on create still apply. Example: ```{ \"settings\" : {\"caas\" : { \"editor\" : { \"options\" : null } } } }``` This payload will remove the settings.caas.editor.options of the category property definition. |
| roleName | The roleName field is mandatory and it cannot be deleted. The allowed values are: manager, editor Example: ```{ \"roleName\" : \"editor\" }``` This payload will replace the roleName of the permission. |