DigiOffice API Services Services

<back to all web services

GetMultiTaskOperation

Get a multitask.

Requires Authentication
The following routes are available for this service:
POST/api/workflowmultitasks
import Foundation
import ServiceStack

/**
* Get a multitask.
*/
// @Api(Description="Get a multitask.")
public class GetMultiTaskOperation : Codable
{
    /**
    * ID of the workflow task(s) to return
    */
    // @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    public var taskIDs:[Int] = []

    required public init(){}
}

public class WorkflowMultiTaskDTO : Codable
{
    public var multiTask:WorkflowTaskDTO
    public var taskIDs:[Int]

    required public init(){}
}

public class WorkflowTaskDTO : Codable
{
    public var id:Int
    public var name:String
    public var workflowID:Int
    public var workflowDescription:String
    public var rootWorkflowID:Int
    public var transitionID:String
    public var transitionName:String
    public var activationID:String?
    public var typeID:Int
    public var typeDescription:String
    public var statusID:Int
    public var statusDescription:String
    public var userID:Int?
    public var active:Bool
    public var offeredDate:Date?
    public var assignedDate:Date?
    public var startDate:Date?
    public var expirationDate:Date?
    public var order:Int
    public var progress:Float?
    public var finishedDate:Date?
    public var finishedByUserID:Int?
    public var finishedDocumentID:String?
    public var read:Bool
    public var deferDate:Date?
    public var deferReason:String
    public var reason:String
    public var urgent:Bool
    public var status:String
    public var availableActions:[WorkflowTaskActionDTO]
    public var finishActions:[WorkflowTaskActionDTO]
    public var commentActions:[WorkflowTaskActionDTO]
    public var documentActions:[WorkflowTaskActionDTO]
    public var numberOfComments:Int
    public var relativeDetailLink:String
    public var firstSideStepID:Int
    public var firstSideStepOmschr:String
    public var firstSideStepDetailLink:String
    public var isSideStepOfWorkflowID:Int?
    public var isSideStepOfWorkflowOmschr:String
    public var isSideStepOfWorkflowDetailLink:String
    public var isSideStepOfTaskID:Int?
    public var isSideStepOfTaskOmschr:String
    public var isSideStepOfTaskDetailLink:String
    public var isObservedID:Int?
    public var isObservedOmschr:String
    public var isObservedDetailLink:String

    required public init(){}
}

public class WorkflowTaskActionDTO : Codable
{
    public var beginGroup:Bool
    public var digiOfficeIcon:String
    public var enabled:Bool
    public var fontAwesomeIcon:String
    public var hint:String
    public var name:String
    public var showTextForRootItems:Bool
    public var text:String
    public var url:String
    public var items:[WorkflowTaskActionDTO]

    required public init(){}
}


Swift GetMultiTaskOperation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/workflowmultitasks HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TaskIDs: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MultiTask: 
	{
		ID: 0,
		Name: String,
		WorkflowID: 0,
		WorkflowDescription: String,
		RootWorkflowID: 0,
		TransitionName: String,
		ActivationID: 00000000-0000-0000-0000-000000000000,
		TypeID: 0,
		TypeDescription: String,
		StatusID: 0,
		StatusDescription: String,
		UserID: 0,
		Active: False,
		OfferedDate: 0001-01-01,
		AssignedDate: 0001-01-01,
		StartDate: 0001-01-01,
		ExpirationDate: 0001-01-01,
		Order: 0,
		Progress: 0,
		FinishedDate: 0001-01-01,
		FinishedByUserID: 0,
		FinishedDocumentID: 00000000-0000-0000-0000-000000000000,
		Read: False,
		DeferDate: 0001-01-01,
		DeferReason: String,
		Reason: String,
		Urgent: False,
		Status: String,
		NumberOfComments: 0,
		RelativeDetailLink: String,
		FirstSideStepID: 0,
		FirstSideStepOmschr: String,
		FirstSideStepDetailLink: String,
		IsSideStepOfWorkflowID: 0,
		IsSideStepOfWorkflowOmschr: String,
		IsSideStepOfWorkflowDetailLink: String,
		IsSideStepOfTaskID: 0,
		IsSideStepOfTaskOmschr: String,
		IsSideStepOfTaskDetailLink: String,
		IsObservedID: 0,
		IsObservedOmschr: String,
		IsObservedDetailLink: String
	},
	TaskIDs: 
	[
		0
	]
}