Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

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

Namespace Global

    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
            Implements ISubscription
            '''<Summary>
            '''Guid representing the external systems datasource information.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid representing the external systems datasource information.", Name:="SuiteDataSourceInstanceId")>
            Public Overridable Property SuiteDataSourceInstanceId As Guid Implements ISubscription.SuiteDataSourceInstanceId

            '''<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 Overridable Property AlternateKey As String Implements ISubscription.AlternateKey

            '''<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 Overridable Property ObjectId As Guid Implements ISubscription.ObjectId

            '''<Summary>
            '''Connection Structure RmsTableCtxId.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Connection Structure RmsTableCtxId.", Name:="RmsTableCtxId")>
            Public Overridable Property RmsTableCtxId As Guid

            Public Overridable Property IgnoreValidation As Boolean Implements ISubscription.IgnoreValidation
            '''<Summary>
            '''Id of the Connection Structure Definition.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Id of the Connection Structure Definition.", Name:="StructureDefinitionId")>
            Public Overridable Property StructureDefinitionId As Guid

            '''<Summary>
            '''Id of the Structure Type.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Id of the Structure Type.", Name:="StructureTypeId")>
            Public Overridable Property StructureTypeId As Guid

            '''<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 Overridable Property StructureDefinitionXml As String

            '''<Summary>
            '''Connection Structure Name.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Connection Structure Name.", Name:="Name")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Connection Structure Reference.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Connection Structure Reference.", Name:="Reference")>
            Public Overridable Property Reference As String

            Public Overridable Property LicenseeId As Guid
            Public Overridable Property SessionId As Guid
        End Class
    End Namespace
End Namespace

VB.NET 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"}}