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
"use strict";
export class ObjectDynamicContentModel {
    /** @param {{ObjectDynamicContentId?:string,ObjectId?:string,DynamicContentDefinitionId?:string,DefinitionName?:string,ContentFormatId?:string,ContentFormat?:string,Content?:string,XmlContent?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The dynamic content Id (PKID) */
    ObjectDynamicContentId;
    /**
     * @type {string}
     * @description The object Id this dynamic content record is for. */
    ObjectId;
    /**
     * @type {string}
     * @description The dynamic content definition id that indicates what this dynamic content contains */
    DynamicContentDefinitionId;
    /**
     * @type {string}
     * @description Name of the dynamic content definition */
    DefinitionName;
    /**
     * @type {string}
     * @description The format Id the dynamic content is saved as */
    ContentFormatId;
    /**
     * @type {string}
     * @description Name of the content format */
    ContentFormat;
    /**
     * @type {string}
     * @description The content string regardless of the format. */
    Content;
    /**
     * @type {string}
     * @description XML content if the format is XML */
    XmlContent;
    /**
     * @type {string}
     * @description The contact id of the licensee who owns this record */
    OwnerContactId;
    /**
     * @type {string}
     * @description Record Status of the dynamic content */
    RecordStatus;
}
export class GetDynamicContentResponse {
    /** @param {{DynamicContent?:ObjectDynamicContentModel,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ObjectDynamicContentModel}
     * @description Dynamic Content Value. */
    DynamicContent;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetObjectDynamicContent {
    /** @param {{ObjectId?:string,DynamicContentDefinitionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The object id to retrieve dynamic content for. */
    ObjectId;
    /**
     * @type {string}
     * @description The dynamic content definition id for the type of dynamic content to retrieve. */
    DynamicContentDefinitionId;
}

JavaScript GetObjectDynamicContent DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}