DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication
GetWorkflowTask Parameters:
NameParameterData TypeRequiredDescription
IDqueryintNo
VersionqueryintNo
WorkflowTask Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
DocumentIDformGuidNo
TitleformstringNo
DescriptionformstringNo
ContextTitleformstringNo
ProjectformstringNo
RelationformstringNo
ImageKeyformstringNo
UrgentformboolNo
IsReadformboolNo
AssignmentDateformDateTime?No
CompletionDateformDateTime?No
NumberOfCommentsformintNo
ExtraFieldformstringNo
HasPreviewformboolNo
ExtensionformstringNo
IsInformativeformboolNo
HasPendingSideStepsformboolNo
ActionsformList<WorkflowTaskAction>No
CanAcceptformboolNo
WorkflowTaskAction Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TitleformstringNo
TypeformstringNo
UseDialogformboolNo
ConnectionIDformGuidNo

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>