DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication 
import Foundation
import ServiceStack

public class GetWorkflowTask : IHasVersion, Codable
{
    public var id:Int?
    public var version:Int?

    required public init(){}
}

// @DataContract
public class WorkflowTask : Codable
{
    // @DataMember
    public var id:Int?

    // @DataMember
    public var documentID:String?

    // @DataMember
    public var title:String?

    // @DataMember
    public var Description:String?

    // @DataMember
    public var contextTitle:String?

    // @DataMember
    public var project:String?

    // @DataMember
    public var relation:String?

    // @DataMember
    public var imageKey:String?

    // @DataMember
    public var urgent:Bool?

    // @DataMember
    public var isRead:Bool?

    // @DataMember
    public var assignmentDate:Date?

    // @DataMember
    public var completionDate:Date?

    // @DataMember
    public var numberOfComments:Int?

    // @DataMember
    public var extraField:String?

    // @DataMember
    public var hasPreview:Bool?

    // @DataMember
    public var `extension`:String?

    // @DataMember
    public var isInformative:Bool?

    // @DataMember
    public var hasPendingSideSteps:Bool?

    // @DataMember
    public var actions:[WorkflowTaskAction] = []

    // @DataMember
    public var canAccept:Bool?

    required public init(){}
}

public class WorkflowTaskAction : Codable
{
    public var id:Int?
    public var title:String?
    public var type:String?
    public var useDialog:Bool?
    public var connectionID:String?

    required public init(){}
}

Swift GetWorkflowTask 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 /xml/reply/GetWorkflowTask HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetWorkflowTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow.Operations">
  <ID>0</ID>
  <Version>0</Version>
</GetWorkflowTask>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
  <Actions>
    <WorkflowTaskAction>
      <ConnectionID>00000000-0000-0000-0000-000000000000</ConnectionID>
      <ID>0</ID>
      <Title>String</Title>
      <Type>String</Type>
      <UseDialog>false</UseDialog>
    </WorkflowTaskAction>
  </Actions>
  <AssignmentDate>0001-01-01T00:00:00</AssignmentDate>
  <CanAccept>false</CanAccept>
  <CompletionDate>0001-01-01T00:00:00</CompletionDate>
  <ContextTitle>String</ContextTitle>
  <Description>String</Description>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <Extension>String</Extension>
  <ExtraField>String</ExtraField>
  <HasPendingSideSteps>false</HasPendingSideSteps>
  <HasPreview>false</HasPreview>
  <ID>0</ID>
  <ImageKey>String</ImageKey>
  <IsInformative>false</IsInformative>
  <IsRead>false</IsRead>
  <NumberOfComments>0</NumberOfComments>
  <Project>String</Project>
  <Relation>String</Relation>
  <Title>String</Title>
  <Urgent>false</Urgent>
</WorkflowTask>