Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

Requires Authentication
import Foundation
import ServiceStack

/**
* Inserts or Updates an object connection structure.
*/
// @Api(Description="Inserts or Updates an object connection structure.")
public class SaveObjectStructure : ISubscription, Codable
{
    /**
    * Guid representing the external systems datasource information.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId")
    public var suiteDataSourceInstanceId:String

    /**
    * 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")
    public var alternateKey:String

    /**
    * 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")
    public var objectId:String

    /**
    * Connection Structure RmsTableCtxId.
    */
    // @ApiMember(DataType="Guid", Description="Connection Structure RmsTableCtxId.", Name="RmsTableCtxId")
    public var rmsTableCtxId:String

    public var ignoreValidation:Bool
    /**
    * Id of the Connection Structure Definition.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Connection Structure Definition.", Name="StructureDefinitionId")
    public var structureDefinitionId:String

    /**
    * Id of the Structure Type.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Structure Type.", Name="StructureTypeId")
    public var structureTypeId:String

    /**
    * 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")
    public var structureDefinitionXml:String

    /**
    * Connection Structure Name.
    */
    // @ApiMember(DataType="string", Description="Connection Structure Name.", Name="Name")
    public var name:String

    /**
    * Connection Structure Reference.
    */
    // @ApiMember(DataType="string", Description="Connection Structure Reference.", Name="Reference")
    public var reference:String

    public var licenseeId:String
    public var sessionId:String

    required public init(){}
}


Swift SaveObjectStructure DTOs

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

HTTP + CSV

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

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

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