Platform Subscription API

SaveObjectStructure

Inserts or Updates an object connection structure.

import 'package:servicestack/servicestack.dart';

/**
* Inserts or Updates an object connection structure.
*/
// @Api(Description="Inserts or Updates an object connection structure.")
class SaveObjectStructure implements ISubscription, IConvertible
{
    /**
    * Guid representing the external systems datasource information.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId")
    String? SuiteDataSourceInstanceId;

    /**
    * The unique key that represents the connection structure object on the external system.
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the connection structure object on the external system.", Name="AlternateKey")
    String? AlternateKey;

    /**
    * Guid of the connection structure 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 connection structure object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId")
    String? ObjectId;

    /**
    * Connection Structure RmsTableCtxId.
    */
    // @ApiMember(DataType="Guid", Description="Connection Structure RmsTableCtxId.", Name="RmsTableCtxId")
    String? RmsTableCtxId;

    bool? IgnoreValidation;
    /**
    * Id of the Connection Structure Definition.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Connection Structure Definition.", Name="StructureDefinitionId")
    String? StructureDefinitionId;

    /**
    * Id of the Structure Type.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Structure Type.", Name="StructureTypeId")
    String? StructureTypeId;

    /**
    * XML for the children in the structure for the object indicated via alternateKey/objectId.
    */
    // @ApiMember(DataType="string", Description="XML for the children in the structure for the object indicated via alternateKey/objectId.", Name="StructureDefinitionXml")
    String? StructureDefinitionXml;

    /**
    * Connection Structure Name.
    */
    // @ApiMember(DataType="string", Description="Connection Structure Name.", Name="Name")
    String? Name;

    /**
    * Connection Structure Reference.
    */
    // @ApiMember(DataType="string", Description="Connection Structure Reference.", Name="Reference")
    String? Reference;

    String? LicenseeId;
    String? SessionId;

    SaveObjectStructure({this.SuiteDataSourceInstanceId,this.AlternateKey,this.ObjectId,this.RmsTableCtxId,this.IgnoreValidation,this.StructureDefinitionId,this.StructureTypeId,this.StructureDefinitionXml,this.Name,this.Reference,this.LicenseeId,this.SessionId});
    SaveObjectStructure.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'];
        StructureDefinitionId = json['StructureDefinitionId'];
        StructureTypeId = json['StructureTypeId'];
        StructureDefinitionXml = json['StructureDefinitionXml'];
        Name = json['Name'];
        Reference = json['Reference'];
        LicenseeId = json['LicenseeId'];
        SessionId = json['SessionId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'AlternateKey': AlternateKey,
        'ObjectId': ObjectId,
        'RmsTableCtxId': RmsTableCtxId,
        'IgnoreValidation': IgnoreValidation,
        'StructureDefinitionId': StructureDefinitionId,
        'StructureTypeId': StructureTypeId,
        'StructureDefinitionXml': StructureDefinitionXml,
        'Name': Name,
        'Reference': Reference,
        'LicenseeId': LicenseeId,
        'SessionId': SessionId
    };

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

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

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

{
	AlternateKey: String,
	RmsTableCtxId: 4f501e1e-5e4c-439a-bf6a-2253fcbbcf68,
	IgnoreValidation: False,
	StructureDefinitionXml: String,
	Name: String,
	Reference: 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
	}
}