Returns search results

GET
api/databases/{dbid}/search
The query string can contain the characters:
'*' - Any set of characters
'?' - Any one character

Search string should describe fully the word you are looking for. For example query 'aa?b' will find 'aaab', 'aabb', etc., but will not find 'aaabb', 'caaab'. etc.

Also you can use operators AND, OR, NOT.

Request:

Argument Type Description
dbid GUID  The ID of the database
Query parameter Required Default Options Description
highlight   1/0  Hightlights search results
query     Returns search query
skip       Returns data starting from the given item
top     Max 200  Returns the given number of data items

Response:

Content

Type name Description
Object 

The following query finds the task with the code T100, as well as other entities that refer to this task or have T100 in the fields of string type.

Request:
  1. GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/search?query=T100
  2. Accept: text/json
  3. Accept-Encoding: deflate
  4. Host: localhost:6496
  5. Cookie: sid=20715d87-29dc-429e-9a86-4b3c60cd8a45
Response:
  1. Transfer-Encoding: chunked
  2. Content-Encoding:
  3. Cache-Control: no-store
  4. Content-Type: text/json; charset=utf-8
  5. Date: Fri, 21 Dec 2012 16:04:36 GMT
  6. Set-Cookie: sid=20715d87-29dc-429e-9a86-4b3c60cd8a45; path=/;
  7. Server: Microsoft-HTTPAPI/2.0
  8.  
  9. {
  10. "Data": [
  11. {
  12. "Id": "05f4fb92-2721-4cb7-a31a-c316f9d218d5",
  13. "DocumentType": "Entity",
  14. "DocumentName": "Entity_Task",
  15. "Code": "T101",
  16. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: In Progress; Reason: Started; Folder: ; Parent: ; Time Log: User: admin... ",
  17. "Title": "(T101) New Task name 100"
  18. },
  19. {
  20. "Id": "3b8f6008-abad-4fc4-be01-417a6849dd29",
  21. "DocumentType": "Entity",
  22. "DocumentName": "Entity_Task",
  23. "Code": "T201",
  24. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: In Progress; Reason: Started; Folder: ; Parent: ; Time Log: User: admin... ",
  25. "Title": "(T201) New Task name 100"
  26. },
  27. {
  28. "Id": "d36d4471-bb0f-4dbe-92c2-47ef3d9373c4",
  29. "DocumentType": "Entity",
  30. "DocumentName": "Entity_Task",
  31. "Code": "T301",
  32. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: In Progress; Reason: Started; Folder: ; Parent: ; Time Log: User: admin... ",
  33. "Title": "(T301) New Task name 100"
  34. },
  35. {
  36. "Id": "0a1de68f-2b18-490d-90bb-5de93921f00b",
  37. "DocumentType": "Entity",
  38. "DocumentName": "Entity_Task",
  39. "Code": "T589",
  40. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  41. "Title": "(T589) New Task name 100"
  42. },
  43. {
  44. "Id": "504ecc7e-4dfc-49bf-b906-5c4d3d06403f",
  45. "DocumentType": "Entity",
  46. "DocumentName": "Entity_Task",
  47. "Code": "T1287",
  48. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  49. "Title": "(T1287) New Task name 100"
  50. },
  51. {
  52. "Id": "4f4c3f65-ede5-481a-9731-5b887f91730c",
  53. "DocumentType": "Entity",
  54. "DocumentName": "Entity_Task",
  55. "Code": "T1427",
  56. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  57. "Title": "(T1427) New Task name 100"
  58. },
  59. {
  60. "Id": "167c80b2-9875-46e4-98c9-aa7e54cf4505",
  61. "DocumentType": "Entity",
  62. "DocumentName": "Entity_Task",
  63. "Code": "T1787",
  64. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  65. "Title": "(T1787) New Task name 100"
  66. },
  67. {
  68. "Id": "24106d98-249a-40fa-ad82-cc0cf6d28606",
  69. "DocumentType": "Entity",
  70. "DocumentName": "Entity_Task",
  71. "Code": "T1938",
  72. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  73. "Title": "(T1938) New Task name 100"
  74. },
  75. {
  76. "Id": "20c9d543-2fa3-4456-9997-7cc68f639be3",
  77. "DocumentType": "Entity",
  78. "DocumentName": "Entity_Task",
  79. "Code": "T2227",
  80. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  81. "Title": "(T2227) New Task name 100"
  82. },
  83. {
  84. "Id": "bf8b0e04-20ed-4ff1-bc91-a29c453ec611",
  85. "DocumentType": "Entity",
  86. "DocumentName": "Entity_Task",
  87. "Code": "T2427",
  88. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  89. "Title": "(T2427) New Task name 100"
  90. },
  91. {
  92. "Id": "6380772a-ae70-4ee9-88ea-1d686dc55a00",
  93. "DocumentType": "Entity",
  94. "DocumentName": "Entity_Task",
  95. "Code": "T2627",
  96. "Content": "Owner: admin ; Creator: admin ; Name: New Task name 100; Project: ; State: Created; Reason: New; Folder: ; Parent: ; Assigned To: admin Note: abcdef... ",
  97. "Title": "(T2627) New Task name 100"
  98. },
  99. {
  100. "Id": "2ad5640e-bdec-72fc-7953-1d1778c6c2dc",
  101. "DocumentType": "Entity",
  102. "DocumentName": "Entity_Countries",
  103. "Code": "CNTR26",
  104. "Content": "Number: 100; IANA Country Code TLD: .bg; Creator: System... ",
  105. "Title": "Bulgaria ( BG / BGR )"
  106. }
  107. ],
  108. "LoadedResultsCount": 12,
  109. "AllResultsCount": 12
  110. }