Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionObjectModel(ISubscription):
    # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    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 object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
    alternate_key: Optional[str] = None
    """
    The unique key that represents the object on the external system.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")
    object_id: Optional[str] = None
    """
    Guid of the 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 RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId", ParameterType="query")
    rms_table_ctx_id: Optional[str] = None
    """
    Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.
    """


    # @ApiMember(DataType="bool", Description="Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.", Name="IgnoreValidation", ParameterType="query")
    ignore_validation: bool = False
    """
    Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.
    """


# @Api(Description="Inserts an object connection between 2 valid objects.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveObjectConnection:
    """
    Inserts an object connection between 2 valid objects.
    """

    # @ApiMember(DataType="SubscriptionObjectModel", Description="Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.", IsRequired=true, Name="FromObject")
    from_object: Optional[SubscriptionObjectModel] = None
    """
    Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.
    """


    # @ApiMember(DataType="SubscriptionObjectModel", Description="Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.", IsRequired=true, Name="ToObject")
    to_object: Optional[SubscriptionObjectModel] = None
    """
    Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.
    """


    # @ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod")
    rms_table_ctx_id_connection_method: Optional[str] = None
    """
    Guid representing the Connection Method to use to connect the objects with.
    """

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

{"FromObject":{"AlternateKey":"String","IgnoreValidation":false},"ToObject":{"AlternateKey":"String","IgnoreValidation":false}}
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"}}