DigiOffice API Services Services

GetTaskOperation

Get workflow task.

The following routes are available for this service:
GET	/api/workflowtasks/{TaskID}

**GetTaskOperation** Parameters:
Name	Parameter	Data Type	Required	Description
TaskID	path	int	Yes	ID of the workflow task(s) to return

**WorkflowTaskDTO** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Name	form	string	No
WorkflowID	form	int	No
WorkflowDescription	form	string	No
RootWorkflowID	form	int	No
TransitionID	form	Guid	No
TransitionName	form	string	No
ActivationID	form	Guid?	No
TypeID	form	int	No
TypeDescription	form	string	No
StatusID	form	int	No
StatusDescription	form	string	No
UserID	form	int?	No
Active	form	bool	No
OfferedDate	form	DateTime?	No
AssignedDate	form	DateTime?	No
StartDate	form	DateTime?	No
ExpirationDate	form	DateTime?	No
Order	form	int	No
Progress	form	float?	No
FinishedDate	form	DateTime?	No
FinishedByUserID	form	int?	No
FinishedDocumentID	form	Guid?	No
Read	form	bool	No
DeferDate	form	DateTime?	No
DeferReason	form	string	No
Reason	form	string	No
Urgent	form	bool	No
Status	form	string	No
AvailableActions	form	IEnumerable<WorkflowTaskActionDTO>	No
FinishActions	form	IEnumerable<WorkflowTaskActionDTO>	No
CommentActions	form	IEnumerable<WorkflowTaskActionDTO>	No
DocumentActions	form	IEnumerable<WorkflowTaskActionDTO>	No
NumberOfComments	form	int	No
RelativeDetailLink	form	string	No
FirstSideStepID	form	int	No
FirstSideStepOmschr	form	string	No
FirstSideStepDetailLink	form	string	No
IsSideStepOfWorkflowID	form	int?	No
IsSideStepOfWorkflowOmschr	form	string	No
IsSideStepOfWorkflowDetailLink	form	string	No
IsSideStepOfTaskID	form	int?	No
IsSideStepOfTaskOmschr	form	string	No
IsSideStepOfTaskDetailLink	form	string	No
IsObservedID	form	int?	No
IsObservedOmschr	form	string	No
IsObservedDetailLink	form	string	No

**WorkflowTaskActionDTO** Parameters:
Name	Parameter	Data Type	Required
BeginGroup	form	bool	No
DigiOfficeIcon	form	string	No
Enabled	form	bool	No
FontAwesomeIcon	form	string	No
Hint	form	string	No
Name	form	string	No
ShowTextForRootItems	form	bool	No
Text	form	string	No
Url	form	string	No
Items	form	List<WorkflowTaskActionDTO>	No

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.

GET /api/workflowtasks/{TaskID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

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

<WorkflowTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs">
  <ActivationID>00000000-0000-0000-0000-000000000000</ActivationID>
  <Active>false</Active>
  <AssignedDate>0001-01-01T00:00:00</AssignedDate>
  <AvailableActions i:nil="true" />
  <CommentActions i:nil="true" />
  <DeferDate>0001-01-01T00:00:00</DeferDate>
  <DeferReason>String</DeferReason>
  <DocumentActions i:nil="true" />
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <FinishActions i:nil="true" />
  <FinishedByUserID>0</FinishedByUserID>
  <FinishedDate>0001-01-01T00:00:00</FinishedDate>
  <FinishedDocumentID>00000000-0000-0000-0000-000000000000</FinishedDocumentID>
  <FirstSideStepDetailLink>String</FirstSideStepDetailLink>
  <FirstSideStepID>0</FirstSideStepID>
  <FirstSideStepOmschr>String</FirstSideStepOmschr>
  <ID>0</ID>
  <IsObservedDetailLink>String</IsObservedDetailLink>
  <IsObservedID>0</IsObservedID>
  <IsObservedOmschr>String</IsObservedOmschr>
  <IsSideStepOfTaskDetailLink>String</IsSideStepOfTaskDetailLink>
  <IsSideStepOfTaskID>0</IsSideStepOfTaskID>
  <IsSideStepOfTaskOmschr>String</IsSideStepOfTaskOmschr>
  <IsSideStepOfWorkflowDetailLink>String</IsSideStepOfWorkflowDetailLink>
  <IsSideStepOfWorkflowID>0</IsSideStepOfWorkflowID>
  <IsSideStepOfWorkflowOmschr>String</IsSideStepOfWorkflowOmschr>
  <Name>String</Name>
  <NumberOfComments>0</NumberOfComments>
  <OfferedDate>0001-01-01T00:00:00</OfferedDate>
  <Order>0</Order>
  <Progress>0</Progress>
  <Read>false</Read>
  <Reason>String</Reason>
  <RelativeDetailLink>String</RelativeDetailLink>
  <RootWorkflowID>0</RootWorkflowID>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Status>String</Status>
  <StatusDescription>String</StatusDescription>
  <StatusID>0</StatusID>
  <TransitionID>00000000-0000-0000-0000-000000000000</TransitionID>
  <TransitionName>String</TransitionName>
  <TypeDescription>String</TypeDescription>
  <TypeID>0</TypeID>
  <Urgent>false</Urgent>
  <UserID>0</UserID>
  <WorkflowDescription>String</WorkflowDescription>
  <WorkflowID>0</WorkflowID>
</WorkflowTaskDTO>