Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

Requires Authentication
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    ///<summary>
    ///Inserts or Updates an object connection structure.
    ///</summary>
    [Api(Description="Inserts or Updates an object connection structure.")]
    public partial class SaveObjectStructure
        : ISubscription
    {
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId")]
        public virtual Guid SuiteDataSourceInstanceId { get; set; }

        ///<summary>
        ///The unique key that represents the connection structure object on the external system.
        ///</summary>
        [ApiMember(DataType="string", Description="The unique key that represents the connection structure object on the external system.", Name="AlternateKey")]
        public virtual string AlternateKey { get; set; }

        ///<summary>
        ///Guid of the connection structure object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
        ///</summary>
        [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")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Connection Structure RmsTableCtxId.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Connection Structure RmsTableCtxId.", Name="RmsTableCtxId")]
        public virtual Guid RmsTableCtxId { get; set; }

        public virtual bool IgnoreValidation { get; set; }
        ///<summary>
        ///Id of the Connection Structure Definition.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the Connection Structure Definition.", Name="StructureDefinitionId")]
        public virtual Guid StructureDefinitionId { get; set; }

        ///<summary>
        ///Id of the Structure Type.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the Structure Type.", Name="StructureTypeId")]
        public virtual Guid StructureTypeId { get; set; }

        ///<summary>
        ///XML for the children in the structure for the object indicated via alternateKey/objectId.
        ///</summary>
        [ApiMember(DataType="string", Description="XML for the children in the structure for the object indicated via alternateKey/objectId.", Name="StructureDefinitionXml")]
        public virtual string StructureDefinitionXml { get; set; }

        ///<summary>
        ///Connection Structure Name.
        ///</summary>
        [ApiMember(DataType="string", Description="Connection Structure Name.", Name="Name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Connection Structure Reference.
        ///</summary>
        [ApiMember(DataType="string", Description="Connection Structure Reference.", Name="Reference")]
        public virtual string Reference { get; set; }

        public virtual Guid LicenseeId { get; set; }
        public virtual Guid SessionId { get; set; }
    }

}

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

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