Curl request lucene

$ curl 'http://localhost:8080/rest/1/lucene?query=ancestorsandme:74d1da73-e232-4a7c-8d78-55f1965bf8da&offset=0&limit=4' -i

Request parameters lucene

Parameter Description Required

query

lucene query

true

offset

Offset in search result

false

limit

Limit of search results hits

false

Request lucene

GET /rest/1/lucene?query=ancestorsandme:74d1da73-e232-4a7c-8d78-55f1965bf8da&offset=0&limit=4 HTTP/1.1
Host: localhost:8080

Response lucene

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 3189

{
  "total" : 4,
  "count" : 4,
  "prevPage" : "",
  "nextPage" : "",
  "data" : [ {
    "type" : "entry",
    "data" : {
      "xid" : "74d1da73-e232-4a7c-8d78-55f1965bf8da",
      "appXid" : "testtab",
      "name" : "_test entry 1",
      "parentXid" : "b235627e-b966-4155-99e9-d40df28c2a1c",
      "version" : 2,
      "lastModifierLogin" : "superuser-admin",
      "loadCode" : "test-load-code",
      "excerpt" : "description",
      "completeness" : -1,
      "workflowState" : {
        "type" : "workflowstateinstance",
        "data" : {
          "xid" : "30ffe0fc-9a35-4ab3-9241-d3905b787104",
          "workflowId" : "default",
          "workflowStateId" : "public",
          "stateName" : "Public"
        }
      },
      "fields" : {
        "entryPopularity" : "",
        "lifecycleStatus" : "<div class=\"popup statuses-container\" data-xid='74d1da73-e232-4a7c-8d78-55f1965bf8da'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
        "entryExtendedName" : "_test entry 1",
        "entryExtendedNameWithSynonyms" : "_<wbr>test entry 1",
        "entryExcerpt" : "description",
        "lastModificationDate" : "04/06 23:52",
        "entryName" : "_test entry 1",
        "entryLikeCount" : "0",
        "tableDisplayStatus" : "<div class=\"popup statuses-container\" data-xid='74d1da73-e232-4a7c-8d78-55f1965bf8da'>\n    <div class='entry-statuses-table-container'>\n                    </div>\n</div>",
        "entryTypeIcon" : "/x/icon?xid=testtab",
        "cols" : [ {
          "xid" : "1fc1419c-3dc4-4826-b7e6-d2e7cef191d1",
          "url" : "/rest/1/entry/1fc1419c-3dc4-4826-b7e6-d2e7cef191d1",
          "name" : "test col",
          "type" : "testtab"
        } ],
        "entryNameWithSynonyms" : "_<wbr>test entry 1",
        "desc" : "<p>description</p>",
        "entryParentLink" : "<a href='/viewentry?xid=b235627e-b966-4155-99e9-d40df28c2a1c'>Test Catalog</a>",
        "entryAttachments" : null
      }
    }
  }, {
    "type" : "comment",
    "data" : {
      "xid" : "b9c9c904-2e3b-4daf-8fe8-832353aa11c0",
      "threadXid" : "76c367b8-d139-4d11-91e7-b7c2b5051703",
      "commentAuthorXid" : "superuser-admin",
      "commentAuthorName" : "Administrator",
      "commentBody" : "<p class='test_comment'>Comment search entry _test</p> VA1"
    }
  }, {
    "type" : "todo",
    "data" : {
      "xid" : "855fa0e1-445e-446a-b55a-4734470a5932",
      "onXid" : "b9c9c904-2e3b-4daf-8fe8-832353aa11c0",
      "forXid" : "69e62835-dfa3-4425-ac81-f1cd316bdd78",
      "forName" : "David Vonka",
      "byName" : "Darek Kryszczuk",
      "lastModified" : 1523058735917,
      "comment" : "_test todo",
      "resolved" : false,
      "resolvedDate" : null,
      "createdDate" : 1523058735917
    }
  }, {
    "type" : "attachment",
    "data" : {
      "xid" : "093dcd14-a299-4ade-ba52-6f007525476a",
      "entryXid" : "74d1da73-e232-4a7c-8d78-55f1965bf8da",
      "fieldCode" : "entryAttachments",
      "attachmentName" : "_test.txt",
      "version" : 1,
      "lastModifierXid" : "superuser-admin",
      "attachmentSize" : 16,
      "url" : "/file/093dcd14-a299-4ade-ba52-6f007525476a"
    }
  } ]
}

Response fields lucene

Path Type Description

total

Number

Total hits of search result

count

Number

Amount of objects in search result page

prevPage

String

Link to previous page

nextPage

String

Link to next page

data[].type

String

Entry type. Can be entry, comment, attachment or todo

data[].data.xid

String

Entry xid

data[].data.appXid

String

Entry application xid

data[].data.name

String

Entry name

data[].data.parentXid

String

Entry parent xid

data[].data.version

Number

Entry version

data[].data.lastModifierLogin

String

Last modifier login

data[].data.loadCode

String

Entry load code

data[].data.excerpt

String

Entry excerpt

data[].data.completeness

Number

Number showing how much entry is completed

data[].data.workflowState.type

String

Entry type of workflow state

data[].data.workflowState.data.xid

String

WorkflowState xid

data[].data.workflowState.data.workflowId

String

Workflow id of workflow state

data[].data.workflowState.data.workflowStateId

String

WorkflowState id

data[].data.workflowState.data.stateName

String

WorkflowState state name

data[].data.fields.entryPopularity

String

Display of entry popularity

data[].data.fields.lifecycleStatus

String

Display of lifecycle status

data[].data.fields.entryExtendedName

String

Entry extended name that includes parent names

data[].data.fields.entryExtendedNameWithSynonyms

String

Entry extended name with synonyms that includes parent names

data[].data.fields.entryExcerpt

String

Entry excerpt

data[].data.fields.lastModificationDate

String

Last modification date

data[].data.fields.entryName

String

Entry name

data[].data.fields.entryLikeCount

String

Display of entry likes/dislikes

data[].data.fields.tableDisplayStatus

String

Table display status

data[].data.fields.entryTypeIcon

String

Icon representing entry type

data[].data.fields.entryNameWithSynonyms

String

Entry name with synonyms

data[].data.fields.entryParentLink

String

Entry parent link

data[].data.fields.entryAttachments

Null

List of entry attachments

data[].data.fields.desc

String

Description

data[].data.fields.cols[].xid

String

Column entry xid

data[].data.fields.cols[].url

String

Column entry url

data[].data.fields.cols[].name

String

Column entry name

data[].data.fields.cols[].type

String

Application type of column

data[].data.threadXid

String

Comment thread xid

data[].data.commentAuthorXid

String

Comment author xid

data[].data.commentAuthorName

String

Comment author name

data[].data.commentBody

String

Comment body

data[].data.onXid

String

Xid of entry, comment or comment thread where todo was added

data[].data.forXid

String

Xid of user todo is assigned to

data[].data.forName

String

Username todo is assigned to

data[].data.byName

String

Name of user who was a reporter

data[].data.lastModified

Number

Last modified date

data[].data.comment

String

Comment on todo

data[].data.resolved

Boolean

Boolean value that defines if todo was resolved

data[].data.resolvedDate

Null

Date when todo was resolved

data[].data.createdDate

Number

Date when todo was created

data[].data.entryXid

String

Xid of entry attachment was added to

data[].data.fieldCode

String

Code of entry field attachment was added to

data[].data.attachmentName

String

Attachment name

data[].data.version

Number

Attachment version number

data[].data.lastModifierXid

String

Xid of user who was last modifier

data[].data.attachmentSize

Number

Attachment size in bytes

data[].data.url

String

Attachment url