Platform Subscription API

<back to all web services

SaveCustomContentFWECM

Saves Framework ECM data into EROS for linked objects.

export class SubscriptionCustomContentModel
{
    /** @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 Eros RmsTableCtxId of the object we are saving custom content to. */
    // @ApiMember(DataType="Guid", Description="Eros RmsTableCtxId of the object we are saving custom content to.", IsRequired=true, Name="RmsTableCtxId")
    public RmsTableCtxId: 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.", 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;

    public IgnoreValidation: boolean;
    /** @description RmsFieldCtxId of the external ECM field that is used to link with the Custom Content Field in Eros. */
    // @ApiMember(DataType="int", Description="RmsFieldCtxId of the external ECM field that is used to link with the Custom Content Field in Eros.", IsRequired=true, Name="RmsFieldCtxId")
    public RmsFieldCtxId: number;

    /** @description Value to be saved for the object. */
    // @ApiMember(DataType="string", Description="Value to be saved for the object.", Name="Value")
    public Value: string;

    public LicenseeId: string;
    public SessionId: string;

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

/** @description Saves Framework ECM data into EROS for linked objects. */
// @Api(Description="Saves Framework ECM data into EROS for linked objects.")
export class SaveCustomContentFWECM
{
    /** @description To pass bulk upload of data to save for objects. */
    // @ApiMember(DataType="List<SubscriptionCustomContentModel>", Description="To pass bulk upload of data to save for objects.", IsRequired=true, Name="CustomContents")
    public CustomContents: SubscriptionCustomContentModel[] = [];

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

TypeScript SaveCustomContentFWECM DTOs

POST /api/rmsdataexchange/bulk/project HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveCustomContentFWECM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <CustomContents xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
    <d2p1:SubscriptionCustomContentModel>
      <d2p1:_x003C_AlternateKey_x003E_k__BackingField>String</d2p1:_x003C_AlternateKey_x003E_k__BackingField>
      <d2p1:_x003C_LicenseeId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_LicenseeId_x003E_k__BackingField>
      <d2p1:_x003C_ObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ObjectId_x003E_k__BackingField>
      <d2p1:_x003C_RmsFieldCtxId_x003E_k__BackingField>0</d2p1:_x003C_RmsFieldCtxId_x003E_k__BackingField>
      <d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>
      <d2p1:_x003C_SessionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SessionId_x003E_k__BackingField>
      <d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>
      <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
    </d2p1:SubscriptionCustomContentModel>
  </CustomContents>
</SaveCustomContentFWECM>

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>