Platform Subscription API

<back to all web services

SaveObjectDynamicContent

Inserts or Updates dynamic content for an object.

Requires Authentication

export class DynamicContentModel
{
    /** @description Dynamic Content Definition indicating the content type. */
    // @ApiMember(DataType="DynamicContentModel", Description="Dynamic Content Definition indicating the content type.", IsRequired=true, Name="DynamicContentDefinitionId")
    public DynamicContentDefinitionId: string;

    /** @description 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")
    public ContentFormatId: string;

    /** @description Actual Content to be added to the object. */
    // @ApiMember(DataType="DynamicContentModel", Description="Actual Content to be added to the object.", IsRequired=true, Name="Content")
    public Content: string;

    public constructor(init?: Partial<DynamicContentModel>) { (Object as any).assign(this, init); }
}

/** @description Inserts or Updates dynamic content for an object. */
// @Api(Description="Inserts or Updates dynamic content for an object.")
export class SaveObjectDynamicContent implements ISubscription
{
    /** @description Guid representing the external systems datasource information. */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
    public SuiteDataSourceInstanceId: string;

    /** @description 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")
    public AlternateKey: string;

    /** @description Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key. */
    // @ApiMember(DataType="Guid", Description="Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId")
    public ObjectId: string;

    /** @description Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update. */
    // @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId")
    public RmsTableCtxId: string;

    public IgnoreValidation: boolean;
    /** @description Dynamic Content to be added to the object. */
    // @ApiMember(DataType="DynamicContentModel", Description="Dynamic Content to be added to the object.", IsRequired=true, Name="DynamicContent")
    public DynamicContent: DynamicContentModel;

    public constructor(init?: Partial<SaveObjectDynamicContent>) { (Object as any).assign(this, init); }
}

TypeScript SaveObjectDynamicContent DTOs

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

HTTP + XML

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

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

<SaveObjectDynamicContent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <AlternateKey>String</AlternateKey>
  <DynamicContent>
    <Content>String</Content>
    <ContentFormatId>00000000-0000-0000-0000-000000000000</ContentFormatId>
    <DynamicContentDefinitionId>00000000-0000-0000-0000-000000000000</DynamicContentDefinitionId>
  </DynamicContent>
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
  <RmsTableCtxId>00000000-0000-0000-0000-000000000000</RmsTableCtxId>
  <SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</SaveObjectDynamicContent>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>