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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CustomContents: 
	[
		{
			AlternateKey: String,
			IgnoreValidation: False,
			RmsFieldCtxId: 0,
			Value: String
		}
	]
}

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

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