Hinzufügen
| Slot |
Beschreibung |
| contentFileAdd |
Diese Funktion fügt eine neue Content-Datei hinzu |
Dateisystem:
Eingabeparameter
| Key |
Type |
Description |
| folderId |
Integer |
ID des übergeordneten Ordners |
| name |
String |
Dateiname (wird auch zur Bestimmung des MimeType verwendet) |
| description |
String (optional) |
Beschreibung der Datei |
| securitySchemeID |
String |
‘public’: Datei ist öffentlich, ‘private’: Datei ist nicht öffentlich |
| permissionObjectType |
String |
Muss als ‘Session’ angegeben werden |
| permissionObjectID |
String |
Die ID des Objekttyps kann frei gewählt werden |
| data |
String (optional) |
Base64-kodierter Inhalt der Datei |
| uploadSession |
String (optional) |
Sitzung eines AppServer Html5 Uploads |
| copyFrom |
Integer (optional) |
ID der kopierten Datei |
Hinweis:
Der Inhalt der Datei kann auf drei verschiedene Arten übertragen werden. Genau einer der folgenden Parameter muss übergeben werden:
- data: Der Inhalt wird direkt mit der JSON-Anfrage als Base64-kodiertes Byte-Array übergeben.
- uploadSession: Der Content wird zuerst per Chunked-HTML5-Upload zum AppServer übertragen und die zurückgegebene Session als Quelle verwendet. Das Content Repository Plugin lädt die Datei vom App-Server herunter und verwendet sie als Content der Datei
- copyFrom: Der Inhalt wird von einer anderen bestehenden Content-Datei kopiert (copyFrom enthält die ID der zu kopierenden Datei). Achtung: Der aufrufende Benutzer muss über die entsprechenden Berechtigungen zum Lesen der Content-Datei verfügen. Es wird nur der Inhalt kopiert, nicht andere Eigenschaften (wie Namen, Zugriffsrechte usw.). Jede Content-Datei kann als Quelldatei verwendet werden, auch in einem anderen Repository.
{
"folderId" : 5,
"name" : "test.txt",
"description" : "Meine Dateibeschreibung",
"securitySchemeID" : "public",
"permissionObjectType" : "Session",
"permissionObjectID" : "abc",
"data" : "dGVzdA=="
}
Ausgabeparameter
| Key |
Type |
Description |
| id |
Integer |
ID der erstellten Content-Datei |
| name |
String |
Name der erstellten Content-Datei |
{
"id": 15,
"name": "test.txt"
}
ClearFileSystem:
Eingabeparameter
| Key |
Type |
Description |
| contentId |
Integer |
ID des Content-Repositorys |
| fileName |
String |
Name der Datei |
| folderPath |
String |
Pfad, unter dem die Datei gespeichert werden soll |
| data |
String (optional) |
Base64-kodierter Inhalt der Datei |
| uploadSession |
String (optional) |
Sitzung eines AppServer Html5 Uploads |
| copyFrom |
String (optional) |
ID der kopierten Datei |
| forceOverwrite |
Boolean (optional) |
Wenn das Flag den Wert ‘true’ hat, wird jede vorhandene Datei mit demselben Namen überschrieben;
Wenn nicht gesetzt oder ‘false’, führt die Erstellung zu einem Fehler, wenn bereits eine Datei mit demselben Namen vorhanden ist |
Hinweis:
Der Inhalt der Datei kann auf drei verschiedene Arten übertragen werden. Genau einer der folgenden Parameter muss übergeben werden:
- data: Der Inhalt wird direkt mit der JSON-Anfrage als Base64-kodiertes Byte-Array übergeben.
- uploadSession: Der Inhalt wird zuerst über Chunked HTML5-Upload zum AppServer übertragen und die zurückgegebene Sitzung wird als Quelle verwendet. Das Content-Repo-Plugin lädt die Datei vom AppServer herunter und verwendet sie als Inhalt der Datei
- copyFrom: Der Inhalt wird von einer anderen bestehenden Content-Datei kopiert (copyFrom enthält die ID der zu kopierenden Datei). Achtung: Der aufrufende Benutzer muss über die entsprechenden Berechtigungen zum Lesen der Content-Datei verfügen. Es wird nur der Inhalt kopiert, nicht andere Eigenschaften (wie Namen, Zugriffsrechte usw.). Jede Content-Datei kann als Quelldatei verwendet werden, auch in einem anderen Repository.
{
"contentId" : 5,
"fileName" : "test.txt",
"folderPath" : "MyParentFolder/MyChildFolder"
"data" : "dGVzdA=="
}
Finden
| Slot |
Beschreibung |
| contentFileFind |
Diese Funktion listet die gesuchte Content-Datei auf |
Dateisystem:
Eingabeparameter
| Key |
Type |
Description |
| folderId |
Integer |
ID des Content-Ordners, in dem der Content aufgelistet wird |
| name |
String |
Name der gesuchten Datei |
{
"folderId": 3,
"name": "test.txt"
}
Ausgabeparameter
| Key |
Type |
Description |
| files |
Array |
Array aller Dateien (max. 1 Element) |
| id |
Integer |
ID der Datei |
| name |
String |
Name der Datei |
| description |
String |
Beschreibung der Datei |
| permissionObjectType |
String |
Muss als ‘Session’ angegeben werden |
| permissionObjectID |
String |
Die ID des Objekttyps kann frei gewählt werden |
| securitySchemeID |
String |
Sicherheitsschema (‘public’/’private’) |
| statusSchemeID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| statusID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| mimeType |
Object |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"files": [
{
"id": 3,
"name": "test.txt",
"description": "Meine Dateibeschreibung 1",
"statusSchemeID": "Default",
"statusID": "Default",
"securitySchemeID": "public",
"permissionObjectType": "Session",
"permissionObjectID": "abc",
"mimeType": {
"extension": "jpg",
"mimeType": "image"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/ParentFolder/ChildFolder/file.jpg/",
}
]
}
ClearFileSystem:
Eingabeparameter
| Key |
Type |
Description |
| contentId |
Integer |
ID des Content-Repositorys, in dem Sie suchen möchten |
| fileName |
String |
Name der gesuchten Datei |
| folderPath |
String (optional) |
Pfad des Ordners, in dem gesucht werden soll |
{
"contentId": 3,
"filename": "test.txt",
"folderPath: "MyParentFolder/MyChildfolder"
}
Ausgabeparameter
| Key |
Type |
Description |
| files |
Array |
Array aller Dateien |
| filePath |
String |
Pfad der Datei |
| mimeType |
Object |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"files": [
{
"filePath": "MyParentFolder/MyChildFolder/test.txt",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test.txt/"
},
{
"filePath": "MyParentFolder/MyChildFolder/MyFolder/test.txt",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/MyFolder/test.txt/"
}
]
}
Liste
| Slot |
Beschreibung |
| contentFileList |
Diese Funktion listet eine Datei auf |
Dateisystem:
Eingabeparameter
| Key |
Type |
Description |
| folderId |
Integer |
ID des aufgelisteten Content-Ordners |
{
"folderId": 3
}
Ausgabeparameter
| Key |
Type |
Description |
| files |
Array |
Array aller Dateien |
| id |
Integer |
ID der Datei |
| name |
String |
Name der Datei |
| description |
String |
Beschreibung der Datei |
| permissionObjectType |
String |
Muss als ‘Session’ angegeben werden |
| permissionObjectID |
String |
Die ID des Objekttyps kann frei gewählt werden |
| securitySchemeID |
String |
Sicherheitsschema (‘public’/’private’) |
| statusSchemeID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| statusID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| mimeType |
Object |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"files": [
{
"id": 3,
"name": "test.txt",
"description": "Meine Dateibeschreibung 1",
"statusSchemeID": "Default",
"statusID": "Default",
"securitySchemeID": "public",
"permissionObjectType": "Session",
"permissionObjectID": "abc",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test.txt/"
},
{
"id": 4,
"name": "test2.txt",
"description": "Meine Dateibeschreibung 2",
"statusSchemeID": "Default",
"statusID": "Default",
"securitySchemeID": "public",
"permissionObjectType": "Session",
"permissionObjectID": "abc",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test2.txt/"
}
]
}
ClearFileSystem:
Eingabeparameter
| Key |
Type |
Description |
| contentId |
Integer |
ID des aufgelisteten Content-Repositorys |
| folderPath |
String (optional) |
Pfad des Ordners der aufgelisteten Dateien |
{
"contentId": 3,
"folderPath": "MyFolder"
}
Ausgabeparameter
| Schlüssel |
Typ |
Beschreibung |
| Dateien |
Array |
Array aller Dateien |
| Dateiname |
String |
Name der Datei |
| mimeType |
Objekt |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"files": [
{
"fileName": "test.txt",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test.txt/"
},
{
"name": "test2.txt",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test2.txt/"
}
]
}
Abrufen
| Slot |
Beschreibung |
| contentFileGet |
Diese Funktion fragt ab |
Dateisystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| id |
Integer |
Primärschlüssel |
{
"id": 3
}
Ausgabeparameter
| Schlüssel |
Typ |
Beschreibung |
| id |
Integer |
ID der Datei |
| folderId |
Integer |
ID des übergeordneten Ordners |
| name |
String |
Name der Datei |
| description |
String |
Beschreibung der Datei |
| permissionObjectType |
String |
Muss als ‘Session’ angegeben werden |
| permissionObjectID |
String |
Die ID des Objekttyps kann frei gewählt werden |
| securitySchemeID |
String |
Sicherheitsschema (‘public’/’private’) |
| statusSchemeID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| statusID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| data |
String |
Base64-codierter Inhalt der Datei |
| mimeType |
Objekt |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"id": 3,
"folderId": 5,
"name": "test.txt",
"description": "Meine Dateibeschreibung",
"statusSchemeID": "Default",
"statusID": "Default",
"securitySchemeID": "public",
"permissionObjectType": "Session",
"permissionObjectID": "abc",
"data": "dGVzdA==",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test.txt/"
}
ClearFileSystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| contentId |
Integer |
ID des aufgelisteten Content-Repositorys |
| filePath |
String |
Pfad der Datei |
{
"contentId": 3,
"filePath": "MyFolder/test.txt"
}
Ausgabeparameter
| Schlüssel |
Typ |
Beschreibung |
| filePath |
String |
Dateiname |
| data |
String |
Base64-codierter Inhalt der Datei |
| length |
Integer |
Länge der Datei in Bytes |
| mimeType |
Objekt |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"filePath": "MyFolder/test.txt",
"data": "dGVzdA==",
"length": 59570,
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyFolder/test.txt/"
}
Metadaten abrufen
| Slot |
Beschreibung |
| contentFileGetMetadata |
Diese Funktion fragt die Metadaten ab |
Dateisystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| id |
Integer |
Primärschlüssel |
{
"id": 3
}
Ausgabeparameter
| Schlüssel |
Typ |
Beschreibung |
| id |
Integer |
ID der Datei |
| folderId |
Integer |
ID des übergeordneten Ordners |
| name |
String |
Dateiname |
| description |
String |
Beschreibung der Datei |
| permissionObjectType |
String |
Muss als ‘Session’ angegeben werden |
| permissionObjectID |
String |
Die ID des Objekttyps kann frei gewählt werden |
| securitySchemeID |
String |
Sicherheitsschema (‘public’/’private’) |
| statusSchemeID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| statusID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| mimeType |
Objekt |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"id": 3,
"folderId": 5,
"name": "test.txt",
"description": "Meine Dateibeschreibung",
"statusSchemeID": "Default",
"statusID": "Default",
"securitySchemeID": "public",
"permissionObjectType": "Session",
"permissionObjectID": "abc",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test.txt"
}
ClearFileSystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| contentId |
Integer |
ID des aufgelisteten Content-Repositorys |
| filePath |
String |
Pfad der Datei |
{
"contentId": 3,
"filePath": "MyFolder/test.txt"
}
Ausgabeparameter
| Schlüssel |
Typ |
Beschreibung |
| filePath |
String |
Dateiname |
| mimeType |
Objekt |
MimeType-Informationen |
| mimeType/extension |
String |
Die Dateierweiterung |
| mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| url |
String |
Die Download-URL der Datei |
{
"filePath": "MyFolder/test.txt",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyFolder/test.txt"
}
Stapelweise Metadaten abrufen
| Slot |
Beschreibung |
| contentFileGetMetadataBatched |
Diese Funktion fragt die Metadaten stapelweise ab |
Dateisystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| contentId |
Integer |
ID des Repositorys, in dem die Dateien gespeichert sind |
| files |
Array[Object] |
Eine Liste von Dateiobjekten |
| files/id |
Integer |
ID der Datei |
{
"contentId": 1,
"files": [{
"id": 1
},
{
"id": 2
}]
}
Ausgabeparameter
| Schlüssel |
Typ |
Beschreibung |
| fileMetadata |
Array[Object] |
Eine Liste von Metadatenobjekten |
| fileMetadata/id |
Integer |
ID der Datei |
| fileMetadata/folderId |
Integer |
ID des übergeordneten Ordners |
| fileMetadata/name |
String |
Name der Datei |
| fileMetadata/description |
String |
Beschreibung der Datei |
| fileMetadata/permissionObjectType |
String |
Muss als ‘Session’ angegeben werden |
| fileMetadata/permissionObjectID |
String |
Die ID des Objekttyps kann frei gewählt werden |
| fileMetadata/securitySchemeID |
String |
Sicherheitsschema (‘public’/’private’) |
| fileMetadata/statusSchemeID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| fileMetadata/statusID |
String |
Statusschema (noch nicht implementiert; immer ‘default’) |
| fileMetadata/mimeType |
Objekt |
MimeType-Informationen |
| fileMetadata/mimeType/extension |
String |
Die Dateierweiterung |
| fileMetadata/mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| fileMetadata/url |
String |
Die Download-URL der Datei |
{
fileMetadata: [{
"id": 1,
"folderId": 5,
"name": "test.txt",
"description": "Meine Dateibeschreibung",
"statusSchemeID": "Default",
"statusID": "Default",
"securitySchemeID": "public",
"permissionObjectType": "Session",
"permissionObjectID": "abc",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder/test.txt"
},
{
"id": 2,
"folderId": 3,
"name": "picture.jpg",
"description": "Meine Dateibeschreibung",
"statusSchemeID": "Default",
"statusID": "Default",
"securitySchemeID": "public",
"permissionObjectType": "Session",
"permissionObjectID": "abc",
"mimeType": {
"extension": "jpg",
"mimeType": "picture"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/MyParentFolder/MyChildFolder2/picture.jpg"
}]
}
ClearFileSystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| contentId |
Integer |
ID des aufgelisteten Content-Repositorys |
| files |
Array[Object] |
Eine Liste von Datei-Objekten |
| files/filePath |
String |
Pfad der Datei |
{
"contentId": 6,
"files": [{
"filePath": "Folder/picture.jpg"
},
{
"filePath": "Folder2/text.txt"
}]
}
Ausgabeparameter
| Schlüssel |
Typ |
Beschreibung |
| fileMetadata |
Array[Object] |
Eine Liste von Metadaten-Objekten |
| fileMetadata/filePath |
String |
Dateiname |
| fileMetadata/mimeType |
Object |
MimeType-Informationen |
| fileMetadata/mimeType/extension |
String |
Die Dateierweiterung |
| fileMetadata/mimeType/mimeType |
String |
Der im MimeMapping für die Dateierweiterung gespeicherte MimeType |
| fileMetadata/url |
String |
Die Download-URL der Datei |
{
fileMetadata: [{
"filePath": "Folder/picutre.jpg",
"mimeType": {
"extension": "jpg",
"mimeType": "picture"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/Folder/picture.jpg"
},
{
"filePath": "Folder2/test.txt",
"mimeType": {
"extension": "txt",
"mimeType": "text"
},
"url": "http://localhost:8080/client/2.0/plugin/contentRepoPlugin/file/RepoName/Folder2/test.txt"
}]
}
Bearbeiten
| Slot |
Beschreibung |
| contentFileEdit |
Diese Funktion bearbeitet eine Content-Datei |
Dateisystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| id |
Integer |
ID der zu verarbeitenden Daten |
| name |
String |
Dateiname (wird auch zur Bestimmung des MimeType verwendet) |
| description |
String (Optional) |
Beschreibung der Datei |
| securitySchemeID |
String |
‘public’: Datei ist öffentlich, ‘private’: Datei ist nicht öffentlich |
| permissionObjectType |
String |
Muss als ‘Session’ angegeben werden |
| permissionObjectID |
String |
Die ID des Objekttyps kann frei gewählt werden |
| data |
String |
Base64-kodierter Inhalt der Datei |
{
"id" : 5,
"name" : "test.txt",
"description": "Meine neue Dateibeschreibung",
"securitySchemeID" : "public",
"permissionObjectType" : "Session",
"permissionObjectID" : "abc",
"data" : "dGVzdA=="
}
ClearFileSystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| contentId |
Integer |
ID des Content-Repositorys, in dem die Datei gespeichert ist |
| sourceFilePath |
String |
Pfad der zu bearbeitenden Datei |
| destFilePath |
String |
Pfad inkl. neuem Namen, unter dem die Datei gespeichert werden soll |
| forceOverwrite |
Boolean (optional) |
Wenn das Flag den Wert ‘true’ hat, wird jede vorhandene Datei mit demselben Namen überschrieben;
Wenn nicht gesetzt oder ‘false’, führt die Erstellung zu einem Fehler, wenn bereits eine Datei mit demselben Namen vorhanden ist |
{
"contentId" : 5,
"sourceFilePath" : "MyParentFolder/test.txt",
"destFilePath": "MyParentFolder/MyChildFolder/myRenamedMovedFile.txt"
}
Löschen
| Slot |
Beschreibung |
| contentFileDelete |
Diese Funktion löscht eine Content-Datei |
Dateisystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| id |
Integer |
Primärschlüssel |
{
"id": 15
}
ClearFileSystem:
Eingabeparameter
| Schlüssel |
Typ |
Beschreibung |
| contentId |
Integer |
ID des Content-Repositorys, in dem die Datei gespeichert ist |
| filePath |
String |
Pfad der zu löschenden Datei |
{
"contentId": 10,
"filePath" : "MyFolder/myFile.txt"
}