User Tools

Site Tools


api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
api [2018/07/31 18:31] – [Detailed Documentation] lucyapi [2022/03/05 18:12] (current) – [API Records Return Limit] lucysecurity
Line 31: Line 31:
 server expects when you are creating a new campaign. The only difference is links - when you are posting/putting something to API, the server does not expect any links (and ignores them if they are present in request). The links are only used for exposing relations in GET requests. For specifying relations with other existing objects in system, please use integer IDs. server expects when you are creating a new campaign. The only difference is links - when you are posting/putting something to API, the server does not expect any links (and ignores them if they are present in request). The links are only used for exposing relations in GET requests. For specifying relations with other existing objects in system, please use integer IDs.
  
 +===== API Records Return Limit =====
 +
 +All endpoints returning a list of Resources, by default, can return only 100 records. If necessary, this can be changed using request parameters LIMIT and OFFSET.\\
 +
 +The maximum LIMIT is "1000". Any LIMIT values exceeding 1000 will return maximum of 1000 records.\\
 +
 +Example of limit customization:\\
 +  {GET /api/campaigns?sort=-created_at&offset=10&limit=10}
  
 ===== Example Usage ===== ===== Example Usage =====
Line 75: Line 83:
   {"recipient":{"email":"oliver@test.com","phone":null,"name":"Oliver   Test","staff_type":null,"location":null,"division":null,"comment":null,"link":null,"language_id":null,"recipient_group_id":262,"id":"158928","last_tested":null,"links":[{"rel":"self","href":"/api/recipients/158928"},  {"rel":"recipient_group","href":"/api/recipient-groups/262"}]}}   {"recipient":{"email":"oliver@test.com","phone":null,"name":"Oliver   Test","staff_type":null,"location":null,"division":null,"comment":null,"link":null,"language_id":null,"recipient_group_id":262,"id":"158928","last_tested":null,"links":[{"rel":"self","href":"/api/recipients/158928"},  {"rel":"recipient_group","href":"/api/recipient-groups/262"}]}}
  
 +===== API End Points =====
 +
 +The complete list of API End Points supported by LUCY can be found [[api_end_points|here]]
  
 ===== Detailed Documentation ===== ===== Detailed Documentation =====
  
-A more detailed documentation can be found {{::lucy-rest-api-latest.pdf|here}}.+The detailed documentation for LUCY REST API is available from within the LUCY web interface in the section Settings > API Whitelist > API Documentation. 
 + 
 +{{ api_documentation.png?600 }} 
 + 
 +There's also PDF documentation (for v.4.8.3) can be found {{::lucy_rest_api_documentation.pdf|here}}.
  
api.1533054703.txt.gz · Last modified: 2019/07/25 12:51 (external edit)