new ChinoAPISearch(baseUrl, customerId, customerKey)
Create a caller for Search Chino APIs
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
baseUrl |
string | The url endpoint for APIs |
|
customerId |
string | The Chino customer id or bearer token |
|
customerKey |
string | null | null | The Chino customer key or null (not provided) |
Methods
documents(schemaId, searchParams, offset, limit) → {Promise.<Array, objects.ChinoException>}
Return all matching documents inside selected schema
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
schemaId |
string | ||
searchParams |
object | ||
offset |
int | 0 | |
limit |
int | 10 |
Returns:
A promise that return a list of Document objects if resolved, otherwise throw an ChinoException object if rejected or was not retrieved a success status
- Type
- Promise.<Array, objects.ChinoException>
users(userSchemaId, searchParams, offset, limit) → {Promise.<Array, objects.ChinoException>}
Return all matching user inside selected user schema
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
userSchemaId |
string | ||
searchParams |
object | ||
offset |
int | 0 | |
limit |
int | 10 |
Returns:
A promise that return a list of Document objects if resolved, otherwise throw an ChinoException object if rejected or was not retrieved a success status
- Type
- Promise.<Array, objects.ChinoException>