Endpoints
About
All HTTP methods should be prepended by this service's endpoint:
See below the REST resources and their endpoints available in this service.
Products (Beta)
Resources
This feature has the following endpoints available:
Description | Endpoints |
---|---|
Get all products | GET /users/{leafUserId}/products |
Get all products normalized | GET /users/products |
Search for products | GET /users/{leafUserId}/products/search |
Get all products
 GET /users/{leafUserId}/products
List the existing products used by a leaf user.
Parameter (to filter by) | Values |
---|---|
name | part of the product name |
You can also pass some parameters used exclusively for paging through results. They are:
page
, an integer specifying the page being fetched (default is 0)size
, an integer specifying the size of the page (max is 100)sort
, the sorting order of the results; can be multivalue, the former takes precedence over the later; can also specify order asasc
ordesc
withasc
being the default. Example: id,desc
- cURL
- Python
- JavaScript
Response
The response is a JSON array containing products records.
Get all products normalized
 GET /users/products
Returns a list of the unique products with normalized name to lower case and how many related files exists.
Parameter (to filter by) | Values |
---|---|
leafFileId | UUID |
normalizedName | part of the product name |
- cURL
- Python
- JavaScript
Response
The response is a JSON array with total of files that has the products that match the search criteria.
Search for products
 GET /beta/products/search
Search for products by name, partial values are supported.
Parameter (to filter by) | Values |
---|---|
leafFileId | UUID |
search | part of the product name to be searched |
maxResults | the number of results that should be returned (max value is 20) |
- cURL
- Python
- JavaScript
Response
The response is a JSON array the products that match query.
Varieties (Beta)
Resources
This feature has the following endpoints available:
Description | Endpoints |
---|---|
Get all varieties | GET /users/{leafUserId}/varieties |
Get all varieties normalized | GET /users/varieties |
Get All Varieties
 GET /users/{leafUserId}/varieties
Get all varieties from a leaf user.
Parameter (to filter by) | Values |
---|---|
name | text |
crops | text |
You can also pass some parameters used exclusively for paging through results. They are:
page
, an integer specifying the page being fetched (default is 0)size
, an integer specifying the size of the page (max is 100)sort
, the sorting order of the results; can be multivalue, the former takes precedence over the later; can also specify order asasc
ordesc
withasc
being the default. Example: id,desc
- cURL
- Python
- JavaScript
Response
The response is a json list with all the varieties
Get all varieties normalized
 GET /users/varieties
- cURL
- Python
- JavaScript
Response
The response is a JSON array showing the existing varieties and how many related files exists.