...
Die Rest Services können über folgenden Pfad aufgerufen werden:
http://[jEDHOC-Server]/restservices/[Service Path]
Authentifizierung
| Restservice | Beschreibung | Methode | Parameter | Example |
|---|
/authentication/login |
Erstellen einer @Deprecated | Erstellt eine User Session | POST | Query Param: - username: String
- password: String
|
| Code Block |
|---|
curl -X POST \
--location "https://jedhoc.example.org:8443/restservices/authentication/login?username=username&password=password" \
-H "Content-Type: application/json" |
|
| /authentication/login/form | Erstellt eine User Session | POST | Form Param: |
...
| Restservice | Beschreibung | Methode | Parameter | Example |
|---|
| curl -X POST \
--location "https://jedhoc.example.org:8443/restservices/authentication/login/form" \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=username' \
--data-urlencode 'password=password' |
|
Upload
| Expand |
|---|
| title | POST /upload/{sessionid} |
|---|
|
Upload einer Datei über die REST-Api. Die Daten werden als Octet-Stream mitgeschickt. |
...
Path Param:
Query Param:
- fileName: String
- secret: BOOLEAN
- email: String
- comment: String
Parameters| Name | Typ | In | Required | Beschreibung |
|---|
| sessionid | string | path |  | Die Session ID, die bei der Authentifizierung zurückgegeben wurde. | | fileName | string | query |
| Der Dateiname | | secret | boolean | query |
| Soll ein Passwort generiert werden? Default: false | | mail | array[string] | query | | Die Empfänger des Uploads. | | comment | string | query |
| Ein Kommentar | | sendMail | boolean | query |
| Sollen Mails versendet werden?
Default: true |
Example| Code Block |
|---|
curl -X POST --location "https://jedhoc.example.org:8443/restservices/upload/34685fd3-fefa-4c5b-801d-fcfa98671613?fileName=example.jpg&mail=user1@example.org&mail=user2@example.org&comment=Comment&secret=true" \
-H "Content-Type: application/octet-stream" \
-d @\tmp\example.jpg |
Responses| Code Block |
|---|
HTTP/1.1 200 OK
Date: Fri, 04 Mar 2022 09:48:46 GMT
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
Content-Type: application/json
Transfer-Encoding: chunked
{
"_embedded": {
"jedhocFile": {
"hash": "12a2af26-a274-478f-abaa-1e3640e814c8",
"name": "example.jpg",
"password": "n7QllGYI",
"upDate": "2022-03-04T09:48:46.110+0000",
"endDate": "2022-03-11T09:48:46.110+0000",
"comment": "Comment",
"active": true,
"_links": {
"download": {
"href": "https://jedhoc.example.org:8443/download/12a2af26-a274-478f-abaa-1e3640e814c8"
}
}
}
}
} |
|