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}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TagModel() = 
        ///<summary>
        ///Id of the tag
        ///</summary>
        [<ApiMember(Description="Id of the tag", ParameterType="query")>]
        member val Id:Guid = new Guid() with get,set

        ///<summary>
        ///Tag name
        ///</summary>
        [<ApiMember(Description="Tag name", ParameterType="query")>]
        member val Name:String = null with get,set

        ///<summary>
        ///RmsTableCtx Id that represents the type of object the tag an be linked to
        ///</summary>
        [<ApiMember(Description="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType="query")>]
        member val RmsTableCtxId:Guid = new Guid() with get,set

        ///<summary>
        ///Owner Id to use to retrieve tags for a particular licensee
        ///</summary>
        [<ApiMember(Description="Owner Id to use to retrieve tags for a particular licensee", ParameterType="query")>]
        member val ContactOwnerId:Guid = new Guid() with get,set

        ///<summary>
        ///Associated tag colour
        ///</summary>
        [<ApiMember(Description="Associated tag colour", ParameterType="query")>]
        member val Colour:String = null with get,set

        ///<summary>
        ///Object Connection Id linking an object to the tag
        ///</summary>
        [<ApiMember(Description="Object Connection Id linking an object to the tag", ParameterType="query")>]
        member val ObjectConnectionId:Guid = new Guid() with get,set

    [<ApiResponse(Description="A list of tags")>]
    [<AllowNullLiteral>]
    type GetTagsListResponse() = 
        ///<summary>
        ///List of tags.
        ///</summary>
        [<ApiMember(Description="List of tags.", ParameterType="query")>]
        member val Tags:ResizeArray<TagModel> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Link existing tag to an object. Returns the list of tags assigned to the object.
    ///</summary>
    [<Api(Description="Link existing tag to an object. Returns the list of tags assigned to the object.")>]
    [<AllowNullLiteral>]
    type LinkTagForObject() = 
        ///<summary>
        ///Object Id to link the tag to.
        ///</summary>
        [<ApiMember(Description="Object Id to link the tag to.", ParameterType="query")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///Licensee Id owner of the object.
        ///</summary>
        [<ApiMember(Description="Licensee Id owner of the object.", ParameterType="query")>]
        member val LicenseeId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of the tag
        ///</summary>
        [<ApiMember(Description="Id of the tag", ParameterType="query")>]
        member val Id:Guid = new Guid() with get,set

        ///<summary>
        ///Associated tag colour, if this is passed we will update the existing tags colour.
        ///</summary>
        [<ApiMember(Description="Associated tag colour, if this is passed we will update the existing tags colour.", ParameterType="query")>]
        member val Colour:String = null with get,set

F# LinkTagForObject 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/tags/link/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
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/csv
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"}}}