Seitenverzeichnis:
| Inhalt |
|---|
| maxLevel | 2 |
|---|
| indent | 10px |
|---|
| style | square |
|---|
|
...
shd.file.create
Beschreibung
Erstellen eines File-Objekts.
Parameter
| Parameter | Typ | Version |
|---|
| name | string | ab Version 1.0 |
| type | string | ab Version 1.0 |
| path | string | ab Version 1.0 |
| content (optional) | string | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Beschreibung | Version |
|---|
| message | string | "shd.file.create","params" | ab Version 1.0 |
| response | bool | Liefert entweder true oder false | ab Version 1.0 |
| current_date | string | Datum als String | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
|---|
| Codeblock |
|---|
| {
"method": "shd.file.create",
"params": {
"apikey": "hier_apikey_einsetzen",
"name": "2.png",
"type": "f",
"path": "/maps/.map_preview",
"content": "/9j/4AAQSkZJRgABAQEAZABkAAD/2wBDAAYEBQYFBA",
"language": "en"
},
"id": 1,
"version": "2.0"
} |
|
| Codeblock |
|---|
| {
"jsonrpc": "2.0",
"result": {
"message": "file.create.success",
"response": true,
"current_date": "2017-09-14"
},
"id": 1
} |
|
...
shd.file.read
Beschreibung
Auslesen eines File-Objekts.
Parameter
| Parameter | Typ | Version |
|---|
| path | string | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| name | string | ab Version 1.0 |
| type | string | ab Version 1.0 |
| hash | string | ab Version 1.0 |
| createDate | int | ab Version 1.0 |
| size | int | ab Version 1.0 |
| path | string | ab Version 1.0 |
| content | string | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
|---|
| Codeblock |
|---|
| {
"method": "shd.file",
"params": {
"apikey": "1ialbgclm9",
"path": "/maps/Catalyst 2950-SX-24_1HE.png",
"language": "en"
},
"id": 1,
"version": "2.0"
} |
|
| Codeblock |
|---|
| {
"jsonrpc": "2.0",
"result": {
"name": "Catalyst 2950-SX-24_1HE.png",
"type": "f",
"hash": "fa487fd1e0121d13acd1b1fb6a005127",
"createDate": 1495462402,
"size": 12787,
"path": "/maps",
"content": ""
},
"id": 1
} |
|
...
shd.file.update
Beschreibung
Update eines File-Objekts.
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| name | string | - | ab Version 1.0 |
| type | string | "f" oder "d" | ab Version 1.0 |
| path | string | - | ab Version 1.0 |
| content | string | Base64 |
|
Rückgabewert
| Wert | Typ | Version |
|---|
| message | string | ab Version 1.0 |
| response | bool | ab Version 1.0 |
| current_date | string | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
|---|
| Codeblock |
|---|
| {
"method": "shd.file.update",
"params": {
"apikey": "1ialbgclm9",
"name": "Catalyst.png",
"type": "f",
"hash": "",
"createDate": "",
"size": "",
"path": "/maps/Test1",
"content": "/9j/4AAQSkZJRgABAQEAZABkAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQ",
"language": "en"
},
"id": 1,
"version": "2.0"
} |
|
| Codeblock |
|---|
| {
"jsonrpc": "2.0",
"result": {
"message": "file.update.success",
"response": true,
"current_date": "2017-09-14"
},
"id": 1
} |
|
...
shd.file.delete
Beschreibung
Löschen eines Ordners / einer Datei.
Parameter
| Parameter | Typ | Version |
|---|
| path | string | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| message | string | ab Version 1.0 |
| response | bool | ab Version 1.0 |
| current_date | string | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
|---|
| Codeblock |
|---|
| {
"method": "shd.file.delete",
"params": {
"apikey": "1ialbgclm9",
"path": "/maps/1268__1495462402__Catalyst 2950-SX-24_1HE_dimage.png",
"language": "en"
},
"id": 1,
"version": "2.0"
} |
|
| Codeblock |
|---|
| {
"jsonrpc":"2.0",
"result":{
"message":"file.delete.success",
"response":true,
"current_date":"2017-09-11"
},
"id":1
} |
|
...
shd.file.dir
Beschreibung
Auslesen eines Ordners.
Parameter
| Parameter | Typ | Version |
|---|
| path | string | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| name | string | ab Version 1.0 |
| type | string | ab Version 1.0 |
| hash | string | ab Version 1.0 |
| createDate | int | ab Version 1.0 |
| size | int | ab Version 1.0 |
| path | string | ab Version 1.0 |
| content | null | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
|---|
| Codeblock |
|---|
| {
"method": "shd.file.dir",
"params": {
"apikey": "1ialbgclm9",
"path": "/maps",
"language": "en"
},
"id": 1,
"version": "2.0"
} |
|
| Codeblock |
|---|
| {
"jsonrpc": "2.0",
"result": [
{
"name": "1268__1495462402__Catalyst 2950-SX-24_1HE_dimage.png",
"type": "f",
"hash": "fa487fd1e0121d13acd1b1fb6a005127",
"createDate": 1495462402,
"size": 12787,
"path": "/maps",
"content": ""
},
{
"name": "1300__1495526038__Steckdosenleiste_6_dimage.png",
"type": "f",
"hash": "b1ba61ddf1053ddf2e48c462366a5646",
"createDate": 1495526038,
"size": 13081,
"path": "/maps",
"content": ""
},
{
"name": "1308__1495526896__Steckdosenleiste7_waagerecht_1HE_dimage.png",
"type": "f",
"hash": "22f181c2e75e5dfc537f59a32f8bd66f",
"createDate": 1495526896,
"size": 13011,
"path": "/maps",
"content": ""
}
],
"id": 1
}
|
|
...
shd.file.move
Beschreibung
Umbennen eines File-Objects.
Parameter
| Parameter | Typ | Version |
|---|
| path_new | string | ab Version 1.0 |
| fpath_old | string | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| message | string | ab Version 1.0 |
| response | bool | ab Version 1.0 |
| current_date | string | ab Version 1.0 |
Beispiel
Beispielaufruf | Beispielantwort |
|---|
| Codeblock |
|---|
| {
"method": "shd.file.move",
"params": {
"apikey": "1ialbgclm9",
"path_new": "maps/300.jpg",
"path_old": "maps/3.jpg",
"language": "en"
},
"id": 1,
"version": "2.0"
} |
|
| Codeblock |
|---|
| {
"jsonrpc":"2.0",
"result":{
"message":"file.move.success",
"response":true,
"current_date":"2018-06-14"
},
"id":1
}
|
|