Summary
Search IAP
Description
Search through IAP for results from various collections that match your search term, as well as for results that have tags that match your search term.
Route
POST /search/find
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| data | object | yes | Search data object |
{ "data": { "text": "test", "limit": 20, "skip": 5 } }
{ "type": "object", "properties": { "data": { "title": "data", "type": "object", "properties": { "text": { "type": "string", "examples": [ "test" ] }, "limit": { "type": "integer", "examples": [ 20 ] }, "skip": { "type": "integer", "examples": [ 5 ] } } } }, "required": [ "data" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| results | object | Search results |
{ "results": [ { "label": "Forms", "type": "The name of the Collection the result came from", "results": [ { "_id": "912fd926-5391-48ff-b265-394d00640f4f", "name": "testForm", "description": "Description for the result is optional.", "url": "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", "tags": [ { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "testTag" }, { "_id": "The id of the tag.", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "testTag" }, { "_id": "The id of the tag.", "description": "Hi I describe the tag", "name": "Name of the tag." } ] }, { "_id": "The id of the result.", "name": "Name of the result.", "description": "Hi I describe the result", "url": "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", "tags": [ { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "testTag" }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "Name of the tag." } ] }, { "_id": "The id of the result.", "name": "testForm", "description": "Description for the result is optional.", "url": "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", "tags": [ { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Hi I describe the tag", "name": "testTag" }, { "_id": "The id of the tag.", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Description for the tag is optional.", "name": "testTag" }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "testTag" } ] }, { "_id": "912fd926-5391-48ff-b265-394d00640f4f", "name": "Name of the result.", "description": "Hi I describe the result", "url": "The shortened url to access the result from.", "tags": [ { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "testTag" }, { "_id": "The id of the tag.", "description": "Hi I describe the tag", "name": "Name of the tag." } ] }, { "_id": "The id of the result.", "name": "testForm", "description": "Hi I describe the result", "url": "The shortened url to access the result from.", "tags": [ { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "testTag" } ] } ], "count": -19221397 }, { "label": "Forms", "type": "The name of the Collection the result came from", "results": [ { "_id": "912fd926-5391-48ff-b265-394d00640f4f", "name": "testForm", "description": "Description for the result is optional.", "url": "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", "tags": [ { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "testTag" } ] }, { "_id": "912fd926-5391-48ff-b265-394d00640f4f", "name": "Name of the result.", "description": "Hi I describe the result", "url": "The shortened url to access the result from.", "tags": [ { "_id": "The id of the tag.", "description": "Hi I describe the tag", "name": "Name of the tag." }, { "_id": "The id of the tag.", "description": "Description for the tag is optional.", "name": "testTag" }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Description for the tag is optional.", "name": "testTag" }, { "_id": "5c8fa4a8d8e04500b1b2f28f", "description": "Hi I describe the tag", "name": "Name of the tag." } ] } ], "count": -48876958 } ] }
{ "title": "results", "$ref": "searchResults" }