Platform Subscription API

<back to all web services

SaveObjectDynamicContent

Inserts or Updates dynamic content for an object.

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


/**
* Inserts or Updates dynamic content for an object.
*/
@Api(Description="Inserts or Updates dynamic content for an object.")
open class SaveObjectDynamicContent : ISubscription
{
    /**
    * Guid representing the external systems datasource information.
    */
    @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="body")
    override var SuiteDataSourceInstanceId:UUID? = null

    /**
    * The unique key that represents the object on the external system.
    */
    @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="body")
    override var AlternateKey:String? = null

    /**
    * Guid of the object within PSTPF.  If ObjectId is known, the external system may pass this instead of the alternate key.
    */
    @ApiMember(DataType="Guid", Description="Guid of the object within PSTPF.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="body")
    override var ObjectId:UUID? = null

    /**
    * Guid of the RmsTableCtx within PSTPF.  This is used if the alternate key is provided to identify the object to update.
    */
    @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within PSTPF.  This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId", ParameterType="body")
    open var RmsTableCtxId:UUID? = null

    /**
    * Dynamic Content to be added to the object.
    */
    @ApiMember(DataType="DynamicContentModel", Description="Dynamic Content to be added to the object.", IsRequired=true, Name="DynamicContent", ParameterType="body")
    open var DynamicContent:DynamicContentModel? = null
}

open class DynamicContentModel
{
    /**
    * Dynamic Content Definition indicating the content type.
    */
    @ApiMember(DataType="DynamicContentModel", Description="Dynamic Content Definition indicating the content type.", IsRequired=true, Name="DynamicContentDefinitionId", ParameterType="body")
    open var DynamicContentDefinitionId:UUID? = null

    /**
    * Guid indicating the content format. Not required to be passed.
    */
    @ApiMember(DataType="DynamicContentModel", Description="Guid indicating the content format. Not required to be passed.", Name="ContentFormatId", ParameterType="body")
    open var ContentFormatId:UUID? = null

    /**
    * Actual Content to be added to the object.
    */
    @ApiMember(DataType="DynamicContentModel", Description="Actual Content to be added to the object.", IsRequired=true, Name="Content", ParameterType="body")
    open var Content:String? = null
}

Kotlin SaveObjectDynamicContent 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.

POST /json/reply/SaveObjectDynamicContent HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AlternateKey":"String","DynamicContent":{"Content":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}