DigiOffice API Services Services

<back to all web services

AddCommentOperation

Add a workflow task comment.

Requires Authentication
The following routes are available for this service:
POST/api/workflowtasks/addcomment
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Add a workflow task comment.
*/
// @Api(Description="Add a workflow task comment.")
class AddCommentOperation implements IConvertible
{
    /**
    * ID of the workflow task(s) to affect
    */
    // @ApiMember(Description="ID of the workflow task(s) to affect", IsRequired=true)
    List<int>? TaskIDs = [];

    /**
    * The comment to be added
    */
    // @ApiMember(Description="The comment to be added", IsRequired=true)
    String? Comment;

    AddCommentOperation({this.TaskIDs,this.Comment});
    AddCommentOperation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TaskIDs = JsonConverters.fromJson(json['TaskIDs'],'List<int>',context!);
        Comment = json['Comment'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TaskIDs': JsonConverters.toJson(TaskIDs,'List<int>',context!),
        'Comment': Comment
    };

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

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

Dart AddCommentOperation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/workflowtasks/addcomment HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TaskIDs":[0],"Comment":"String"}