FileUpload

Mit dieser Ressource können Dateianhänge an Prozessaktivitäten oder Arbeitselemente angehängt werden.

Methodenübersicht

HTTP-Methode Pfad Beschreibung
POST /scr/api/FileUpload Fügt Dateianhänge zu Prozessaktivitäten oder Arbeitselementen hinzu.

POST /scr/api/FileUpload

Beschreibung
Mit dieser Methode können Dateianhänge an Prozessaktivitäten oder Arbeitselemente angehängt werden.
Ressourceninformationen
Anforderungen Beschreibung
Antwortformat JSON
Erfordert Authentifizierung Ja. Der Benutzer benötigt Autorenzugriff auf den Prozess, an den die Datei angehängt wird.
Unterstützt OAuth 2-Clientberechtigungsnachweise Ja, es wird eine Benutzer-Service-ID verwendet, die die Kategorie 'Artefaktauthoring' enthält.
Begrenzte Rate Noch nicht
Parameter
Die Einträge für locationField, ancestorIdField, parentIdField und fileData müssen im normalen Format für mehrteilige Formulardaten übergeben werden.
Name Standort Beschreibung Erforderlich Typ
X-IBM-API-Version Header Die Version der zu verwendenden API. Der Wert muss 20160630 lauten. Nein Zeichenfolge
X-On-Behalf-Of Header Der Benutzerkontext. Der Wert muss ein Benutzername im Account sein. Der Benutzer muss über die Berechtigung zum Ausführen der Aktion im Account und im angegebenen übergeordneten Speicherbereich verfügen, sofern vorhanden. Erforderlich, wenn OAuth-Berechtigungsnachweise für Service-ID verwendet werden. Nicht erforderlich, wenn der OAuth-Berechtigungsnachweis der Benutzerservice-ID verwendet wird. Zeichenfolge
fileData Query Die Dateidaten. Ja RFC 1867-konformer mehrteiliger Formulardatenstrom
locationField Query Abhängig von dem Objekt, an das die Datei angehängt ist, sind die gültigen Werte activity, app, decision, instance, policyoder post. Ja Zeichenfolge
ancestorIdField Query Die Bedeutung hängt vom Wert in locationField ab:
  • Die Prozessentwurf-ID für einen activity
  • Die Prozessanwendungs-ID für einen app
  • Die Entscheidungsdiagramm-ID für einen decision
  • Die Arbeits-ID einer vorhandenen Instanz für einen instance
  • Für alle anderen locationField-Werte muss dieser Parameter nicht angegeben werden.
 Ja Zeichenfolge
parentIdField Query Die Bedeutung hängt vom Wert in locationField ab:
  • Die Prozess-ID für einen activity
  • Die Anwendungs-ID für einen app
  • Die Entscheidungs-ID für einen decision
  • Die Arbeits-ID einer vorhandenen Instanz für einen instance
  • Die Richtlinien-ID für einen policy
  • Dieser Wert muss für post nicht angegeben werden
 Ja Zeichenfolge
Antwort
Beispielausgabe
{  
   "size":"3.0",
   "parentId":"",
   "uploadUserId":"7f0002",
   "fileItemId":"123b",
   "name":"testFileUpload",
   "ancestorId":"",
   "uploadDate":"1441217698308",
   "status":"SUCCESS",
   "isPublic":"false",
   "location":"instance",
   "uploadUserName":"admin",
   "version":"20160630",
   "type":"1",
   "id":"5f501e134978a"
}
Antworteigenschaften
uploadUserId
Die ID des Benutzers, der die Datei hochgeladen hat.
location
Die Speicherposition, zu der die Datei hochgeladen wurde.
status
Der Zeichenfolgewert, der das Ergebnis des Uploadversuchs angibt. Mögliche Werte:
SUCCESS
Die Operation war erfolgreich.
FAILED
Der Upload ist fehlgeschlagen.
FAILED_DELETED
Der Upload ist fehlgeschlagen. Überprüfen Sie die Datei auf Viren, und versuchen Sie es erneut.
SIZE
Der Upload ist fehlgeschlagen, weil die Datei größer als 50 MB war.
SPACE
Der Upload ist fehlgeschlagen, weil der Speicherplatz des Accounts nicht ausreichend war.
type
Der Datei- oder Dokumenttyp mit dem zugehörigen numerischen Wert.
Typwert Beschreibung
1 Allgemeines Dokument. Dieser Typ wird verwendet, wenn für die Datei keiner der anderen Werte zutrifft.
2 Microsoft Excel-Datei
3 Image
4 PDF-Dokument
5 Microsoft PowerPoint-Dokument
6 Microsoft Project-Dokument
7 Microsoft Visio-Dokument
8 Microsoft Word-Dokument
9 Textdatei
version
Die Version der API, die zum Erstellen der Antwort verwendet wurde.
size
Die Größe der hochgeladenen Datei in Byte.
id
Die ID des hochgeladenen Profils. Verwenden Sie diese ID mit dem Service FileDownload, um die Datei herunterzuladen.
parentId
Die ID des übergeordneten Elements, an das die hochgeladene Datei angehängt wird.
name
Der Name der hochgeladenen Datei.
ancestorId
Die ID des Vorfahren (übergeordnetes Element), zu dem die hochgeladenen Datei gehört.
uploadDate
Das Datum, an dem die Datei hochgeladen wurde. Der Wert wird in Millisekunden seit 'The Epoch' (Unixzeit) angegeben, d. h., seit 1. Januar 1970, Mitternacht, koordinierte Weltzeit (Coordinated Universal Time, UTC).
uploadUserName
Der Name des Benutzers, der die Datei hochgeladen hat.
Antwortnachrichten
HTTP-Code Grund
200

Die Anforderung wurde erfolgreich ausgeführt.
401

Der Benutzer ist nicht berechtigt, diese Anforderung auszuführen.
405 Die angegebene Methode ist nicht zulässig. Wählen Sie die POST-Methode aus.