Acoustic Delivery search API

openapi: 3.2.0
info:
  title: Acoustic Delivery search API
  version: 1.0.142
  x-ibm-name: ibm-watson-content-hub-api
  description: 'Operations tagged Delivery search across 2 of this provider''s published API definitions: acoustic-content-openapi-original.json, acoustic-content-swagger2-original.yaml. Each path carries the servers of the definition it was published in.'
tags:
- name: Delivery search
  description: Use the Watson Content Hub delivery search REST API to search for published  assets, content items, categories and pages. You can use the /delivery/v1/search route to perform anonymous searches or the /mydelivery/v1/search route to perform authenticated searches that include restricted items. While access to the latter route requires at least Authenticated visitor role, accessing the anonymous route does not require any authentication. The delivery search provides access to published items only. To include draft items into your search, you can access this delivery search via the preview host. For more information on the preview host and previewing in general, please refer to https://developer.goacoustic.com/acoustic-content/docs/preview-content
paths:
  /delivery/v1/search:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      - authenticatedVisitor
      - anonymous
      tags:
      - Delivery search
      summary: Search in the delivery collection
      description: "Performs a search query by passing all query parameters to Solr. Search results will not contain protected items.\nThe supported query parser for the \"defType\" parameter can be \"edismax\" or \"lucene\". The query parser name defined\nin \"q\" or \"fq\" parameter through \"{!<parser-name> ...}\" can have the value \"join\", \"lucene\", \"edismax\", or \"geofilt\".\nFor more information about the query syntax and the available query parameters, see the Solr documentation.\n\n### ***Limitation of sort and pagination*** ###\n\nSorting on not unique fields can cause paging to return duplicate or missing entries in subsequent pages of results.\nIf an index modification (adding or removing documents) which affects the sequence of ordered documents matching a query occurs in between two requests from a client for subsequent pages of results then\nit is possible that these modifications can result in the same document being returned on multiple pages, or documents being \"skipped\" as the result set shrinks or grows.\nIt's recommended to sort by unique field or a combination ex. sort=lastModied desc, status desc.\n\n### ***Description of the delivery collection schema*** ###\n\nThe table below lists the **Name** of each field from the delivery collection. Additionally, it contains a **Description** of each field along with the following information:\n* **JSON Data Type:** This column specifies the data type of field values that Watson Content Hub returns in the result of a query. \n* **Solr Field Type:** This column specifies how Watson Content Hub stores values of the field in the delivery collection.\n  * **boolean:** This field type is based on the Solr *BoolField* class. \n  * **date:** This field type is based on the Solr *TrieDateField* class.\n  * **int:** This field type is based on the Solr *TrieIntField* class.\n  * **long:** This field type is based on the Solr *TrieLongField* class.\n  * **location_rpt:** This field type is based on the Solr *LatLonPointSpatialField* class.\n  * **path_hierarchical_index:** This field type is based on the Solr *TextField* class. It uses a hierarchical path tokenizer to index field values.\n  * **string:** This field type is based on the Solr *StrField* class.\n  * **string_ci:** This field type is based on the Solr *TextField* class. It is a case insensitive version of *string* field type.\n  * **text_general:** This field type is based on the Solr *TextField* class.\n* **Indexed:** This column specifies whether you can use values of the field in a query to retrieve matching documents.\n* **Stored:** This column specifies whether you can retrieve the actual value of the field using a query. The fields ***highlighted*** in this column are included in the query result by default. To override that default field list, use the \"fl\" parameter in your query.\n\n| Name                    | Description | JSON Data Type | Solr Field Type | Indexed | Stored* |\n|-------------------------|-------------|----------------|-----------------|---------|---------|\n| aggregatedIds           | For pages, this field contains the IDs that the page's appearance is made up of. This comprises the page's ID as well as the IDs of the page content item and it's directly referenced content items. Changes in one of those items will cause the page to be re-indexed. | array of strings | string_ci | true | true |\n| aggregatedContentIds    | For pages, this field contains the content IDs that the page's appearance is made up of. This comprises the IDs of the page content item and it's directly referenced content items. Changes in one of those items will cause the page to be re-indexed.  | array of strings | string_ci | true | true |\n| assetType               | For assets, this field contains the asset type. The value that is returned can be \"document\", \"file\", \"image\", or \"video\". | string | string_ci | true | ***true*** |\n| boolean1                | For content, this field can contain boolean element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of booleans | boolean | true | true |\n| boolean2                | For content, this field can contain boolean element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of booleans | boolean | true | true |\n| categories              | The list of all category selections for the asset or content. All category selection elements on content are merged into this property. | array of strings | path_hierarchical_index | true | ***true*** |\n| categoryLeaves          | The list of all leaf category selection elements for the asset or content. | array of strings | string_ci | true | false |\n| classification          | This field describes the kind of item. The value that is returned can be \"asset\", \"category\", \"content\" or \"taxonomy\". | string | string_ci | true | ***true*** |\n| created                 | The creation date of the item. | string | date | true | ***true*** |\n| creatorId               | The UUID of the user that created the item. | string | string | true | ***true*** |\n| date1                   | For content, this field can contain date element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of strings | date | true | true |\n| date2                   | For content, this field can contain date element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of strings | date | true | true |\n| description             | The description of the item. | string | text_general | true | ***true*** |\n| document                | For assets and content, this field contains the full JSON document for the item. | string | string | false | true |\n| fileSize                | For assets, this field contains the file size in bytes. | number | long | true | ***true*** |\n| generatedFiles          | For content, this field contains the list of path values related to files that are generated by pre-rendering the item. | array of strings | string | true | true |\n| height                  | For images, this field contains the height. | number | int | true | true |\n| hideFromNavigation      | For pages, this field specifies whether it should be hidden from navigation controls. | boolean | boolean | true | true |\n| id                      | The identifier of the item. For items of the same \"classification\", this identifier is unique. The combination of the \"classification\" and the \"id\" is unique across all items of the Watson Content Hub tenant. | string | string | true | ***true*** |\n| isManaged               | For assets and content, this field specifies whether the content is managed or not managed and whether the asset is a managed asset or a so-called non-managed web asset. | boolean | boolean | true | false |\n| keywords                | The list of keywords related to the item. | array of strings | string_ci | true | ***true*** |\n| kind                    | For pages, this field contains all kinds a page is assigned to. | array of strings | string_ci | true | true |\n| lastModified            | The last modification date of the item. | string | date | true | ***true*** |\n| lastModifierId          | The UUID of the user that last modified the item. | string | string | true | ***true*** |\n| locale                  | The language for which the item was created. | string | string_ci | true | true |\n| location                | For assets, this field contains the folder path without the file name. This allows for efficient queries for sibling assets. | string | string_ci | true | false |\n| location1               | For content, this field contains an array of strings. Each string consists of the latitude and the longitude of location elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of strings | location_rpt | true | false |\n| locationPaths           | For assets, this field contains all of the path segments. This allows for efficient queries that return assets in subfolders of the queried value. For example, the query *locationPaths:\"/dxdam\"* will return assets that are stored in the */dxdam* folder or any subfolder. | string | path_hierarchical_index | true | false |\n| locations               | For content, this field contains an array of strings. Each string consists of the latitude and the longitude of a Location element of the content item. For example, this field contains [\"48.666259, 9.039273\", \"53.418880, -6.416081\"] for a content item with two Location elements. | array of strings | location_rpt | true | true |\n| media                   | For assets, this field contains the URL to the binary of the asset. It is relative to the API URL for your tenant. | string | string_ci | true | true |\n| mediaType               | For assets, this field contains the media type. | string | string | true | ***true*** |\n| name                    | The name of the item. | string | string_ci | true | ***true*** |\n| number1                 | For content, this field can contain number element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of numbers | double | true | true |\n| number2                 | For content, this field can contain number element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of numbers | double | true | true |\n| parentId                | For pages, this field contains the ID of the parent page. | string | string_ci | true | true |\n| path                    | For assets, this field contains the folder path including file name. | string | string_ci | true | ***true*** |\n| position                | For pages, this field contains the position of the page relative to it's sibling pages. | number | int | true | true |\n| resource                | For assets, this field contains the ID of the related resource. You can use this resource ID with the authoring and delivery resource service REST APIs. | string | string | true | ***true*** |\n| restricted              | This field specifies whether the item is restricted. | boolean | boolean | true | false |\n| siteId                  | For pages, this field contains the ID of the site the page belongs to. | string | string_ci | true | true |\n| status                  | For assets and content, this field contains the state the item is in. The value of this field can be \"ready\" or \"retired\". | string | string_ci | true | true |\n| string1                 | For content, this field can contain string element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of strings | string_ci | true | true |\n| string2                 | For content, this field can contain string element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of strings | string_ci | true | true |\n| string3                 | For content, this field can contain string element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of strings | string_ci | true | true |\n| string4                 | For content, this field can contain string element values for elements mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | array of strings | string_ci | true | true |\n| sortableDate1           | For content, this field can contain a single date element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | string | date | true | true |\n| sortableDate2           | For content, this field can contain a single date element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | string | date | true | true |\n| sortableNumber1         | For content, this field can contain a single number element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | number | double | true | true |\n| sortableNumber2         | For content, this field can contain a single number element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | number | double | true | true |\n| sortableString1         | For content, this field can contain a single string element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | string | string_ci | true | true |\n| sortableString2         | For content, this field can contain a single string element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | string | string_ci | true | true |\n| sortableString3         | For content, this field can contain a single string element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | string | string_ci | true | true |\n| sortableString4         | For content, this field can contain a single string element value for an element mapped to this field. The mapping of elements to search fields is defined in the content type referenced by the content item. | string | string_ci | true | true |\n| tags                    | The list of tags assigned to the item. | array of strings | string_ci | true | ***true*** |\n| text                    | For content, this field is a collection of field names and text fragments that make up the item. It facilitates full-text search. | array of strings | text_general | true | false |\n| thumbnail               | For assets, this field contains the URL to the thumbnail of the asset. It is relative to the API URL for your tenant. | string | string_ci | true | true |\n| type                    | For content, this field contains the name of the content type. | string | string_ci | true | ***true*** |\n| typeId                  | For content, this field contains the ID of the content type. | string | string_ci | true | true |\n| url                     | For assets, this field contains the server relative URL to the binary document of the asset. For pages, it contains the URL under which the page can be adressed in an SPA. | string | string | false | ***true*** |\n| width                   | For images, this field contains the width. | number | int | true | true |\n\n\\* **Note:** Temporarily, the delivery collection might store field values even though the table above indicates otherwise.\n\n### ***Search Query Examples*** ###\n\n#### **Using a wildcard in the search term** ####\n\nIn this example, the request URL defines a query using the standard query syntax. The \"name\" field is specified as the query field. The search term contains a wildcard to match any name that starts with the word \"Red\", for example \"Red clover\" or \"Red_clover.pdf\".  \nThe \"numFound\" property from the response provides the number of documents that match the query. The value of the \"documents\" property contains the documents from the delivery collection selected by the query. Each document is returned with its stored fields as explained in the description of the delivery collection schema.\n\n##### *Request:* #####\n\n~~~\n{baseURL}/delivery/v1/search?q=name:Red*\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 4,\n    \"documents\": [\n        {\n            \"id\": \"53876d53-fbcf-45cf-8d53-f640c93f55c0\",\n            \"name\": \"Red_clover.jpg\",\n            \"classification\": \"asset\",\n            \"description\": \"This is an image of a red clover plant.\",\n            \"lastModified\": \"2017-06-27T14:49:12.160Z\",\n            \"lastModifierId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"created\": \"2017-06-27T14:49:09.197Z\",\n            \"creatorId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"tags\": [\n                \"red clover\",\n                \"clover\",\n                \"alpine clover\",\n                \"pink color\",\n                \"plant\",\n                \"purple color\",\n                \"herb\"\n            ],\n            \"mediaType\": \"image/jpeg\",\n            \"path\": \"/dxdam/53/53876d53-fbcf-45cf-8d53-f640c93f55c0/Red_clover.jpg\",\n            \"fileSize\": 25513,\n            \"assetType\": \"image\",\n            \"resource\": \"b110f3efdb6e1d305a88348b1caca710\",\n            \"url\": \"/2a2d174a-0c35-495f-ba3a-e881dc71197c/dxdam/53/53876d53-fbcf-45cf-8d53-f640c93f55c0/Red_clover.jpg\"\n        },\n        {\n            \"id\": \"7001cf29-b28b-4462-9b4a-827ab15eaff4\",\n            \"name\": \"Red_clover.pdf\",\n            \"classification\": \"asset\",\n            \"description\": \"Description of the red clover.\",\n            \"lastModified\": \"2017-06-27T14:49:14.409Z\",\n            \"lastModifierId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"created\": \"2017-06-27T14:49:13.130Z\",\n            \"creatorId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"tags\": [\n                \"Trifolium pratense\",\n                \"US Department of Agriculture\",\n                \"American Cancer Society\",\n                \"Europe\",\n                \"Clover\",\n                \"Western Asia\",\n                \"South America\",\n                \"Africa\"\n            ],\n            \"mediaType\": \"application/pdf\",\n            \"path\": \"/dxdam/70/7001cf29-b28b-4462-9b4a-827ab15eaff4/Red_clover.pdf\",\n            \"fileSize\": 331680,\n            \"assetType\": \"file\",\n            \"resource\": \"14da685e6f1c2c67b26d5a0c80bc2be8\",\n            \"keywords\": [\n                \"red clover\",\n                \"Trifolium pratense\",\n                \"red clover flowers\",\n                \"red clover rust\",\n                \"Red Clover Pollination\",\n                \"Red Clover Tea\",\n                \"South America\"\n            ],\n            \"url\": \"/2a2d174a-0c35-495f-ba3a-e881dc71197c/dxdam/70/7001cf29-b28b-4462-9b4a-827ab15eaff4/Red_clover.pdf\"\n        },\n        {\n            \"id\": \"454581ee-d0f1-4eb3-9ac6-3ce4990cce24\",\n            \"name\": \"Red_clover_herbarium.jpg\",\n            \"classification\": \"asset\",\n            \"description\": \"This is an image of the red clover from an herbarium.\",\n            \"lastModified\": \"2017-06-27T14:49:13.608Z\",\n            \"lastModifierId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"created\": \"2017-06-27T14:49:11.157Z\",\n            \"creatorId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"tags\": [\n                \"olive green color\",\n                \"plant\",\n                \"clover\",\n                \"herbarium\",\n                \"sage green color\"\n            ],\n            \"mediaType\": \"image/jpeg\",\n            \"path\": \"/dxdam/45/454581ee-d0f1-4eb3-9ac6-3ce4990cce24/Red_clover_herbarium.jpg\",\n            \"fileSize\": 557238,\n            \"assetType\": \"image\",\n            \"resource\": \"e7cd2cac2e5bfce2878a707377bf42d6\",\n            \"url\": \"/2a2d174a-0c35-495f-ba3a-e881dc71197c/dxdam/45/454581ee-d0f1-4eb3-9ac6-3ce4990cce24/Red_clover_herbarium.jpg\"\n        },\n        {\n            \"id\": \"c65a949c-5822-49bb-ad5d-647cd9820c57\",\n            \"name\": \"Red clover\",\n            \"classification\": \"content\",\n            \"description\": \"This content provides information on the red clover.\",\n            \"lastModified\": \"2017-06-27T14:49:36.389Z\",\n            \"lastModifierId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"created\": \"2017-06-27T14:49:36.389Z\",\n            \"creatorId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n            \"tags\": [\n                \"clover\",\n                \"purple\",\n                \"luck\",\n                \"pink\"\n            ],\n            \"type\": \"Plant\",\n            \"categories\": [\n                \"Plant classification/Plantae/Angiosperms/Eudicots/Rosids/Fabales/Fabaceae/Faboideae/Trifolieae/Trifolium\",\n                \"Plant habitats/Grassland/Meadow/Wet meadow\"\n            ]\n        }\n    ]\n}\n~~~\n\n#### **Specifying the fields to return** ####\n\nThis example demonstrates the use of the \"fl\" parameter. It defines that only the \"name\" field and the \"classification\" field will be returned for each document matching the query.\nThe number of returned documents is limited to 10 by default.\n\n##### *Request:* #####\n\n~~~\n  {baseURL}/delivery/v1/search?q=tags:thistle&fl=name&fl=classification\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 12,\n    \"documents\": [\n        {\n            \"name\": \"Spiny_sowthistle.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle_herbarium.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle.pdf\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Spiny_sowthistle_herbarium.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Spiny_sowthistle.pdf\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common sowthistle\",\n            \"classification\": \"content\"\n        },\n        {\n            \"name\": \"Spiny sowthistle\",\n            \"classification\": \"content\"\n        },\n        {\n            \"name\": \"Marsh thistle\",\n            \"classification\": \"content\"\n        },\n        {\n            \"name\": \"Marsh_thistle.jpg\",\n            \"classification\": \"asset\"\n        }\n    ]\n}\n~~~\n\n#### **Limiting the number of results and returned fields** ####\n\nIn this example, the maximum number of documents to include in the query result is limited to 5.\nBy default, if you do not specify the \"rows\" parameter, the service returns a maximum of 10 documents.\nThe \"fl\" parameter defines that only the \"name\" field and the \"classification\" field will be returned for each document matching the quey.\n\n##### *Request:* #####\n\n~~~\n  {baseURL}/delivery/v1/search?q=tags:thistle&fl=name&fl=classification&rows=5\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 12,\n    \"documents\": [\n        {\n            \"name\": \"Spiny_sowthistle.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle_herbarium.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle.pdf\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Spiny_sowthistle_herbarium.jpg\",\n            \"classification\": \"asset\"\n        }\n    ]\n}\n~~~\n\n#### **Paging through the query result** ####\n\nIn this example, the \"rows\" parameter is still set to 5 to limit the number of documents returned by the query.\nThe \"start\" parameter defines an absolute offset of 3 in the complete sorted list of matches.\nTherefore, the result of the query includes documents 4 through 8 from a total of 12 documents that match the query.\nIf an index modification (adding or removing) which affects the sequence of ordered documents matching a query occurs\nin between two requests from a client for subsequent pages of results then\nit is possible that these modifications can result in the same document being returned on multiple pages, or documents\nbeing \"skipped\" as the result set shrinks or grows. For more information about sorting and paging see the Solr documentation.\nThe default value of the \"start\" parameter is 0.\n\n##### *Request:* #####\n\n~~~\n  {baseURL}/delivery/v1/search?q=tags:thistle&fl=name&fl=classification&rows=5&start=3\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 12,\n    \"documents\": [\n        {\n            \"name\": \"Common_sowthistle.pdf\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Spiny_sowthistle_herbarium.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Spiny_sowthistle.pdf\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common sowthistle\",\n            \"classification\": \"content\"\n        },\n        {\n            \"name\": \"Spiny sowthistle\",\n            \"classification\": \"content\"\n        }\n    ]\n}\n~~~\n\n#### **Sorting the query result** ####\n\nIn this example, the query contains the \"sort\" parameter to sort the query result by \"name\" in an ascending order.\nThe response includes the first 5 documents from the sorted query result. If an index modification (such as adding or\nremoving documents) which affects the sequence of ordered documents matching a query occurs in between two requests from\na client for subsequent pages of results, then it is possible that these modifications can result in the same document\nbeing returned on multiple pages, or documents being \"skipped\" as the result set shrinks or grows. It's recommended to\nsort by unique field or their combination ex:  sort=name asc, lastModified asc\n\n##### *Request:* #####\n\n~~~\n  {baseURL}/delivery/v1/search?q=tags:thistle&fl=name&fl=classification&rows=5&sort=name asc,lastModified asc\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 12,\n    \"documents\": [\n        {\n            \"name\": \"Common sowthistle\",\n            \"classification\": \"content\"\n        },\n        {\n            \"name\": \"Common_sowthistle.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle.pdf\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Common_sowthistle_herbarium.jpg\",\n            \"classification\": \"asset\"\n        },\n        {\n            \"name\": \"Marsh thistle\",\n            \"classification\": \"content\"\n        }\n    ]\n}\n~~~\n\n#### **Getting only the number of matching documents** ####\n\nThis example demonstrates how you can limit the response to only the number of documents that match the query by adding the \"rows\" parameters with a value of 0.\n\n##### *Request:* #####\n\n~~~\n  {baseURL}/delivery/v1/search?q=*:*&rows=0\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 182\n}\n~~~\n\n#### **Using boolean operators in a query** ####\n\nThis example demonstrates the use of a boolean operator to combine different conditions in the query. This particular query returns Watson Content Hub \"content\" that is tagged with \"dandelion\". The fields of matching documents that are included in the response are limited to \"name\", \"classification\", and \"tags\".\n\n##### *Request:* #####\n\n~~~\n  {baseURL}/delivery/v1/search?q=classification:content AND tags:dandelion&fl=name&fl=classification&fl=tags\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 1,\n    \"documents\": [\n        {\n            \"name\": \"Common dandelion\",\n            \"classification\": \"content\",\n            \"tags\": [\n                \"dandelion\",\n                \"yellow\",\n                \"tortoise\"\n            ]\n        }\n    ]\n}\n~~~\n\n#### **Getting the \"document\" field as JSON object** ####\n\nIn this example, the query is extended by an additional \"fl\" parameter to also retrieve the \"document\" field. To return the value of that specific field as JSON object, the \"[json]\" qualifier is added. By default, the field value is returned as an escaped JSON string. \n\n##### *Request:* #####\n\n~~~\n  {baseURL}/delivery/v1/search?q=classification:content AND tags:dandelion&fl=name&fl=classification&fl=tags&fl=document:[json]\n~~~\n\n##### *Response:* #####\n\n~~~\n{\n    \"numFound\": 1,\n    \"documents\": [\n        {\n            \"name\": \"Common dandelion\",\n            \"classification\": \"content\",\n            \"tags\": [\n                \"dandelion\",\n                \"yellow\",\n                \"tortoise\"\n            ],\n            \"document\": {\n                \"id\": \"662c212c-e8f6-4dcc-b4fa-cddb76aac7c0\",\n                \"name\": \"Common dandelion\",\n                \"description\": \"This content provides information on the common dandelion.\",\n                \"classification\": \"content\",\n                \"typeId\": \"357e5d59-be20-4fe5-ba9e-31913f6fc229\",\n                \"locale\": \"en\",\n                \"lastModified\": \"2017-06-27T14:49:35.361Z\",\n                \"lastModifierId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n                \"created\": \"2017-06-27T14:49:35.361Z\",\n                \"creatorId\": \"7129fa28-0d25-4162-8700-cbc5c294dacc\",\n                \"tags\": [\n                    \"dandelion\",\n                    \"yellow\",\n                    \"tortoise\"\n                ],\n                \"status\": \"ready\",\n                \"elements\": {\n                    \"source\": {\n                        \"elementType\": \"link\",\n                        \"linkURL\": \"https://en.wikipedia.org/wiki/Taraxacum_officinale\",\n                        \"linkText\": \"Wikipedia\"\n                    },\n                    \"scientificClassification\": {\n                        \"elementType\": \"category\",\n                        \"categoryIds\": [\n                            \"e7411413986ff741cb4495df45e4b7a1\"\n                        ],\n                        \"categories\": [\n                            \"Plant classification/Plantae/Angiosperms/Eudicots/Asterids/Asterales/Asteraceae/Cichorioideae/Cichorieae/Taraxacum\"\n                        ]\n                    },\n                    \"attachment\": {\n                        \"elementType\": \"file\",\n                        \"asset\": {\n                            \"id\": \"ba56e2b8-c7bf-4f45-b791-323f85fdfbc5\",\n                            \"resourceUr

# --- truncated at 32 KB (150 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acoustic/refs/heads/main/openapi/acoustic-delivery-search-api-openapi.yml