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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Get all comments of a workflow task.
*/
// @Api(Description="Get all comments of a workflow task.")
class GetTaskCommentsOperation implements IConvertible
{
    /**
    * ID of the workflow task
    */
    // @ApiMember(Description="ID of the workflow task", IsRequired=true)
    int? TaskID;

    GetTaskCommentsOperation({this.TaskID});
    GetTaskCommentsOperation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TaskID = json['TaskID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TaskID': TaskID
    };

    getTypeName() => "GetTaskCommentsOperation";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'test_do_services.klokgroep.nl', types: <String, TypeInfo> {
    'GetTaskCommentsOperation': TypeInfo(TypeOf.Class, create:() => GetTaskCommentsOperation()),
});

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