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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.Workflow.API.Operations;

namespace IDB.Workflow.API.Operations
{
    ///<summary>
    ///Add a workflow task comment.
    ///</summary>
    [Api(Description="Add a workflow task comment.")]
    public partial class AddCommentOperation
    {
        ///<summary>
        ///ID of the workflow task(s) to affect
        ///</summary>
        [ApiMember(Description="ID of the workflow task(s) to affect", IsRequired=true)]
        public virtual int[] TaskIDs { get; set; } = [];

        ///<summary>
        ///The comment to be added
        ///</summary>
        [ApiMember(Description="The comment to be added", IsRequired=true)]
        public virtual string Comment { get; set; }
    }

}

C# AddCommentOperation DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	TaskIDs: 
	[
		0
	],
	Comment: String
}