From 35f763f18ef96d30e53de1f5e65e3eb64c86e3f4 Mon Sep 17 00:00:00 2001 From: fhimpg <75040742+fhimpg@users.noreply.github.com> Date: Wed, 5 Jun 2024 11:11:29 +0200 Subject: [PATCH] Updated API (markdown) --- API.md | 33 +++++++-------------------------- 1 file changed, 7 insertions(+), 26 deletions(-) diff --git a/API.md b/API.md index 07fa6e6..4f121d0 100644 --- a/API.md +++ b/API.md @@ -23,10 +23,12 @@ Renew access token. ``` # get -Get complete entries with metadata, document list and link list. +Get complete entries with metadata, document list and link list. Entries can be passed as a comma-separated list in the URL or as an array in a post request. `curl -s -d '{"token":"MYSECRETTOKEN"}' https://my.domain/v1/get/d51300` +`curl -X POST -s -d '{"token":"MYSECRETTOKEN","ids":["D12","D34"}' https://my.domain/v1/get` + ```json { "success": 1, @@ -84,10 +86,12 @@ Get complete entries with metadata, document list and link list. # getraw -Get complet entry with metadata, document list and link list and raw field names. +Get complet entry with metadata, document list and link list and raw field names. Entries can be passed as a comma-separated list in the URL or as an array in a post request. `curl -s -d '{"token":"MYSECRETTOKEN"}' https://my.domain/v1/getraw/d51300` +`curl -X POST -s -d '{"token":"MYSECRETTOKEN","ids":["D12","D34"}' https://my.domain/v1/getraw` + ```json { "success": 1, @@ -144,30 +148,7 @@ Get complet entry with metadata, document list and link list and raw field names ``` # bulk -Get multiple entries at once - -`curl -s -d '{"token":"MYSECRETTOKEN"}' https://my.domain/v1/bulk/d123,d124,d125` - -```json -[ - { - "success": 1, - "id": "D123", - ... - }, - { - "success": 1, - "id": "D124", - ... - }, - { - "success": 1, - "id": "D125", - ... - } -] -``` - +This command ist deprecated, use get instead. # list Get list of all entries.