Use Lucene Query

Version:
Current
Last modified: October 01, 2020

To get assets, attachments, comments or todos by lucene query, use the /rest/1/lucene endpoint.

Curl Request 

curl -X GET "http://localhost:8080/rest/1/lucene?query=ancestorsandme%3AMzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh&offset=0&limit=4" -H "accept: application/json;charset=UTF-8"

Request Parameters 

  • query: (Required) Lucene query.
  • offset: Offset in search result.
  • limit: Limit of search results hits. 

Server Response Example

{
  "total": 4,
  "count": 4,
  "prevPage": "",
  "nextPage": "",
  "data": [
    {
      "type": "entry",
      "data": {
        "xid": "MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh",
        "appXid": "report",
        "name": "30 min Driving Distance Analysis",
        "parentXid": "NjRkZGY3ZjQtMTYwNC0xMWU3LTkyZjctMDdkNjcwNWI0NGQw",
        "version": 1,
        "lastModifierLogin": "superuser-admin",
        "loadCode": "load-tableauRESTAPI/workbooks",
        "excerpt": "",
        "completeness": 20,
        "workflowState": {
          "type": "workflowstateinstance",
          "data": {
            "xid": "3062dbf4-89e2-4fc9-aad0-86d5b6ccba04",
            "workflowId": "default",
            "workflowStateId": "public",
            "stateName": "Public"
          }
        },
        "fields": {
          "entryDislikeCount": "0",
          "entrySynonym": null,
          "entryOwnerDisplay": "<div class=\"xf3-userlist-container\">\n                        <span style=\"display:none\">nomarginplease</span>\n                                                                                            <div class=\"xf3-user-listview popup-entry-link\" target-xid = \"4170a577-b345-4d81-be78-0bb32f02c648\">\n                            <a href=\"/viewentry?xid=4170a577-b345-4d81-be78-0bb32f02c648\"\n                               style=\"font-size:16px; \"\n                               >\n                                <img src=\"/file/062b59b2-4443-443d-afad-467b69085c46\"\n                                     style=\"width:30px; height: 30px;border-radius:50%;margin-right: 16px;\n                                                                                      \"/>\n                            </a>\n                        </div>\n                                                        </div>",
          "worksheeet": [
            {
              "xid": "MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli",
              "url": "/rest/1/entry/MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli",
              "name": "Sheet 1",
              "type": "reportsheet"
            }
          ],
          "lifecycleStatus": "<div class=\"popup statuses-container\" data-xid='MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
          "MainThumbnail": [
            {
              "xid": "MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFhLzMwIG1pbiBEcml2aW5nIERpc3RhbmNlIEFuYWx5c2lzLnBuZw__",
              "url": "/file/MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFhLzMwIG1pbiBEcml2aW5nIERpc3RhbmNlIEFuYWx5c2lzLnBuZw__",
              "name": "30 min Driving Distance Analysis.png",
              "type": "xf3attachment"
            }
          ],
          "manualtag": null,
          "description": null,
          "displayStatus": "<div class='entry-statuses-container'>\n                <div class=\"xf3-status popularity-container\" name=\"popularity\">\n            <label for=\"popularity\" class=\"control-label\">Popularity</label>\n            <div class=\"popularity-container popup\" data-xid=\"MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh\">\n    <div class=\"popularity-indicator\">\n                <div class=\"popularity-bar\" style=\"width: 23.6%\"></div>\n    </div>\n</div>\n        </div>\n            </div>\n\n                    <style>\n                        div.state-container {\n                            display:none;\n                        }\n                    </style>",
          "entryExtendedNameWithSynonyms": "30 min <wbr>Driving <wbr>Distance <wbr>Analysis",
          "openableUrl": "http://tableau.alteryxhub-europe.com:8000/#/workbooks/812",
          "lastModificationDate": "2020/08/19 04:42",
          "tbltag": null,
          "nview": "3",
          "entryLikeCount": "0",
          "entryOwner": [
            {
              "xid": "4170a577-b345-4d81-be78-0bb32f02c648",
              "url": "/rest/1/entry/4170a577-b345-4d81-be78-0bb32f02c648",
              "name": "Administrator",
              "type": "person"
            }
          ],
          "tbltagEdit": "",
          "entryTypeIcon": "/x/icon?xid=report",
          "entryNameWithSynonyms": "30 min <wbr>Driving <wbr>Distance <wbr>Analysis",
          "labeltag": null,
          "assetRecommendation": null,
          "entryAttachments": null,
          "relatedTerm": null,
          "recentlyUpdated": [],
          "entryPopularity": "0.23582284",
          "joincodition": null,
          "reportversion": null,
          "dbinput": null,
          "fsinput": null,
          "externalpage": null,
          "entryExtendedName": "30 min Driving Distance Analysis",
          "collection": null,
          "my_relations": "<a class=\"open-embedded-nexus-icon\" data-toggle=\"modal\" data-version=\"1\" data-xid=\"MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh\"\n   data-target=\"#xf3-nexus-dialog\" nexus-mode=\"Lineage\">\n        <img src=\"/img/embedded_nexus.png\" title=\"Open nexus\">\n</a>\n<div class=\"embedded-nexus\" field-code=\"my_relations\"></div>\n    <script type=\"application/javascript\">\n    jQuery(document).ready(function () {\n        var container = $(\".embedded-nexus[field-code='my_relations']\")\n\n        var mode = localStorage.getItem(\"nexusMode\");\n        localStorage.setItem(\"nexusMode\", \"Lineage\");\n\n        try {\n            new initNexus(container, \"MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh\", \"1\", function () {\n                container[0].style.width = null; // unset doesn't work for IE\n                if (mode != null && mode != undefined) {\n                    localStorage.setItem(\"nexusMode\", mode);\n                }\n\n            });\n        } catch (e) {\n            console.error(e); // TODO: we get it in comparison mode\n        }\n    });\n</script>",
          "entryExcerpt": "",
          "createdat": "Jun 30, 2018, 12:24:56 PM",
          "lifecycleStatusSearchable": [
            {}
          ],
          "datasource": [
            {
              "xid": "dGFibGVhdS5hbHRlcnl4aHViLWV1cm9wZS5jb206ODAwMC9kZWZhdWx0LzMwIG1pbiBEcml2aW5nIERpc3RhbmNlIEFubGF5c2lz",
              "url": "/rest/1/entry/dGFibGVhdS5hbHRlcnl4aHViLWV1cm9wZS5jb206ODAwMC9kZWZhdWx0LzMwIG1pbiBEcml2aW5nIERpc3RhbmNlIEFubGF5c2lz",
              "name": "30 min Driving Distance Anlaysis",
              "type": "datasource"
            }
          ],
          "entryName": "30 min Driving Distance Analysis",
          "platformDescription": null,
          "reportFrequency": null,
          "contributors": "<div class=\"xf3-userlist-container\">\n                                    <div class=\"xf3-user-listview popup-entry-link\" target-xid = \"superuser-admin\">\n                <a href=\"/superadmin\"\n                   style=\"font-size:16px; \"\n                   >\n                <img src=\"/img/generic_user.png\" style=\"width:30px; height: 30px;border-radius:50%;margin-right: 16px;\n                    background-color: white;\n                        \"/>\n                </a>\n            </div>\n            </div>\n\n                                <style type=\"text/css\">\n                                                                        div[data-field-id=entryOwnerDisplay] .xf3-info-field:first-child,\n                                    div[data-field-id=contributors] .xf3-info-field:first-child{\n                                        margin-top: 0;\n                                    }\n                                </style>",
          "tableDisplayStatus": "<div class=\"popup statuses-container\" data-xid='MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
          "userdefinedreferences": null,
          "updatedat": "Jun 30, 2018, 12:24:56 PM",
          "entryParentLink": "<a href='/viewentry?xid=NjRkZGY3ZjQtMTYwNC0xMWU3LTkyZjctMDdkNjcwNWI0NGQw'>Default</a>"
        }
      }
    },
    {
      "type": "entry",
      "data": {
        "xid": "MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli",
        "appXid": "reportsheet",
        "name": "Sheet 1",
        "parentXid": "MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh",
        "version": 1,
        "lastModifierLogin": "superuser-admin",
        "loadCode": "load-tableauRESTAPI/views",
        "excerpt": "",
        "completeness": 0,
        "workflowState": {
          "type": "workflowstateinstance",
          "data": {
            "xid": "9a623ec2-7d2e-4c20-acd7-b786fd1a12a4",
            "workflowId": "default",
            "workflowStateId": "public",
            "stateName": "Public"
          }
        },
        "fields": {
          "entryDislikeCount": "0",
          "entrySynonym": null,
          "entryOwnerDisplay": "<span style=\"font-style:italic\">Select Owner ...</span>",
          "lifecycleStatus": "<div class=\"popup statuses-container\" data-xid='MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
          "MainThumbnail": [
            {
              "xid": "MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDliL1NoZWV0IDEucG5n",
              "url": "/file/MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDliL1NoZWV0IDEucG5n",
              "name": "Sheet 1.png",
              "type": "xf3attachment"
            }
          ],
          "objectsmetadata": null,
          "manualtag": null,
          "description": null,
          "displayStatus": "<div class='entry-statuses-container'>\n                </div>\n\n                    <style>\n                        div.state-container {\n                            display:none;\n                        }\n                    </style>",
          "entryExtendedNameWithSynonyms": "30 min <wbr>Driving <wbr>Distance <wbr>Analysis.<wbr>Sheet 1",
          "openableUrl": "http://tableau.alteryxhub-europe.com:8000/#/views/30minDrivingDistanceAnalysis/Sheet1",
          "lastModificationDate": "2020/08/19 04:42",
          "tbltag": null,
          "nview": "3",
          "entryLikeCount": "0",
          "entryOwner": null,
          "tbltagEdit": "",
          "entryTypeIcon": "/x/icon?xid=reportsheet",
          "entryNameWithSynonyms": "Sheet 1",
          "labeltag": null,
          "assetRecommendation": null,
          "entryAttachments": null,
          "relatedTerm": null,
          "recentlyUpdated": [],
          "entryPopularity": "",
          "reportversion": null,
          "dbinput": null,
          "externalpage": null,
          "entryExtendedName": "30 min Driving Distance Analysis.Sheet 1",
          "my_relations": "<a class=\"open-embedded-nexus-icon\" data-toggle=\"modal\" data-version=\"1\" data-xid=\"MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli\"\n   data-target=\"#xf3-nexus-dialog\" nexus-mode=\"Lineage\">\n        <img src=\"/img/embedded_nexus.png\" title=\"Open nexus\">\n</a>\n<div class=\"embedded-nexus\" field-code=\"my_relations\"></div>\n    <script type=\"application/javascript\">\n    jQuery(document).ready(function () {\n        var container = $(\".embedded-nexus[field-code='my_relations']\")\n\n        var mode = localStorage.getItem(\"nexusMode\");\n        localStorage.setItem(\"nexusMode\", \"Lineage\");\n\n        try {\n            new initNexus(container, \"MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli\", \"1\", function () {\n                container[0].style.width = null; // unset doesn't work for IE\n                if (mode != null && mode != undefined) {\n                    localStorage.setItem(\"nexusMode\", mode);\n                }\n\n            });\n        } catch (e) {\n            console.error(e); // TODO: we get it in comparison mode\n        }\n    });\n</script>",
          "entryExcerpt": "",
          "createdat": "Jun 30, 2018, 12:24:56 PM",
          "lifecycleStatusSearchable": [
            {}
          ],
          "datasource": null,
          "entryName": "Sheet 1",
          "platformDescription": null,
          "reportFrequency": null,
          "contributors": "<div class=\"xf3-userlist-container\">\n                                    <div class=\"xf3-user-listview popup-entry-link\" target-xid = \"superuser-admin\">\n                <a href=\"/superadmin\"\n                   style=\"font-size:16px; \"\n                   >\n                <img src=\"/img/generic_user.png\" style=\"width:30px; height: 30px;border-radius:50%;margin-right: 16px;\n                    background-color: white;\n                        \"/>\n                </a>\n            </div>\n            </div>\n\n                                <style type=\"text/css\">\n                                                                        div[data-field-id=entryOwnerDisplay] .xf3-info-field:first-child,\n                                    div[data-field-id=contributors] .xf3-info-field:first-child{\n                                        margin-top: 0;\n                                    }\n                                </style>",
          "tableDisplayStatus": "<div class=\"popup statuses-container\" data-xid='MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
          "updatedat": "Feb 18, 2019, 12:08:18 AM",
          "object": null,
          "entryParentLink": "<a href='/viewentry?xid=MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh'>30 min Driving Distance Analysis</a>"
        }
      }
    },
    {
      "type": "attachment",
      "data": {
        "xid": "MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFhLzMwIG1pbiBEcml2aW5nIERpc3RhbmNlIEFuYWx5c2lzLnBuZw__",
        "entryXid": "MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFh",
        "fieldCode": "MainThumbnail",
        "attachmentName": "30 min Driving Distance Analysis.png",
        "version": 2,
        "lastModifierXid": "superuser-admin",
        "attachmentSize": 4864,
        "url": "/file/MzRlM2RhZTAtMzc1YS00YTBjLTk5ODMtYzQzYTBiMDFiNWFhLzMwIG1pbiBEcml2aW5nIERpc3RhbmNlIEFuYWx5c2lzLnBuZw__"
      }
    },
    {
      "type": "attachment",
      "data": {
        "xid": "MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDliL1NoZWV0IDEucG5n",
        "entryXid": "MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDli",
        "fieldCode": "MainThumbnail",
        "attachmentName": "Sheet 1.png",
        "version": 2,
        "lastModifierXid": "superuser-admin",
        "attachmentSize": 4864,
        "url": "/file/MzEwYTZjMWEtYzk3ZS00OThlLWFkZjItZGFhMGY0YTk3NDliL1NoZWV0IDEucG5n"
      }
    }
  ]
}
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.