Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Inserts or Updates an object connection structure.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveObjectStructure(ISubscription):
    """
    Inserts or Updates an object connection structure.
    """

    # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId")
    suite_data_source_instance_id: Optional[str] = None
    """
    Guid representing the external systems datasource information.
    """


    # @ApiMember(DataType="string", Description="The unique key that represents the connection structure object on the external system.", Name="AlternateKey")
    alternate_key: Optional[str] = None
    """
    The unique key that represents the connection structure object on the external system.
    """


    # @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")
    object_id: Optional[str] = None
    """
    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="Connection Structure RmsTableCtxId.", Name="RmsTableCtxId")
    rms_table_ctx_id: Optional[str] = None
    """
    Connection Structure RmsTableCtxId.
    """


    ignore_validation: bool = False
    # @ApiMember(DataType="Guid", Description="Id of the Connection Structure Definition.", Name="StructureDefinitionId")
    structure_definition_id: Optional[str] = None
    """
    Id of the Connection Structure Definition.
    """


    # @ApiMember(DataType="Guid", Description="Id of the Structure Type.", Name="StructureTypeId")
    structure_type_id: Optional[str] = None
    """
    Id of the Structure Type.
    """


    # @ApiMember(DataType="string", Description="XML for the children in the structure for the object indicated via alternateKey/objectId.", Name="StructureDefinitionXml")
    structure_definition_xml: Optional[str] = None
    """
    XML for the children in the structure for the object indicated via alternateKey/objectId.
    """


    # @ApiMember(DataType="string", Description="Connection Structure Name.", Name="Name")
    name: Optional[str] = None
    """
    Connection Structure Name.
    """


    # @ApiMember(DataType="string", Description="Connection Structure Reference.", Name="Reference")
    reference: Optional[str] = None
    """
    Connection Structure Reference.
    """


    licensee_id: Optional[str] = None
    session_id: Optional[str] = None

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