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
<?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 Get all comments of a workflow task. */
// @Api(Description="Get all comments of a workflow task.")
class GetTaskCommentsOperation implements JsonSerializable
{
    public function __construct(
        /** @description ID of the workflow task */
        // @ApiMember(Description="ID of the workflow task", IsRequired=true)
        /** @var int */
        public int $TaskID=0
    ) {
    }

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

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