api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
api [2017/09/19 17:38] – [More documentation] lucy | api [2022/03/05 18:12] (current) – [API Records Return Limit] lucysecurity | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== LUCY REST API - Background Info ===== | ===== LUCY REST API - Background Info ===== | ||
- | Lucy API is a RESTful web service. The API does not keep the client' | + | Lucy API is a RESTful web service. The API does not keep the client' |
+ | |||
+ | {{ api1.png? | ||
===== Requirements ===== | ===== Requirements ===== | ||
Line 29: | Line 31: | ||
server expects when you are creating a new campaign. The only difference is links - when you are posting/ | server expects when you are creating a new campaign. The only difference is links - when you are posting/ | ||
+ | ===== 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 " | ||
+ | |||
+ | Example of limit customization: | ||
+ | {GET / | ||
===== Example Usage ===== | ===== Example Usage ===== | ||
Line 73: | Line 83: | ||
{" | {" | ||
+ | ===== 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-v3.7.pdf|here}}. | + | The detailed documentation |
+ | |||
+ | {{ api_documentation.png? | ||
+ | |||
+ | There' | ||
api.1505835491.txt.gz · Last modified: 2019/07/25 12:51 (external edit)