DigiOffice API Services Services

<back to all web services

GetTaskCommentsOperation

Get all comments of a workflow task.

Requires Authentication
The following routes are available for this service:
POST/api/workflowtasks/getcomments
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.Workflow.API.Operations

Namespace Global

    Namespace IDB.Workflow.API.Operations

        '''<Summary>
        '''Get all comments of a workflow task.
        '''</Summary>
        <Api(Description:="Get all comments of a workflow task.")>
        Public Partial Class GetTaskCommentsOperation
            '''<Summary>
            '''ID of the workflow task
            '''</Summary>
            <ApiMember(Description:="ID of the workflow task", IsRequired:=true)>
            Public Overridable Property TaskID As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetTaskCommentsOperation 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/getcomments HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetTaskCommentsOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <TaskID>0</TaskID>
</GetTaskCommentsOperation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfWorkflowTaskCommentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs">
  <WorkflowTaskCommentDTO>
    <CommentDate>0001-01-01T00:00:00</CommentDate>
    <CommentType>0</CommentType>
    <Join>String</Join>
    <Memo>String</Memo>
    <MemoDetails>String</MemoDetails>
    <TaskID>0</TaskID>
    <TaskName>String</TaskName>
    <UserID>0</UserID>
    <UserName>String</UserName>
  </WorkflowTaskCommentDTO>
</ArrayOfWorkflowTaskCommentDTO>