Platform API

SaveNewTagForObject

Add a new tag and link to an object. Returns the list of tags assigned to the object.

The following routes are available for this service:
POST	/api/tags/add/{ObjectId}

"use strict";
export class TagModel {
    /** @param {{Id?:string,Name?:string,RmsTableCtxId?:string,ContactOwnerId?:string,Colour?:string,ObjectConnectionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the tag */
    Id;
    /**
     * @type {string}
     * @description Tag name */
    Name;
    /**
     * @type {string}
     * @description RmsTableCtx Id that represents the type of object the tag an be linked to */
    RmsTableCtxId;
    /**
     * @type {string}
     * @description Owner Id to use to retrieve tags for a particular licensee */
    ContactOwnerId;
    /**
     * @type {string}
     * @description Associated tag colour */
    Colour;
    /**
     * @type {string}
     * @description Object Connection Id linking an object to the tag */
    ObjectConnectionId;
}
export class GetTagsListResponse {
    /** @param {{Tags?:TagModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {TagModel[]}
     * @description List of tags. */
    Tags;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SaveNewTagForObject {
    /** @param {{ObjectId?:string,LicenseeId?:string,Name?:string,Colour?:string,RmsTableCtxId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Object Id to retrieve tags for. */
    ObjectId;
    /**
     * @type {string}
     * @description Licensee Id owner of the object. */
    LicenseeId;
    /**
     * @type {string}
     * @description Tag name */
    Name;
    /**
     * @type {string}
     * @description Associated tag colour */
    Colour;
    /**
     * @type {string}
     * @description RmsTableCtx Id that represents the type of object the tag an be linked to */
    RmsTableCtxId;
}

JavaScript SaveNewTagForObject 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/tags/add/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Colour: String
}

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

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