/osrest/api/workflows

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste von Workflows, die vom Benutzer gestartet werden können. Von enaio 11.10 an werden folgende Properties in der Objektdefinitionssprache des anfragenden Benutzers zurückgeliefert: title und info.

Optionale Parameter sind:

clienttype (String): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").
objecttypes (boolean): Parameter "true" gibt erlaubte Objekttypen zurück und Parameter "false" zeigt erlaubte Objekttypen nicht an.

Rückgabe:

bei der Id handelt es sich um die Family Id,
die workflowId ist die Id des Modells,

Ergebnis

{
    id: "4A3D7DE0352B496F9C4CD8565479B1B3",
	workflowId: "CFA178A92DAB41CBA4E3969874E4DA0F",
    title: "Posteingang (Adhoc)",
    info: "Version 3.0",
	objectTypesAllowed: true,
    workflowParameters: [
        {
            readonly: false,
            type: "TEXT",
            id: "783241C856A04D17AEE520C9630CFDA1",
            name: "sAntragsteller",
            value: ""
        },
        ...,
},
...

/osrest/api/workflows/start

Unterstützte Anfragemethoden: POST/JSON

Diese Methode startet einen Workflow.

Eingabe: Ein Eintrag aus dem Ergebnis von (/osrest/api/workflows) evtl. mit angepassten Werten (value).

Optionale Parameter sind:

clienttype (String): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").

{
	"id": "16B30DD524614774A64C26346B7A3B01",
	"workflowParameters": [
		{ 
			"type": "TEXT", 
			"id": "55C31B02940B4FC98772C583DD627AC5", 
			"name": "sAusgangsparameter", 
			"value": "ausgang", 
			"readonly": false 
		},
		{ 
			"type": "LIST", 
			"id": "45319353B64E47F0B18CC4F0581B24BE", 
			"name": "sEingangsparameter", 
			"value": "Eingang", 
			"readonly": false 
		},
		{ 
			"type": "TEXT", 
			"id": "5ACF5B12D1BA4C8AA722F1718FA06BBF", 
			"name": "sFreigeben", 
			"value": "false", 
			"readonly": false 
		}
	],
	"files": [
		"4133"
	]
}

/osrest/api/workflows/startWithData

Unterstützte Anfragemethoden: POST/JSON

Diese Methode startet einen Workflow und legt dabei Dateien in die Workflowablage. Über einen Multipart POST Request (RFC 1867) wird der Workflow gestartet und Dateien in die Workflowablage hochgeladen werden. Diese müssen eine Content Disposition 'form-data' und das Attribut filename mit dem Dateinamen enthalten. Der Workflow wird (vgl. /osrest/api/workflow/start) im JSON-Format in eine Content Disposition 'data' als Text übergeben.

Optionale Parameter sind:

clienttype (String): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").

/osrest/api/workflows/running

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert eine Liste aller Arbeitsschritte, auf die der Benutzer Zugriff hat. Bei den Parametern handelt es sich um die Parameter, die zur Anzeige im Eingangskorb konfiguriert wurden. Von enaio 11.10 an werden manche Properties in der Objektdefinitionssprache des anfragenden Benutzers zurückgeliefert. Im verbose Modus sind dies die Properties activityName, processName, processSubject sowie die workflowParameter mit ihrem Namen und Wert und im nicht verbose mode der title und info übersetzt.

Optionale Parameter sind:

clienttype (String): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").
verbose (boolean): Es werden ausführlichere Daten zu den Arbeitsschritten zurückgeliefert.
reload (boolean): Cache ignorieren und WorkItem Daten neu holen

kurzes Ergebnis

[
    {
        id: "ABE6D05571CF40968F8447C1556D33CA",
		processID: "0B938F1389DD4877BD178DD1B83A2EBC",
		title: "Initialisierung - Aufgabe: Zur Kenntnis nehmen",
        info: "Kommentar: Diese Aufgabe muss noch ausgeführt werden."        
		creationTime: 1317038062000,
        personalized: "MEIER",
		substitute: false,
	    read: false
    }, 
	...
]

ausführliches Ergebnis (verbose)

[
    {
        id: "ABE6D05571CF40968F8447C1556D33CA",
		processID: "0B938F1389DD4877BD178DD1B83A2EBC",
		iconId: "1073743021",
		activityName: "Initialisierung",
		processName: "Standard-Ad-hoc-Workflow 27",
		processSubject: "Aufgabe: Zur Kenntnis nehmen",
		creationTime: 1465635668000,
		personalized: "MEIER",
		read: false,
		substitute: false,
		overTime: true,
		warningTime: 1465635668000,
		workflowParameters: [
			{
				type: "TEXT",
				name: "Kommentar",
				value: "Diese Aufgabe muss noch ausgeführt werden.",
				position: 0
			}
		],
		workflowId: "817B9AD47E2E44FFADFE30413E9AE4C3",
	    activityId: "35B71588DEE54343A9FBDF28EFF96B78"
    }, 
	...
]

/osrest/api/workflows/running/full/[id]

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Die Methode liefert alle XML-Datein zu einem WorkItem als JSON zurück. Diese sind: ExtendedAttributes, Parameters, Version, WorkflowType, File, Masks, ProcessResponsible.

Parameter:

id (string): ID des WorkItems

Optionale Parameter sind:

refresh (boolean): Cache ignorieren und WorkItem Daten neu holen
personalize (boolean): Das WorkItem wird beim Öffnen auch personalisier.
clienttype (string): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").

Beispiel Ergebnis

{
	"WorkItem": {
		"WorkItemName": "Kenntnisnahme",
    	"ExtendedAttributes": {
      		"ExtendedAttribute": [
        		{
          			"Value": "0",
          			"Name": "CHECK_PASSWORD"
        		},
				...
			]
    	},
    	"Parameters": {
      		"Parameter": [
				{
					"WFVar": {
						"Types": { },
						"IntegerSafe": "0"
		  			},
          			"DataField": "49623478004E4419BF976B182871D674",
          			"Selection": "",
          			"ListType": "",
          			"Mode": "3",
          			"FormField": "0F8D00DCF1F14649BE9E407632F415E7",
          			"InfoText": "",
          			"Name": "intNumber"
        		}, 
				...
      		]
    	},
    	"Version": "31",
    	"WorkflowType": "1",
		"ActivityId": "477EB9B8EC63432CAB387C62EBA1874C",
    	"WorkflowId": "0C0D89936E634F5C8565962BC1C2BE32",
   		"File": {
      		"Lists": {},
      		"Docs": {}
    	},
    	"Masks": {
      		"Mask": {
        		"MaskFields": {
          			"MaskField": [
						{
							"ToolTip": "Dies ist ein Pflichtfeld!|",
							"FieldTop": "100",
							"RegularExpression": {},
							"InpRight": "80",
							"InpBottom": "12",
							"Flags": "1",
							"InternalName": "",
							"FieldBottom": "12",
							"Name": "Pflichtfeld",
							"ValuesId": "",
							"TabOrder": "0",
							"Init": "",
							"FieldRight": "30",
							"FieldLeft": "45",
							"Flags1": "0",
							"InpLeft": "80",
							"DataType": "X",
							"InpLen": "50",
							"Flags2": "0",
							"Id": "833FD8E7FD614083A31DB9BBEB37A94D",
							"InpTop": "100"
			  			},
						...
					]
		  		}
        	},
        	"FrameWidth": "428",
        	"FrameHeight": "250",
        	"Id": "00F51E9EB65141BD92601F625E61E42C",
        	"Flags": "0",
        	"Name": "m"
      	}
    },
    "ProcessResponsible": "1"
  }
}

/osrest/api/workflows/running/[id]

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Die Methode liefert alle Paramter und Dateien zu einer Workflow-Aktivität.

Parameter:

id (string): ID der Workflow-Aktivität
personalize (boolean): das WorkItem soll beim Öffnen auch personalisiert werden
clienttype (string): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").
verbose (boolean): Reichert die Rückgabe um nähere Informationen zu den Aktenelementen an.

Ergebnis

{
    id: "ABE6D05571CF40968F8447C1556D33CA",
    workflowParameters: [
        {
            "readonly": false,
			"type": "CHECKBOX",
		    "id": "5ACF5B12D1BA4C8AA722F1718FA06BBF",
		    "name": "Eine Checkbox",
		    "value": "0",
		    "required": false
        },
        {
            "readonly": false,
            "type": "RADIO",
            "id": "0F665AAAA1C34569B6863C3F73498204",
            "name": "erledigt",
            "value": "3",
			listData: [
				"RadioButton1",
				"RadioButton2"
			],
		    "required": false
        },
		{
    		"readonly": false,
		    "type": "TEXT",
		    "id": "EFF64844A6A241169EE8AB19DC05886A",
		    "name": "RegExp Feld",
		    "value": "",
		    "regularExpression": "Value\\{(.*)\\}\\|Message\\{(.*)\\}",
		    "required": false
		},
		{
		    "readonly": true,
		    "type": "DATE",
		    "id": "88CA29EB04E54377AC8D3C788CE90906",
		    "name": "Datum Readonly",
		    "value": "",
		    "required": true
		}
    ],
    files: [
        "1452"
    ]
}

Ergebnis (verbose)

{
    id: "ABE6D05571CF40968F8447C1556D33CA",
    workflowParameters: [
        {
            "readonly": false,
			"type": "CHECKBOX",
		    "id": "5ACF5B12D1BA4C8AA722F1718FA06BBF",
		    "name": "Eine Checkbox",
		    "value": "0",
		    "required": false
        }, 
		...
    ],
    files: [
        "1452"
    ],
	verboseFiles: [
		{
			id: "1452",
			objectTypeId: "131081",
			location: "1",
			workspace: "1",
			deletable: true,
			useActiveVariant: false,
			movable: true,
			sig: "0",
			rights: "15",
			originalId: "1452",
			display: "1"
		}
	]
}

/osrest/api/workflows/running/processes

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert alle Prozesse zurück, bei denen der Anwender Prozessverantwortlicher ist oder die der Anwender gestartet hat. Die Prozesse sind vergleichbar mit denen, welche im enaio Client unter "Laufende Workflows" gelistet werden. Von enaio 11.10 an werden folgende Properties in der Objektdefinitionssprache des anfragenden Benutzers zurückgeliefert: activityName und processName, processSubject sowie die workflowParameter mit ihrem Namen und Wert.

Optionale Parameter sind:

refresh (boolean): Cache ignorieren und WorkItem Daten neu holen
clienttype (string): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").

/osrest/api/workflows/running/processes/{processId}/{activityId}

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert Informationen zu einer Aktivität eines Prozesses. Dazu gehören die Workflowdaten (workflow), Benutzer die den Workflow aktuell in ihrem Eingangskorb zur Bearbeitung haben (inboxUsers), Prozessverantwortliche (responsibleUsers), Workflowprotokoll (protocolEntries).

Parameter:

processId (string): Die Prozess Id des Prozesses
activityId (string): Die rAktivityId der Instanz des Prozesses

Optionale Parameter:

outputUsersOnly (boolean): Ist der Parameter true, so werden die "responsibleUsers" im selbem Format wie die "inboxUsers" zurückgegeben. Außerdem werden Gruppen aufgelöst und deren Benutzer zurückgeliefert. Die Benutzerliste ist dabei unique.

Ergebnis

{
	"objectId": 12345,
	"inboxUsers": [
		{
			"id": 7450,
			"name": "MARLON",
			"fullname": "",
			"description": "",
			"locked": "",
			"limited": "0",
			"valid": true,
			"groups": ["STANDARD"],
			"email": ""
		},
		...
	],
	"responsibleUsers": [{
			"telefon": "",
			"vorname": "",
			"stellvertreter": "",
			"name": "P4IN1",
			"e-mail": "",
			"nachname": "",
			"typ": "PERSON",
			"id": "AAA55F6209E54F0F8F503B60F0927C2B",
			"login": "P4IN1",
			"userid": "00239BAF6A184B5F96DEDB1AD88E1998"
		},
		{
			"groupid": "",
			"stellvertreter": "",
			"name": "Adhoc",
			"typ": "ROLE",
			"id": "727A6EA824B543668A4CF56B3EDD98A9"
		},
		...
	],
	"protocolEntries": [
		{
			"activityId": "00000000000000000000000000000000",
			"activityName": "StartActivity",
			"creationTime": 1472220199000,
			"endTime": 1472220200000,
			"processState": "16384"
		},
		{
			"activityId": "45DE932B26B94EB3A21BDC00AB9AB9DC",
			"activityName": "Erster Arbeitsschritt",
			"creationTime": 1472220200000,
			"accessTime": 1472220208000,
			"processState": "128"
		},
		...
	]
}

/osrest/api/workflows/running/performers

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Erforderliche Parameter:

workitemId (string): die rActivityId des WorkItems

Diese Methode liefert alle Benutzer und Rollen zurück, die als Teilnehmer des angegebenen Vorgangsschritts zugeordnet sind oder diesen als Stellvertreter sehen.

Beispiel Ergebnis

[
    {
        "id": "1F93E705A4FB46C3B237CC582FD9BFE1",
		"typ": "Person"
    }, {
        "id": "727A6EA824B543668A4CF56B3EDD98A9",
		"typ": "Rolle"
    },
    ...
]

/osrest/api/workflows/personalize

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON

Diese Methode personalisiert für den angemeldeten Nutzer die WorkItems. Dazu ist jeweils die ID des WorkItems anzugeben. Sollte ein Fehler beim Personalisieren eintreten, gibt die Methode eine Liste mit den WorkItems zurück, die nicht personalisiert werden konnten.

Erforderliche Parameter:

id (string): ID des WorkItem
prcessID (string): Prozess ID des Workitem

Optionale Parameter:

clienttype (string): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").

POST Beispiel

[
    {
        "id": "1F93E705A4FB46C3B237CC582FD9BFE1",
	 	"processID": "48CCDFFFED354803A7E2F1C12570A11E"
    },
    ...
]

/osrest/api/workflows/depersonalize

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON

Die Methode hebt für den angemeldeten Nutzer die Personalisierung der angegebenen WorkItems auf. Dazu ist jeweils die Id des WorkItems anzugeben. Sollte ein Fehler beim Aufheben der Personalisierung eintreten, gibt die Methode eine Liste mit den WorkItems zurück, deren Personalisierung nicht aufgehoben werden konnte.

Erforderliche Parameter:

id (string): Die rActivityId des WorkItem
prcessID (string): Die Prozess ID des Workitem

Optionale Parameter:

clienttype (string): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").

POST Beispiel

[
    {
        "id": "1F93E705A4FB46C3B237CC582FD9BFE1",
		"processID": "48CCDFFFED354803A7E2F1C12570A11E"
    },
    ...
]

/osrest/api/workflows/read

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: HTTP/204 (No Content)

Die Methode setzt für den angemeldeten Nutzer die angegebenen WorkItems auf gelesen. Dazu ist jeweils die ID des WorkItems anzugeben.

Erforderliche JSON Parameter:

id (string): Die rActivityId des WorkItem
prcessID (string): Die Prozess Id des Workitem

POST Beispiel

[
    {
        "id": "1F93E705A4FB46C3B237CC582FD9BFE1"
    },
    ...
]

/osrest/api/workflows/unread

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: HTTP/204 (No Content)

Die Methode setzt für den angemeldeten Nutzer die angegebenen WorkItems auf ungelesen. Dazu ist jeweils die Id des WorkItems anzugeben.

Erforderliche JSON Parameter:

id (string): Die rActivityId des WorkItems

POST Beispiel

[
    {
        "id": "1F93E705A4FB46C3B237CC582FD9BFE1"
    },
    ...
]

/osrest/api/workflows/assignperformers

Unterstützte Anfragemethoden: POST/JSON
Unterstützte Ergebnisformate: HTTP/204 (No Content)

Diese Methode weist Vorgangsschritten neue Teilnehmer zu.

POST Beispiel

[
    {
        "id": "1F93E705A4FB46C3B237CC582FD9BFE1",
		"performers": [{
			"id": "783618F8E4294BCA8B384909CEA32FD8"
		}, ...]
    },
    ...
]

/osrest/api/workflows/forward

Unterstützte Anfragemethoden: POST/JSON

Optionale Parameter:

clienttype (string): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").

Diese Methode leitet eine Workflow-Aktivität weiter. Hierbei muss das Ergebnis-JSON von /osrest/api/workflows/running/[id] (ggf. mit angepassten Parameterwerten) übergeben werden. In dem nachfolgenden Beispiel findet sich ein ab enaio 11.10 neuer mehrsprachiger geskripteter (dynamischer) Katalog (vMListScript). Für diesen Katalog sind im Workflowmodell keine Auswahlwerte definiert. Die Auswahlwerte der Liste werden über ein Client-Skript in allen definierten Sprachen bereitgestellt.

Damit ein solches Feld ebenfalls im Eingangskorb und in der Liste der laufenden Prozesse in allen Sprachen richtig dargestellt wird, müssen hierfür in der JSON Property "resources" Anzeigewerte für alle aktiven Objektdefinitionssprachen übermittelt werden. Die Guid für jede Gruppe an Sprachressourcen unterhalb der "resources" Property entspricht der "id" des Workflow-Parameters.

POST Beispiel

{
	id: "A568441085B74CBDB088C7B43838AAEA",
	workflowParameters: [{
		"type": "TEXT",
		"id": "2A1B85B652A5423BAE78CA0C2FBDAA6D",
		"name": "Pflichtfeld",
		"value": "geänderter Text"
	}, {
		"name": "vMListScript",
		"id": "EF873EECABCA463083BD0E4354591B61",
		"value": "Value Neutral",
		"type": "LIST"
	}, ...
	],
	files: ["1452"],
	(optional) routingList: {
		"id": "3294B433BFF6454D9C861B86B5A8AD5D",
		"processId": "BA16C21BB96D46D099E72070BCB644CC",
		"activityId": "3294B433BFF6454D9C861B86B5A8AD5D",
		"expandable": true,
		"entries": [
			{
				"nr": "203",
				"expandable": true,
				"items": [
					{
						"id": "99825B18A8334987935684FDA3D6A40D",
						"activityId": "6EE4490A48164A0FA6DC34A80099AF66",
						"activityName": "Rechnung erstellen",
						"modelActivityName": "Rechnung erstellen",
						"remark": "",
						"timerId": "",
						"timerDuration": "",
						"timerDurationType": "",
						"changeable": true,
						"deleteable": false,
						"objectIds": "12531E57D10A447D9480EBB2A94A6813,783618F8E4294BCA8B384909CEA32FD8,5B18392F1ABC4DF5983DEA1338ACCB67"
					},
					...
				]
			},
			...
		]
	},
 	(optional) verboseFiles: [
		{
			id: "1452",
			workspace: 0
		}
	],
	(optional) resources: {
	 	"EF873EECABCA463083BD0E4354591B61": {
			"de_DE": "Value - DE",
			"en_US": "Value - EN",
			"fr_FR": "Value - FR"
		}
	}
}

Änderungen an der Workflowakte vornehmen

ein DMS-Objekt der Akte hinzufügen

POST Beispiel, Neues Aktenelement hinzufügen

 {
	id: "A568441085B74CBDB088C7B43838AAEA",
	workflowParameters: [],
	files: [],
	verboseFiles: [
		{
			id: "1527",
			objektTypeId: "262144",
			location: "1",		(1 - DMS-Objekt existiert im Dateisystem, 2 - DMS-Objekt existiert nur in der Systemablage)
			workspace: "0",		(0 - Infobereich der Akte, 1 - Arbeitsbereich der Akte)
 
			(optional)
			deletable: false,
			useActiveVariant: false,
			moveable: false
		}
	]
}

ein Aktenelement bearbeiten

POST Beispiel, Aktenelement bearbeiten

 {
	id: "A568441085B74CBDB088C7B43838AAEA",
	workflowParameters: [],
	files: ["1527"],
	verboseFiles: [
		{
			id: "1527",
			
			(benötigt wird jeweils nur die Property, die geändert wurde)
			workspace: "0",		(0 - Infobereich der Akte, 1 - Arbeitsbereich der Akte)
			deletable: false,
			useActiveVariant: false,
			moveable: false
		}
	]
}

ein DMS-Objekt aus der Akte löschen

Um ein DMS-Objekt aus der Akte zu löschen, muss die ID des betreffenden Objektes aus der "files"-Property entfernt werden.

/osrest/api/workflows/cancel

Unterstützte Anfragemethoden: POST/JSON

Optionale Parameter:

save: true|false. Bei true werden die mitgesendeten Daten gespeichert.
clienttype (string): Wenn save:true, dann angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr")

Über diese Methode kann eine Workflow-Aktivität mit neuen Werten gespeichert und nicht weitergeleitet werden. Hierbei muss das Ergebnis-JSON von /osrest/api/workflows/running/[id] (ggf. mit angepassten Parameterwerten) übergeben werden (siehe forward-Aufruf).

/osrest/api/workflows/processes/[Id]

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert alle laufenden Workflowprozesse eines Objekts. Von enaio 11.10 an werden folgende Properties in der Objektdefinitionssprache des anfragenden Benutzers zurückgeliefert: activityName und processName.

Parameter:

id (int): OSID des Objekts

Ergebnis

[
  {
    "id": "D44ACCBDCD14481ABA425E383501CD83",
    "name": "Test Mobil 0.8 188",
    "subject": "Testworkflow für OS|mobileDMS",
    "state": "RUNNING",
    "creatorId": "217F716436F04D85AFCDE61F7192DD7D",
    "creationTime": 1392730091000,
    "processResponsible": false,
    "activities": []
  },
  {
    "id": "CF51FCD484F246A6A02898F1522FC3E3",
    "name": "Test Mobil 0.8 185",
    "subject": "Testworkflow für OS|mobileDMS",
    "state": "COMPLETED",
    "creatorId": "217F716436F04D85AFCDE61F7192DD7D",
    "creationTime": 1392281546000,
    "processResponsible": false,
    "activities": [
      "Aktivität Client",
      "Aktivität mobileDMS",
      "Aktivität mobileDMS 2"
    ]
  }
]

/osrest/api/workflows/abort

Unterstützte Anfragemethoden: POST/JSON

Diese Methode bricht einen oder mehrere Workflowprozesse ab.

Eingabe: Entweder die Prozess-ID der Workflowinstanz oder eine OSID eines Aktendokumentes. Bei letzteren werden alle Workflowinstanzen abgebrochen, die dieses Aktendokument beinhalten. Es kann also sein, dass mehr als eine Workflowinstanz abgebrochen wird! Zuerst wird die processID ausgewertet. Ist sie vorhanden, wird die osID ignoriert. Ist keine processID vorhanden, wird die osID ausgewertet.

{
    "processID":"07D8A5CC07D94BDC9604EA6377085891",
    "osID":"1532"
}

/osrest/api/workflows/absence/[true|false]

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode meldet den aktuellen Benutzer an der Workflowteilnahme an/ab.

Eingabe: Wird als letztes Pfadelement true übergeben, wird der aktuelle Benutzer von der Workflowteilnahme abgemeldet und erhält fortan keine Workflows über den Notifications-Aufruf. Umgekehrt kann er über false als letztes Pfadelement an der Teilnahme wieder angemeldet werden. Als Rückgabewert erhält man z.B. folgendes JSON-Ergebnis für das Pfadelement true. Im Ergebnisschlüssel wfAbsence wird der aktuelle Status zurückgegeben.

{
  "null": {
    "id": "AA772557EC874AF48B229B8D4832D61B",
    "wfAbsence": "true"
  }
}

/osrest/api/workflows/substitutes

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: HTTP/204 (No Content)

Diese Methode liefert die Stellvertreter Benutzer des angemeldeten Benutzers.

[
	{
		"id": "178B4625545E4684BDA4652698781598",
		"userGuid": "54AD00BAB3804112B9AC99976138DF0A",
		"userName": "RENE",
		"name": "RENE",
		"absent": false
	},
	...
]

/osrest/api/workflows/substitutes

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON

Diese Methode setzt neue Stellvertreter Benutzer für den angemeldeten Benutzer.

POST Beispiel

[
    {
        "id": "1F93E705A4FB46C3B237CC582FD9BFE1"
    },
    ...
]

/osrest/api/workflows/organisation

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert die komplette, aktive Workfloworganisation zurück. Jedes Organisationsobjekt wird mitsamt seinen benutzerdefinierten Attributen zurückgegeben und mit einem Verweis auf seine Kindelemente.

Beispielrückgabe

{
	"Wurzel": [{
			name: "Wurzel",
			id: "914FC91A55D542F79D8ED1BADDE1AFE6",
			benutzerdefiniert: "origin",
			children: [{
				id: "0B3221875B8D4708AF1CB4C269DF7C9F",
				typ: "Land"
			}, {
				id: "727A6EA824B543668A4CF56B3EDD98A9",
				typ: "Rolle"
			}]
		}],
	"Land": [ ... ],
	"Organisation": [ ... ],
	"Abteilung": [ ... ],
	"BenutzerdefinierterTyp": [ ... ],
  	"Rolle": [{
			id: "92B25680D035458EA6C08B1E703418D0",
			name: "Adhoc",
			children: [{
					id: "F6C5181094814EFBAF4FF998D90A6D68",
					typ: "Person" }]
		}],
	"Person": [{
			id: "F6C5181094814EFBAF4FF998D90A6D68",
			name: "Root",
			telefon: "95378201",
			... }],
}

/osrest/api/workflows/organisationObjects

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert alle Benutzer und Rollen der aktiven Organisation zurück.

/osrest/api/workflows/organisationObjects

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON

Diese Methode liefert zu übergebenen Ids alle Benutzer und Rollen der aktiven Organisation zurück.

{
  "organisationObjects": [
	{ "id": "AA772557EC874AF48B229B8D4832D61B" }, ...
  ]
}

/osrest/api/workflows/clientScripts/[workflowId]/[activityId]

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert all Client Skripte und das globale Client Skript zu einer bestimmten Aktivität eines Workflow Modells zurück.

Pflicht Parameter:

workflowId (String): die ID des Workflow Modells (aufgepasst, die ID des Modells ist nicht die ID des Vorgangsschritts!)
activityId (String): die ID der Aktivität

Optionale Parameter:

clienttype (String): Angeben, für welchen Client-Typ die Workflowmaske zum Speichern intern geladen wird ("web", "mobile", "desktop" bzw. für Masken in einer bestimmten Sprache z.B. "web_de", "web_en" oder "web_fr").
scriptlanguage (String): Liefert nur Skripte in der angegebenen Skriptsprache zurück. Möglich sind: "javascript", "vb-script".

/osrest/api/workflows/adhoc/info

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert alle notwendigen Informationen zu einer spezifischen AdHoc Aktivitäten zurück.

Pflicht Parameter:

processId (String): die ID eines Workflow Prozesses
activityId (String): die ID der AdHoc Aktivität

Beispiel Ergebnis

{
  "defaultActivityId": "EBA50D7D32C640F5B0358C383F495F9B",
  "activities": [
    {
      "id": "E6EABEEFBFE448BABB36B80C7F6050FC",
      "type": "MULTIINSTANCE",
      "name": "Multi-instance activity",
      "deletable": false,
      "editable": false,
      "performers": []
    },
    {
      "id": "EBA50D7D32C640F5B0358C383F495F9B",
      "type": "WORKITEM",
      "name": "Activity",
      "deletable": false,
      "editable": true,
      "performers": [
        {
          "stellvertreter": "917B282B6CDC470DBCAB532BBC52ECBD",
          "name": "HANS",
          "typ": "PERSON",
          "id": "BE2C9475A0E84700BBD45C7C8B2AECF5",
          "login": "HANS",
          "userid": "B01F6B1429BD4E2B894A065E5C7888F1",
				...
        },
        {
          "groupid": "",
          "stellvertreter": "",
          "name": "Adhoc",
          "typ": "ROLE",
          "id": "727A6EA824B543668A4CF56B3EDD98A9"
        }
      ]
    },
    {
      "id": "7C506F8FF16C487E81DEAFCD5625F04E",
      "type": "ROUTE",
      "name": "Route",
      "deletable": false,
      "editable": false,
      "performers": []
    }
  ],
  "periods": [
    {
      "id": "B7EDA55978AB485B84B7537910B13672",
      "name": "Mahnfrist",
      "duration": 345600
    }
  ]
}

/osrest/api/workflows/adhoc/templates

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert alle Lauflistenvorlagen zurück.

/osrest/api/workflows/adhoc/templates/save

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON

Über diese Methode kann eine neue Lauflistenvorlage angelegt werden.

{
    "templateId": "",
    "templateName": "Neue Vorlage",
    "templatePublic": true,
    "routingList": {
        "id": "931E96E300AA4F5086EFC46602013274",
        "activityId": "931E96E300AA4F5086EFC46602013274",
        "processId": "CDF769EF60FB47139D52C442D264A91D",
        "expandable": true,
        "entries": [{
            "nr": 0,
            "expandable": true,
            "items": [{
                "id": "76EE2219A6144EFF993B25D88D55EEE2",
                "changeable": true,
                "deleteable": false,
                "activityName": "DisplayName",
                "objectIds": [""],
                "remark": "",
                "activityId": "EBA50D7D32C640F5B0358C383F495F9B",
                "modelActivityName": "DisplayName",
                "timerId": "",
                "timerDuration": 0,
                "timerDurationType": 0
            },
            {
                "id": "C9BBEFEAD8654E19984CDA8FC7C8B831",
                "changeable": true,
                "deleteable": false,
                "activityName": "DisplayName",
                "objectIds": [""],
                "remark": "",
                "activityId": "EBA50D7D32C640F5B0358C383F495F9B",
                "modelActivityName": "DisplayName",
                "timerId": "",
                "timerDuration": 0,
                "timerDurationType": 0
            }]
        },
        {
            "nr": 1,
            "expandable": true,
            "items": [{
                "id": "C97177555C2540E68285FFCD22E25046",
                "changeable": true,
                "deleteable": false,
                "activityName": "DisplayName",
                "objectIds": [""],
                "remark": "",
                "activityId": "EBA50D7D32C640F5B0358C383F495F9B",
                "modelActivityName": "DisplayName",
                "timerId": "",
                "timerDuration": 0,
                "timerDurationType": 0
            },
            {
                "id": "AFAC689EC5DB4B41B93935ACEBA46780",
                "changeable": true,
                "deleteable": false,
                "activityName": "DisplayName",
                "objectIds": [""],
                "remark": "",
                "activityId": "EBA50D7D32C640F5B0358C383F495F9B",
                "modelActivityName": "DisplayName",
                "timerId": "",
                "timerDuration": 0,
                "timerDurationType": 0
            }]
        }]
    }
}

/osrest/api/workflows/adhoc/templates/delete/{id}

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Über diese Methode kann eine Lauflistenvorlage gelöscht werden.

Pflicht Parameter:

id (String): Die Guid der Lauflistenvorlage.

/osrest/api/workflows/adhoc/templates/move/{id}?publish=(true|false)

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Über diese Methode kann eine Lauflistenvorlage veröffentlicht oder privatisiert werden.

Pflicht Parameter:

id (String): Die Guid der Lauflistenvorlage.
publish (boolean): True, wenn die Lauflistenvorlage veröffentlicht, false wenn sie privatisiert werden soll.

Inhalt:

1 /osrest/api/workflows
2 /osrest/api/workflows/start
3 /osrest/api/workflows/startWithData
4 /osrest/api/workflows/running
5 /osrest/api/workflows/running/full/[id]
6 /osrest/api/workflows/running/[id]
7 /osrest/api/workflows/running/processes
8 /osrest/api/workflows/running/processes/{processId}/{activityId}
9 /osrest/api/workflows/running/performers
10 /osrest/api/workflows/personalize
11 /osrest/api/workflows/depersonalize
12 /osrest/api/workflows/read
13 /osrest/api/workflows/unread
14 /osrest/api/workflows/assignperformers
15 /osrest/api/workflows/forward
- 15.1 Änderungen an der Workflowakte vornehmen
16 /osrest/api/workflows/cancel
17 /osrest/api/workflows/processes/[Id]
18 /osrest/api/workflows/abort
19 /osrest/api/workflows/absence/[true|false]
20 /osrest/api/workflows/substitutes
21 /osrest/api/workflows/substitutes
22 /osrest/api/workflows/organisation
23 /osrest/api/workflows/organisationObjects
24 /osrest/api/workflows/organisationObjects
25 /osrest/api/workflows/clientScripts/[workflowId]/[activityId]
26 /osrest/api/workflows/adhoc/info
27 /osrest/api/workflows/adhoc/templates
28 /osrest/api/workflows/adhoc/templates/save
29 /osrest/api/workflows/adhoc/templates/delete/{id}
30 /osrest/api/workflows/adhoc/templates/move/{id}?publish=(true|false)

WorkflowService (/workflows)

/osrest/api/workflows

/osrest/api/workflows/start

/osrest/api/workflows/startWithData

/osrest/api/workflows/running

/osrest/api/workflows/running/full/[id]

/osrest/api/workflows/running/[id]

/osrest/api/workflows/running/processes

/osrest/api/workflows/running/processes/{processId}/{activityId}

/osrest/api/workflows/running/performers

/osrest/api/workflows/personalize

/osrest/api/workflows/depersonalize

/osrest/api/workflows/read

/osrest/api/workflows/unread

/osrest/api/workflows/assignperformers

/osrest/api/workflows/forward

Änderungen an der Workflowakte vornehmen

/osrest/api/workflows/cancel

/osrest/api/workflows/processes/[Id]

/osrest/api/workflows/abort

/osrest/api/workflows/absence/[true|false]

/osrest/api/workflows/substitutes

/osrest/api/workflows/substitutes

/osrest/api/workflows/organisation

/osrest/api/workflows/organisationObjects

/osrest/api/workflows/organisationObjects

/osrest/api/workflows/clientScripts/[workflowId]/[activityId]

/osrest/api/workflows/adhoc/info

/osrest/api/workflows/adhoc/templates

/osrest/api/workflows/adhoc/templates/save

/osrest/api/workflows/adhoc/templates/delete/{id}

/osrest/api/workflows/adhoc/templates/move/{id}?publish=(true|false)