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}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Add a new tag and link to an object. Returns the list of tags assigned to the object.
*/
@Api(Description="Add a new tag and link to an object. Returns the list of tags assigned to the object.")
open class SaveNewTagForObject
{
    /**
    * Object Id to retrieve tags for.
    */
    @ApiMember(Description="Object Id to retrieve tags for.", ParameterType="query")
    open var ObjectId:UUID? = null

    /**
    * Licensee Id owner of the object.
    */
    @ApiMember(Description="Licensee Id owner of the object.", ParameterType="query")
    open var LicenseeId:UUID? = null

    /**
    * Tag name
    */
    @ApiMember(Description="Tag name", ParameterType="query")
    open var Name:String? = null

    /**
    * Associated tag colour
    */
    @ApiMember(Description="Associated tag colour", ParameterType="query")
    open var Colour:String? = null

    /**
    * RmsTableCtx Id that represents the type of object the tag an be linked to
    */
    @ApiMember(Description="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType="query")
    open var RmsTableCtxId:UUID? = null
}

@ApiResponse(Description="A list of tags")
open class GetTagsListResponse
{
    /**
    * List of tags.
    */
    @ApiMember(Description="List of tags.", ParameterType="query")
    open var Tags:ArrayList<TagModel>? = null

    open var ResponseStatus:ResponseStatus? = null
}

open class TagModel
{
    /**
    * Id of the tag
    */
    @ApiMember(Description="Id of the tag", ParameterType="query")
    open var Id:UUID? = null

    /**
    * Tag name
    */
    @ApiMember(Description="Tag name", ParameterType="query")
    open var Name:String? = null

    /**
    * RmsTableCtx Id that represents the type of object the tag an be linked to
    */
    @ApiMember(Description="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType="query")
    open var RmsTableCtxId:UUID? = null

    /**
    * Owner Id to use to retrieve tags for a particular licensee
    */
    @ApiMember(Description="Owner Id to use to retrieve tags for a particular licensee", ParameterType="query")
    open var ContactOwnerId:UUID? = null

    /**
    * Associated tag colour
    */
    @ApiMember(Description="Associated tag colour", ParameterType="query")
    open var Colour:String? = null

    /**
    * Object Connection Id linking an object to the tag
    */
    @ApiMember(Description="Object Connection Id linking an object to the tag", ParameterType="query")
    open var ObjectConnectionId:UUID? = null
}

Kotlin 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
		}
	}
}