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

/** @description Add a workflow task comment. */
// @Api(Description="Add a workflow task comment.")
export class AddCommentOperation
{
    /** @description ID of the workflow task(s) to affect */
    // @ApiMember(Description="ID of the workflow task(s) to affect", IsRequired=true)
    public TaskIDs: number[] = [];

    /** @description The comment to be added */
    // @ApiMember(Description="The comment to be added", IsRequired=true)
    public Comment: string;

    public constructor(init?: Partial<AddCommentOperation>) { (Object as any).assign(this, init); }
}

TypeScript AddCommentOperation 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/addcomment HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddCommentOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <Comment>String</Comment>
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
</AddCommentOperation>