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.*;

public class dtos
{

    /**
    * Inserts an object subscription for an integrated object.
    */
    @Api(Description="Inserts an object subscription for an integrated object.")
    public static class SaveObjectSubscription implements ISubscription
    {
        /**
        * 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;

        /**
        * 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")
        public String AlternateKey = null;

        /**
        * Guid of the object within Eros.
        */
        @ApiMember(DataType="Guid", Description="Guid of the object within Eros.", IsRequired=true, Name="ObjectId")
        public UUID ObjectId = 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")
        public UUID RmsTableCtxId = null;

        public Boolean IgnoreValidation = null;
        
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public SaveObjectSubscription setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public String getAlternateKey() { return AlternateKey; }
        public SaveObjectSubscription setAlternateKey(String value) { this.AlternateKey = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public SaveObjectSubscription setObjectId(UUID value) { this.ObjectId = value; return this; }
        public UUID getRmsTableCtxId() { return RmsTableCtxId; }
        public SaveObjectSubscription setRmsTableCtxId(UUID value) { this.RmsTableCtxId = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public SaveObjectSubscription setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
    }

}

Java SaveObjectSubscription DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/SaveObjectSubscription HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AlternateKey":"String","IgnoreValidation":true}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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