Platform Subscription API

<back to all web services

SaveObjectSubscription

Inserts an object subscription for an integrated object.

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Inserts an object subscription for an integrated object.
*/
@Api(Description="Inserts an object subscription for an integrated object.")
open class SaveObjectSubscription : ISubscription
{
    /**
    * Guid representing the external systems datasource information.
    */
    @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
    override var SuiteDataSourceInstanceId:UUID? = 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.", IsRequired=true, Name="AlternateKey")
    override var AlternateKey:String? = null

    /**
    * Guid of the object within Eros.
    */
    @ApiMember(DataType="Guid", Description="Guid of the object within Eros.", IsRequired=true, Name="ObjectId")
    override var ObjectId:UUID? = null

    /**
    * 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.", IsRequired=true, Name="RmsTableCtxId")
    open var RmsTableCtxId:UUID? = null

    override var IgnoreValidation:Boolean? = null
}

Kotlin SaveObjectSubscription 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 /jsv/reply/SaveObjectSubscription HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AlternateKey: String,
	IgnoreValidation: True
}
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
	}
}