Platform API

<back to all web services

GetObjectDynamicContent

Get dynamic content for an object.

Requires Authentication
The following routes are available for this service:
GET/api/dynamiccontent/{ObjectId}
GET/api/dynamiccontent/{ObjectId}/mastertasklinks
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 ObjectDynamicContentModel() = 
        ///<summary>
        ///The dynamic content Id (PKID)
        ///</summary>
        [<ApiMember(Description="The dynamic content Id (PKID)", ParameterType="query")>]
        member val ObjectDynamicContentId:Guid = new Guid() with get,set

        ///<summary>
        ///The object Id this dynamic content record is for.
        ///</summary>
        [<ApiMember(Description="The object Id this dynamic content record is for.", ParameterType="query")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///The dynamic content definition id that indicates what this dynamic content contains
        ///</summary>
        [<ApiMember(Description="The dynamic content definition id that indicates what this dynamic content contains", ParameterType="query")>]
        member val DynamicContentDefinitionId:Guid = new Guid() with get,set

        ///<summary>
        ///Name of the dynamic content definition
        ///</summary>
        [<ApiMember(Description="Name of the dynamic content definition", ParameterType="query")>]
        member val DefinitionName:String = null with get,set

        ///<summary>
        ///The format Id the dynamic content is saved as
        ///</summary>
        [<ApiMember(Description="The format Id the dynamic content is saved as", ParameterType="query")>]
        member val ContentFormatId:Guid = new Guid() with get,set

        ///<summary>
        ///Name of the content format
        ///</summary>
        [<ApiMember(Description="Name of the content format", ParameterType="query")>]
        member val ContentFormat:String = null with get,set

        ///<summary>
        ///The content string regardless of the format.
        ///</summary>
        [<ApiMember(Description="The content string regardless of the format.", ParameterType="query")>]
        member val Content:String = null with get,set

        ///<summary>
        ///XML content if the format is XML
        ///</summary>
        [<ApiMember(Description="XML content if the format is XML", ParameterType="query")>]
        member val XmlContent:String = null with get,set

        ///<summary>
        ///The contact id of the licensee who owns this record
        ///</summary>
        [<ApiMember(Description="The contact id of the licensee who owns this record", ParameterType="query")>]
        member val OwnerContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Record Status of the dynamic content
        ///</summary>
        [<ApiMember(Description="Record Status of the dynamic content", ParameterType="query")>]
        member val RecordStatus:String = null with get,set

    [<ApiResponse(Description="Dynamic Content Value")>]
    [<AllowNullLiteral>]
    type GetDynamicContentResponse() = 
        ///<summary>
        ///Dynamic Content Value.
        ///</summary>
        [<ApiMember(Description="Dynamic Content Value.")>]
        member val DynamicContent:ObjectDynamicContentModel = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get dynamic content for an object.
    ///</summary>
    [<Api(Description="Get dynamic content for an object.")>]
    [<AllowNullLiteral>]
    type GetObjectDynamicContent() = 
        ///<summary>
        ///The object id to retrieve dynamic content for.
        ///</summary>
        [<ApiMember(Description="The object id to retrieve dynamic content for.", ParameterType="path")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///The dynamic content definition id for the type of dynamic content to retrieve.
        ///</summary>
        [<ApiMember(Description="The dynamic content definition id for the type of dynamic content to retrieve.", ParameterType="path")>]
        member val DynamicContentDefinitionId:Guid = new Guid() with get,set

F# GetObjectDynamicContent 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.

GET /api/dynamiccontent/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv

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

{"DynamicContent":{"ObjectDynamicContentId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","DynamicContentDefinitionId":"00000000-0000-0000-0000-000000000000","DefinitionName":"String","ContentFormatId":"00000000-0000-0000-0000-000000000000","ContentFormat":"String","Content":"String","XmlContent":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}