Platform API

<back to all web services

AddComment

Add a comment to the specified object.

Requires Authentication
The following routes are available for this service:
POST/api/comment
"use strict";
export class SendCommunicationResponse {
    /** @param {{CommunicationId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CommunicationId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class AddComment {
    /** @param {{ConnectedObjectId?:string,Comment?:string,SuiteId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Object linked to the comment. */
    ConnectedObjectId;
    /**
     * @type {string}
     * @description Comment content */
    Comment;
    /**
     * @type {string}
     * @description The comment suite id */
    SuiteId;
}

JavaScript AddComment 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/comment HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000","Comment":"String","SuiteId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CommunicationId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}