Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

Requires Authentication
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Inserts or Updates an object connection structure.
    ///</summary>
    [<Api(Description="Inserts or Updates an object connection structure.")>]
    [<AllowNullLiteral>]
    type SaveObjectStructure() = 
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with 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")>]
        member val AlternateKey:String = null with 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")>]
        member val ObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///Connection Structure RmsTableCtxId.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Connection Structure RmsTableCtxId.", Name="RmsTableCtxId")>]
        member val RmsTableCtxId:Guid = new Guid() with get,set

        member val IgnoreValidation:Boolean = new Boolean() with get,set
        ///<summary>
        ///Id of the Connection Structure Definition.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the Connection Structure Definition.", Name="StructureDefinitionId")>]
        member val StructureDefinitionId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of the Structure Type.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the Structure Type.", Name="StructureTypeId")>]
        member val StructureTypeId:Guid = new Guid() with 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")>]
        member val StructureDefinitionXml:String = null with get,set

        ///<summary>
        ///Connection Structure Name.
        ///</summary>
        [<ApiMember(DataType="string", Description="Connection Structure Name.", Name="Name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Connection Structure Reference.
        ///</summary>
        [<ApiMember(DataType="string", Description="Connection Structure Reference.", Name="Reference")>]
        member val Reference:String = null with get,set

        member val LicenseeId:Guid = new Guid() with get,set
        member val SessionId:Guid = new Guid() with get,set

F# SaveObjectStructure DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/SaveObjectStructure HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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