Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class SubscriptionObjectModel implements ISubscription, IConvertible
{
    /**
    * Guid representing the external systems datasource information.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    String? SuiteDataSourceInstanceId;

    /**
    * 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", ParameterType="query")
    String? AlternateKey;

    /**
    * 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", ParameterType="query")
    String? ObjectId;

    /**
    * 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.", Name="RmsTableCtxId", ParameterType="query")
    String? RmsTableCtxId;

    /**
    * Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.
    */
    // @ApiMember(DataType="bool", Description="Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.", Name="IgnoreValidation", ParameterType="query")
    bool? IgnoreValidation;

    SubscriptionObjectModel({this.SuiteDataSourceInstanceId,this.AlternateKey,this.ObjectId,this.RmsTableCtxId,this.IgnoreValidation});
    SubscriptionObjectModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SuiteDataSourceInstanceId = json['SuiteDataSourceInstanceId'];
        AlternateKey = json['AlternateKey'];
        ObjectId = json['ObjectId'];
        RmsTableCtxId = json['RmsTableCtxId'];
        IgnoreValidation = json['IgnoreValidation'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'AlternateKey': AlternateKey,
        'ObjectId': ObjectId,
        'RmsTableCtxId': RmsTableCtxId,
        'IgnoreValidation': IgnoreValidation
    };

    getTypeName() => "SubscriptionObjectModel";
    TypeContext? context = _ctx;
}

/**
* Inserts an object connection between 2 valid objects.
*/
// @Api(Description="Inserts an object connection between 2 valid objects.")
class SaveObjectConnection implements IConvertible
{
    /**
    * Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.
    */
    // @ApiMember(DataType="SubscriptionObjectModel", Description="Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.", IsRequired=true, Name="FromObject")
    SubscriptionObjectModel? FromObject;

    /**
    * Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.
    */
    // @ApiMember(DataType="SubscriptionObjectModel", Description="Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.", IsRequired=true, Name="ToObject")
    SubscriptionObjectModel? ToObject;

    /**
    * Guid representing the Connection Method to use to connect the objects with.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod")
    String? RmsTableCtxIdConnectionMethod;

    SaveObjectConnection({this.FromObject,this.ToObject,this.RmsTableCtxIdConnectionMethod});
    SaveObjectConnection.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FromObject = JsonConverters.fromJson(json['FromObject'],'SubscriptionObjectModel',context!);
        ToObject = JsonConverters.fromJson(json['ToObject'],'SubscriptionObjectModel',context!);
        RmsTableCtxIdConnectionMethod = json['RmsTableCtxIdConnectionMethod'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FromObject': JsonConverters.toJson(FromObject,'SubscriptionObjectModel',context!),
        'ToObject': JsonConverters.toJson(ToObject,'SubscriptionObjectModel',context!),
        'RmsTableCtxIdConnectionMethod': RmsTableCtxIdConnectionMethod
    };

    getTypeName() => "SaveObjectConnection";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'production_eros_platform_apisubscription.azurewebsites.net', types: <String, TypeInfo> {
    'SubscriptionObjectModel': TypeInfo(TypeOf.Class, create:() => SubscriptionObjectModel()),
    'SaveObjectConnection': TypeInfo(TypeOf.Class, create:() => SaveObjectConnection()),
});

Dart SaveObjectConnection DTOs

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

{
	FromObject: 
	{
		AlternateKey: String,
		IgnoreValidation: False
	},
	ToObject: 
	{
		AlternateKey: String,
		IgnoreValidation: False
	}
}

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