Platform API

LinkTagForObject

Link existing tag to an object. Returns the list of tags assigned to the object.

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

import Foundation
import ServiceStack

/**
* Link existing tag to an object. Returns the list of tags assigned to the object.
*/
// @Api(Description="Link existing tag to an object. Returns the list of tags assigned to the object.")
public class LinkTagForObject : Codable
{
    /**
    * Object Id to link the tag to.
    */
    // @ApiMember(Description="Object Id to link the tag to.", ParameterType="query")
    public var objectId:String

    /**
    * Licensee Id owner of the object.
    */
    // @ApiMember(Description="Licensee Id owner of the object.", ParameterType="query")
    public var licenseeId:String

    /**
    * Id of the tag
    */
    // @ApiMember(Description="Id of the tag", ParameterType="query")
    public var id:String

    /**
    * Associated tag colour, if this is passed we will update the existing tags colour.
    */
    // @ApiMember(Description="Associated tag colour, if this is passed we will update the existing tags colour.", ParameterType="query")
    public var colour:String

    required public init(){}
}

// @ApiResponse(Description="A list of tags")
public class GetTagsListResponse : Codable
{
    /**
    * List of tags.
    */
    // @ApiMember(Description="List of tags.", ParameterType="query")
    public var tags:[TagModel]

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class TagModel : Codable
{
    /**
    * Id of the tag
    */
    // @ApiMember(Description="Id of the tag", ParameterType="query")
    public var id:String

    /**
    * Tag name
    */
    // @ApiMember(Description="Tag name", ParameterType="query")
    public var name:String

    /**
    * 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")
    public var rmsTableCtxId:String

    /**
    * 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")
    public var contactOwnerId:String

    /**
    * Associated tag colour
    */
    // @ApiMember(Description="Associated tag colour", ParameterType="query")
    public var colour:String

    /**
    * Object Connection Id linking an object to the tag
    */
    // @ApiMember(Description="Object Connection Id linking an object to the tag", ParameterType="query")
    public var objectConnectionId:String

    required public init(){}
}

Swift LinkTagForObject DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/tags/link/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","Id":"00000000-0000-0000-0000-000000000000","Colour":"String"}

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

{"Tags":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String","RmsTableCtxId":"00000000-0000-0000-0000-000000000000","ContactOwnerId":"00000000-0000-0000-0000-000000000000","Colour":"String","ObjectConnectionId":"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"}}}