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
namespace IDB.Workflow.API.DTOs

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkflowTaskActionDTO() = 
        member val BeginGroup:Boolean = new Boolean() with get,set
        member val DigiOfficeIcon:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val FontAwesomeIcon:String = null with get,set
        member val Hint:String = null with get,set
        member val Name:String = null with get,set
        member val ShowTextForRootItems:Boolean = new Boolean() with get,set
        member val Text:String = null with get,set
        member val Url:String = null with get,set
        member val Items:ResizeArray<WorkflowTaskActionDTO> = null with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskDTO() = 
        member val ID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val WorkflowID:Int32 = new Int32() with get,set
        member val WorkflowDescription:String = null with get,set
        member val RootWorkflowID:Int32 = new Int32() with get,set
        member val TransitionID:Guid = new Guid() with get,set
        member val TransitionName:String = null with get,set
        member val ActivationID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val TypeID:Int32 = new Int32() with get,set
        member val TypeDescription:String = null with get,set
        member val StatusID:Int32 = new Int32() with get,set
        member val StatusDescription:String = null with get,set
        member val UserID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val OfferedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AssignedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExpirationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val Progress:Nullable<Single> = new Nullable<Single>() with get,set
        member val FinishedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val FinishedByUserID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FinishedDocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Read:Boolean = new Boolean() with get,set
        member val DeferDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeferReason:String = null with get,set
        member val Reason:String = null with get,set
        member val Urgent:Boolean = new Boolean() with get,set
        member val Status:String = null with get,set
        member val AvailableActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val FinishActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val CommentActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val DocumentActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val NumberOfComments:Int32 = new Int32() with get,set
        member val RelativeDetailLink:String = null with get,set
        member val FirstSideStepID:Int32 = new Int32() with get,set
        member val FirstSideStepOmschr:String = null with get,set
        member val FirstSideStepDetailLink:String = null with get,set
        member val IsSideStepOfWorkflowID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsSideStepOfWorkflowOmschr:String = null with get,set
        member val IsSideStepOfWorkflowDetailLink:String = null with get,set
        member val IsSideStepOfTaskID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsSideStepOfTaskOmschr:String = null with get,set
        member val IsSideStepOfTaskDetailLink:String = null with get,set
        member val IsObservedID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsObservedOmschr:String = null with get,set
        member val IsObservedDetailLink:String = null with get,set

    [<AllowNullLiteral>]
    type WorkflowMultiTaskDTO() = 
        member val MultiTask:WorkflowTaskDTO = null with get,set
        member val TaskIDs:ResizeArray<Int32> = null with get,set

    ///<summary>
    ///Get a multitask.
    ///</summary>
    [<Api(Description="Get a multitask.")>]
    [<AllowNullLiteral>]
    type GetMultiTaskOperation() = 
        ///<summary>
        ///ID of the workflow task(s) to return
        ///</summary>
        [<ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)>]
        member val TaskIDs:Int32[] = null with get,set

F# 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
	]
}