Platform API

AddComment

Add a comment to the specified object.

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

{
	Comment: String
}

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}