Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Inserts or Updates an object connection structure.
*/
@Api(Description="Inserts or Updates an object connection structure.")
open class SaveObjectStructure : ISubscription
{
    /**
    * Guid representing the external systems datasource information.
    */
    @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId")
    override var SuiteDataSourceInstanceId:UUID? = null

    /**
    * 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")
    override var AlternateKey:String? = null

    /**
    * 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")
    override var ObjectId:UUID? = null

    /**
    * Connection Structure RmsTableCtxId.
    */
    @ApiMember(DataType="Guid", Description="Connection Structure RmsTableCtxId.", Name="RmsTableCtxId")
    open var RmsTableCtxId:UUID? = null

    override var IgnoreValidation:Boolean? = null
    /**
    * Id of the Connection Structure Definition.
    */
    @ApiMember(DataType="Guid", Description="Id of the Connection Structure Definition.", Name="StructureDefinitionId")
    open var StructureDefinitionId:UUID? = null

    /**
    * Id of the Structure Type.
    */
    @ApiMember(DataType="Guid", Description="Id of the Structure Type.", Name="StructureTypeId")
    open var StructureTypeId:UUID? = null

    /**
    * 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")
    open var StructureDefinitionXml:String? = null

    /**
    * Connection Structure Name.
    */
    @ApiMember(DataType="string", Description="Connection Structure Name.", Name="Name")
    open var Name:String? = null

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

    open var LicenseeId:UUID? = null
    open var SessionId:UUID? = null
}

Kotlin 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
	}
}