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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Add a workflow task comment. */
// @Api(Description="Add a workflow task comment.")
class AddCommentOperation implements JsonSerializable
{
    public function __construct(
        /** @description ID of the workflow task(s) to affect */
        // @ApiMember(Description="ID of the workflow task(s) to affect", IsRequired=true)
        /** @var int[] */
        public array $TaskIDs=[],

        /** @description The comment to be added */
        // @ApiMember(Description="The comment to be added", IsRequired=true)
        /** @var string */
        public string $Comment=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TaskIDs'])) $this->TaskIDs = JsonConverters::fromArray('int', $o['TaskIDs']);
        if (isset($o['Comment'])) $this->Comment = $o['Comment'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TaskIDs)) $o['TaskIDs'] = JsonConverters::toArray('int', $this->TaskIDs);
        if (isset($this->Comment)) $o['Comment'] = $this->Comment;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AddCommentOperation DTOs

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

HTTP + OTHER

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

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