Platform Subscription API

<back to all web services

SaveCustomContentFWECM

Saves Framework ECM data into EROS for linked objects.

Requires Authentication
The following routes are available for this service:
All Verbs/api/rmsdataexchange/bulk/project
All Verbs/api/rmsdataexchange/bulk/contact
All Verbs/api/rmsdataexchange/bulk/lead
All Verbs/api/rmsdataexchange/bulk/opportunity
All Verbs/api/rmsdataexchange/bulk/prospect
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Saves Framework ECM data into EROS for linked objects.
    */
    @Api(Description="Saves Framework ECM data into EROS for linked objects.")
    public static class SaveCustomContentFWECM
    {
        /**
        * 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 ArrayList<SubscriptionCustomContentModel> CustomContents = new ArrayList<SubscriptionCustomContentModel>();
        
        public ArrayList<SubscriptionCustomContentModel> getCustomContents() { return CustomContents; }
        public SaveCustomContentFWECM setCustomContents(ArrayList<SubscriptionCustomContentModel> value) { this.CustomContents = value; return this; }
    }

    public static class SubscriptionCustomContentModel
    {
        /**
        * Guid representing the external systems datasource information.
        */
        @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * 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 UUID RmsTableCtxId = 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.", Name="AlternateKey")
        public String AlternateKey = null;

        /**
        * 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 UUID ObjectId = null;

        public Boolean IgnoreValidation = null;
        /**
        * 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 Integer RmsFieldCtxId = null;

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

        public UUID LicenseeId = null;
        public UUID SessionId = null;
        
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public SubscriptionCustomContentModel setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public UUID getRmsTableCtxId() { return RmsTableCtxId; }
        public SubscriptionCustomContentModel setRmsTableCtxId(UUID value) { this.RmsTableCtxId = value; return this; }
        public String getAlternateKey() { return AlternateKey; }
        public SubscriptionCustomContentModel setAlternateKey(String value) { this.AlternateKey = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public SubscriptionCustomContentModel setObjectId(UUID value) { this.ObjectId = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public SubscriptionCustomContentModel setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
        public Integer getRmsFieldCtxId() { return RmsFieldCtxId; }
        public SubscriptionCustomContentModel setRmsFieldCtxId(Integer value) { this.RmsFieldCtxId = value; return this; }
        public String getValue() { return Value; }
        public SubscriptionCustomContentModel setValue(String value) { this.Value = value; return this; }
        public UUID getLicenseeId() { return LicenseeId; }
        public SubscriptionCustomContentModel setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
        public UUID getSessionId() { return SessionId; }
        public SubscriptionCustomContentModel setSessionId(UUID value) { this.SessionId = value; return this; }
    }

}

Java SaveCustomContentFWECM DTOs

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

HTTP + JSV

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

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
	}
}