DigiOffice API Services Services

<back to all web services

FinishTaskOperation

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

public class FinishTaskOperation : Codable
{
    public var taskIDs:[Int]
    public var wsVerbindingID:String?
    public var transitions:[WorkflowTransitionDTO]
    public var deferTo:Date?
    public var reason:String
    public var comment:String

    required public init(){}
}

public class WorkflowTransitionDTO : Codable
{
    public var id:String
    public var name:String
    public var assignmentAtStartWorkflowIsAdHoc:Bool
    public var assignmentIsAdHocRequired:Bool
    public var deferAtStartWorkflowIsAdHoc:Bool
    public var isNext:Bool
    public var userIDs:[Int]
    public var groupIDs:[Int]
    public var roleIDs:[Int]
    public var deferUntil:Date?
    public var deferralNote:String

    required public init(){}
}


Swift 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>