mike/archive
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Updated API (markdown)

fhimpg 2024-06-05 11:11:29 +02:00
parent 43e2a7124f
commit 35f763f18e
1 changed files with 7 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
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.