Ressource hinzufügen/aktualisieren
Hinzufügen oder Aktualisieren (wenn eine Ressource mit der angegebenen Ressourcen-Guid gefunden wird) der eingestellten Ressource.
URL:
POST http://api.aurelon.com/api/v2/
Ressource
Kopfzeilen anfordern:
Inhalt-Typ : multipart/form-data
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Zeitstempel : UTC-Zeit im ISO-Format.
Das Änderungsdatum/die Änderungszeit der Ressource wie „2018-11-01T08:41:34Z“. Wenn der Zeitstempel nicht angegeben wird, wird „jetzt“ angenommen. Der Zeitstempel wird mit dem Zeitstempel der Ressource im Cloud-Speicher verglichen. Es werden nur neuere Ressourcen akzeptiert.
Anfrage Körper:
Formulardaten 1: erforderlich
-
- Name: JsonString
- Inhalt-Typ: application/json
- JSON-Objekt enthält:
- Ressourcen-GUID – erforderlich – die Resource GUID
- ResourceChecksum – required – SHA1-Prüfsumme der Ressource im Großbuchstabenformat.
- ResourceType – erforderlich
- die Art der Ressource
- bekannter Ressourcentyp: „NormalProfile“, „DefectProfile“, „FotobaMarks“, „Label“, „ColorMapping“, „Template“, „LayoutTemplate“, „Library“, „Preview“
- Ressourcentyp kann ein benutzerdefinierter Wert sein
- wenn der Ressourcentyp nicht angegeben wird, wird der Ressourcentyp auf „Allgemein“ gesetzt
- Meta – JSON-Objekt, das die Metadaten über die Ressource enthält;
- MediaType – erforderlich für „NormalProfile“ – das Media-Tag aus dem PMM.
- ProfileGroup – erforderlich für „NormalProfile“ – das ProfileGroup-Tag aus dem PMM
- Name – erforderlich
Formulardaten 2: erforderlich
- Name: Name der Ressource, beliebiger Name zulässig
- Inhalt-Typ: application/octet-stream
- Binärer Inhalt der Ressource
- Nur eine Datei akzeptiert
Antwort:
Der Inhaltstyp der Antwort ist im JSON-Format
Erfolg:
- 200 OK : „Ressource erfolgreich hinzugefügt“
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Diese Anfrage ist nicht richtig formatiert“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 400 Bad Request : {„Message“: „No input file specified“}
- 400 Bad Request : {„Message“:““ResourceGUID“, „ResourceChecksum“ und „ResourceType“ sind erforderlich“}
- 400 Bad Request : {„Message“: „Validation of Timestamp failed“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Ressource erhalten
Abrufen der Ressourcendatei
URL:
GET http://api.aurelon.com/api/v2/
ressource/<ressourceGUID>
Kopfzeilen anfordern:
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Antwort:
Rückgabe der im Befehl angegebenen Ressourcendatei als Inhaltstyp application/octet-stream
Erfolg:
- 200 OK : Ressourcendatei als Binärstrom
Fehler:
- 401 Nicht autorisiert : {„Nachricht“: „Ungültiger MisKey“}
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 404 Nicht autorisiert : {„Meldung“: „ResourceGUID nicht gefunden“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header required“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Ressource löschen
Löscht die Ressource mit der angegebenen Ressourcen-GUID.
URL:
DELETE http://api.aurelon.com/api/v2/
ressource/<ResourceGUID>
Kopfzeilen anfordern:
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
- 200 OK : „Ressource erfolgreich gelöscht“
Fehler:
- 400 Bad Request : {„Message“:““ResourceGUID“ Wert erforderlich“}
- 400 Bad Request : {„Message“: „Ressource noch in Gebrauch“}
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 404 Nicht gefunden : {„Message“: „ResourceGUID wird nicht gefunden“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Ressourcen auflisten
Abrufen einer gefilterten Liste aller Ressourcen in der Organisation
URL:
POST http://api.aurelon.com/api/v2/
Ressource
/liste
Kopfzeilen anfordern:
Inhalt-Typ : application/json
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Anfrage Körper:
JSON-Objekt, das den Typ enthält, nach dem gefiltert werden soll:
- ResourceTypes – erforderlich – ein Array mit einem oder mehreren der folgenden Typen (*,NormalProfil, DefektProfil, FotobaMarken, Etikett, ColorMapping, Vorlage, LayoutTemplate, Bibliothek, Vorschau). Wenn * verwendet wird, werden alle Ressourcen aufgelistet.
- Domain – optional – abzufragende Domain, zulässige Werte Privat und Öffentlich. Standardwert, wenn Privat, wenn nicht angegeben.
Ex:
{„ResourceTypes“:[„Label“, „Template“]}
Antwort:
Rückgabe der Unternehmensressourcen, gefiltert durch den Anfragekörperfilter. Die Liste ist ein gepacktes Array von Arrays. Jedes Element im Array wird als Ressource durch ein Array mit 4 Elementen dargestellt.
Die gepackte Methode wird verwendet, um bei der Übertragung Platz zu sparen. Die folgenden 4 Elemente werden in der folgenden Reihenfolge vorgestellt:
- RessourcenGUID
- RessourceTyp
- SHA1-Prüfsumme
- Name
Erfolg:
- 200 OK : Rückgabe der Ressourcenliste
[
[„88de5c02-cce6-411f-950f-be309caa4439″,“Label“,“acox3″,”MyName”],
[„1cb6e329-d001-4aff-970e-7cfaf025f27b“,“Label“,“1r3ff“,”Ticket”],
[„267437af-459b-4b9d-8ace-5d52658c4626″,“Template“,“erffeff“,”MyTmp”]
]
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Erwarteter Typ: application/json“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Informationen über Ressourcen erhalten
Abrufen der grundlegenden Informationen über die Ressourcendatei für Synchronisierungszwecke
URL:
GET http://api.aurelon.com/api/v2/
ressource/info/<ResourceGUID>
Kopfzeilen anfordern:
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Antwort:
Rückgabe der Ressourceninformationen im JSON-Format
Erfolg:
- 200 OK : JSON-formatierte Ressourceninformationen. ResourceGUID, ResourceChecksum, ResourceType, Timestamp, Meta und Meta.Name sind immer verfügbar.
{„ResourceGUID“: „“
„ResourceChecksum“: „CF837A01C1F0342B121911A4FE17449D6B463310“,
„Ressourcentyp“: „NormalProfil“,
„Zeitstempel“: „2018-11-01T08:41:34Z“,
„Bereich“: „Privat“,
„Meta“: {
„Name“: „Medien > Modus“,
„ProfilGruppe“: „PDF“,
„Medien“: „Papier“,
„Modus“: „600dpi“
}
Irrtümer:
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“:““MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header required“}
- 401 Nicht autorisiert : {„Message“: „ResourceGUID kein Zugriff“}
- 404 Nicht autorisiert : {„Meldung“: „ResourceGUID nicht gefunden“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}