DigiOffice Gateway Web Services

GetWorkflowTask

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetWorkflowTask : IHasVersion
{
    var ID:Int? = null
    var Version:Int? = null
}

@DataContract
open class WorkflowTask
{
    @DataMember
    var ID:Int? = null

    @DataMember
    var DocumentID:UUID? = null

    @DataMember
    var Title:String? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var ContextTitle:String? = null

    @DataMember
    var Project:String? = null

    @DataMember
    var Relation:String? = null

    @DataMember
    var ImageKey:String? = null

    @DataMember
    var Urgent:Boolean? = null

    @DataMember
    var IsRead:Boolean? = null

    @DataMember
    var AssignmentDate:Date? = null

    @DataMember
    var CompletionDate:Date? = null

    @DataMember
    var NumberOfComments:Int? = null

    @DataMember
    var ExtraField:String? = null

    @DataMember
    var HasPreview:Boolean? = null

    @DataMember
    var Extension:String? = null

    @DataMember
    var IsInformative:Boolean? = null

    @DataMember
    var HasPendingSideSteps:Boolean? = null

    @DataMember
    var Actions:ArrayList<WorkflowTaskAction> = ArrayList<WorkflowTaskAction>()

    @DataMember
    var CanAccept:Boolean? = null
}

open class WorkflowTaskAction
{
    var ID:Int? = null
    var Title:String? = null
    var Type:String? = null
    var UseDialog:Boolean? = null
    var ConnectionID:UUID? = null
}

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