Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

Requires Authentication
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SubscriptionObjectModel implements ISubscription, JsonSerializable
{
    public function __construct(
        /** @description Guid representing the external systems datasource information. */
        // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
        /** @var string */
        public string $SuiteDataSourceInstanceId='',

        /** @description The unique key that represents the object on the external system. */
        // @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
        /** @var string */
        public string $AlternateKey='',

        /** @description 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 object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")
        /** @var string */
        public string $ObjectId='',

        /** @description Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update. */
        // @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")
        /** @var string */
        public string $RmsTableCtxId='',

        /** @description Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement. */
        // @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")
        /** @var bool|null */
        public ?bool $IgnoreValidation=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SuiteDataSourceInstanceId'])) $this->SuiteDataSourceInstanceId = $o['SuiteDataSourceInstanceId'];
        if (isset($o['AlternateKey'])) $this->AlternateKey = $o['AlternateKey'];
        if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
        if (isset($o['RmsTableCtxId'])) $this->RmsTableCtxId = $o['RmsTableCtxId'];
        if (isset($o['IgnoreValidation'])) $this->IgnoreValidation = $o['IgnoreValidation'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SuiteDataSourceInstanceId)) $o['SuiteDataSourceInstanceId'] = $this->SuiteDataSourceInstanceId;
        if (isset($this->AlternateKey)) $o['AlternateKey'] = $this->AlternateKey;
        if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
        if (isset($this->RmsTableCtxId)) $o['RmsTableCtxId'] = $this->RmsTableCtxId;
        if (isset($this->IgnoreValidation)) $o['IgnoreValidation'] = $this->IgnoreValidation;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Inserts an object connection between 2 valid objects. */
// @Api(Description="Inserts an object connection between 2 valid objects.")
class SaveObjectConnection implements JsonSerializable
{
    public function __construct(
        /** @description 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 'From' object in the connection.", IsRequired=true, Name="FromObject")
        /** @var SubscriptionObjectModel|null */
        public ?SubscriptionObjectModel $FromObject=null,

        /** @description Information to allow retrieval of the object from Eros that will be the 'To' 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")
        /** @var SubscriptionObjectModel|null */
        public ?SubscriptionObjectModel $ToObject=null,

        /** @description Guid representing the Connection Method to use to connect the objects with. */
        // @ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod")
        /** @var string */
        public string $RmsTableCtxIdConnectionMethod=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FromObject'])) $this->FromObject = JsonConverters::from('SubscriptionObjectModel', $o['FromObject']);
        if (isset($o['ToObject'])) $this->ToObject = JsonConverters::from('SubscriptionObjectModel', $o['ToObject']);
        if (isset($o['RmsTableCtxIdConnectionMethod'])) $this->RmsTableCtxIdConnectionMethod = $o['RmsTableCtxIdConnectionMethod'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FromObject)) $o['FromObject'] = JsonConverters::to('SubscriptionObjectModel', $this->FromObject);
        if (isset($this->ToObject)) $o['ToObject'] = JsonConverters::to('SubscriptionObjectModel', $this->ToObject);
        if (isset($this->RmsTableCtxIdConnectionMethod)) $o['RmsTableCtxIdConnectionMethod'] = $this->RmsTableCtxIdConnectionMethod;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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"}}