Deprecated
| Alternative | /api/v2/node!search |
|---|
Response [200 Ok]
| Uri | /api/v2/folder/user/George-Ackley/Washington!search?start=-9&count=10 |
|---|---|
| UriDescription | Search for folders |
| EndpointType | FolderSearch |
| Locator | FolderByID |
| LocatorType | Objects |
Pages
| Count | 0 |
|---|---|
| FirstPage | /api/v2/folder/user/George-Ackley/Washington!search?start=1&count=10 |
| LastPage | /api/v2/folder/user/George-Ackley/Washington!search?start=-9&count=10 |
| RequestedCount | 10 |
| Start | 1 |
| Total | 0 |
Request
| Uri | /api/v2/folder/user/George-Ackley/Washington!search?start=-9&count=10 |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- _multiargs does not work at this endpoint
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/folder/user/George-Ackley/Washington!search?start=-9&count=10"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
}
},
"Methods": [
"OPTIONS",
"GET"
],
"ParameterDescription": {
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"Select": "Select one option. Options should pass only the \"Value\"."
},
"Parameters": {
"GET": [
{
"Name": "Text",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Search all text fields",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "SortMethod",
"Required": false,
"ReadOnly": false,
"Default": "_score",
"Type": "Select",
"OPTIONS": [
"Rank",
"LastUpdated"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortDirection",
"Required": false,
"ReadOnly": false,
"Default": "Descending",
"Type": "Select",
"OPTIONS": [
"Ascending",
"Descending"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
}
]
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Notes": [
"_multiargs does not work at this endpoint"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "folder"
},
{
"type": "path",
"text": "user"
},
{
"type": "singleparam",
"param_name": "nickname",
"param_value": "George-Ackley",
"param_validator": {}
},
{
"type": "multipleparam",
"param_name": "folder",
"param_value": [
"Washington"
],
"param_validator": {}
},
{
"type": "action",
"text": "search"
}
],
"Deprecated": {
"Alternative": "/api/v2/node!search"
}
},
"Response": {
"Uri": "/api/v2/folder/user/George-Ackley/Washington!search?start=-9&count=10",
"Locator": "FolderByID",
"LocatorType": "Objects",
"UriDescription": "Search for folders",
"EndpointType": "FolderSearch",
"Pages": {
"Total": 0,
"Start": 1,
"Count": 0,
"RequestedCount": 10,
"FirstPage": "/api/v2/folder/user/George-Ackley/Washington!search?start=1&count=10",
"LastPage": "/api/v2/folder/user/George-Ackley/Washington!search?start=-9&count=10"
},
"Timing": {
"Total": {
"time": 0.12145,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}