DigiOffice API Services Services

<back to all web services

FinishTaskOperation

Requires Authentication
The following routes are available for this service:
POST/api/workflowtasks/finish
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 WorkflowTransitionDTO() = 
        member val ID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val AssignmentAtStartWorkflowIsAdHoc:Boolean = new Boolean() with get,set
        member val AssignmentIsAdHocRequired:Boolean = new Boolean() with get,set
        member val DeferAtStartWorkflowIsAdHoc:Boolean = new Boolean() with get,set
        member val IsNext:Boolean = new Boolean() with get,set
        member val UserIDs:ResizeArray<Int32> = null with get,set
        member val GroupIDs:ResizeArray<Int32> = null with get,set
        member val RoleIDs:ResizeArray<Int32> = null with get,set
        member val DeferUntil:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeferralNote:String = null with get,set

    [<AllowNullLiteral>]
    type FinishTaskOperation() = 
        member val TaskIDs:Int32[] = null with get,set
        member val WSVerbindingID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Transitions:IEnumerable<WorkflowTransitionDTO> = null with get,set
        member val DeferTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Reason:String = null with get,set
        member val Comment:String = null with get,set

F# FinishTaskOperation DTOs

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

HTTP + XML

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

POST /api/workflowtasks/finish HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinishTaskOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <Comment>String</Comment>
  <DeferTo>0001-01-01T00:00:00</DeferTo>
  <Reason>String</Reason>
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
  <Transitions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs" i:nil="true" />
  <WSVerbindingID>00000000-0000-0000-0000-000000000000</WSVerbindingID>
</FinishTaskOperation>