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 Foundation
import ServiceStack

/**
* Saves Framework ECM data into EROS for linked objects.
*/
// @Api(Description="Saves Framework ECM data into EROS for linked objects.")
public class SaveCustomContentFWECM : Codable
{
    /**
    * 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 var customContents:[SubscriptionCustomContentModel] = []

    required public init(){}
}

public class SubscriptionCustomContentModel : Codable
{
    /**
    * Guid representing the external systems datasource information.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
    public var suiteDataSourceInstanceId:String

    /**
    * 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 var rmsTableCtxId:String

    /**
    * 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 var alternateKey:String

    /**
    * 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 var objectId:String

    public var ignoreValidation:Bool
    /**
    * 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 var rmsFieldCtxId:Int

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

    public var licenseeId:String
    public var sessionId:String

    required public init(){}
}


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