Platform Subscription API

SaveObjectStructure

Inserts or Updates an object connection structure.


/** @description Inserts or Updates an object connection structure. */
// @Api(Description="Inserts or Updates an object connection structure.")
export class SaveObjectStructure implements ISubscription
{
    /** @description Guid representing the external systems datasource information. */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId")
    public SuiteDataSourceInstanceId: string;

    /** @description 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 AlternateKey: string;

    /** @description 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 ObjectId: string;

    /** @description Connection Structure RmsTableCtxId. */
    // @ApiMember(DataType="Guid", Description="Connection Structure RmsTableCtxId.", Name="RmsTableCtxId")
    public RmsTableCtxId: string;

    public IgnoreValidation: boolean;
    /** @description Id of the Connection Structure Definition. */
    // @ApiMember(DataType="Guid", Description="Id of the Connection Structure Definition.", Name="StructureDefinitionId")
    public StructureDefinitionId: string;

    /** @description Id of the Structure Type. */
    // @ApiMember(DataType="Guid", Description="Id of the Structure Type.", Name="StructureTypeId")
    public StructureTypeId: string;

    /** @description 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 StructureDefinitionXml: string;

    /** @description Connection Structure Name. */
    // @ApiMember(DataType="string", Description="Connection Structure Name.", Name="Name")
    public Name: string;

    /** @description Connection Structure Reference. */
    // @ApiMember(DataType="string", Description="Connection Structure Reference.", Name="Reference")
    public Reference: string;

    public LicenseeId: string;
    public SessionId: string;

    public constructor(init?: Partial<SaveObjectStructure>) { (Object as any).assign(this, init); }
}

TypeScript SaveObjectStructure DTOs

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

HTTP + XML

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

POST /xml/reply/SaveObjectStructure HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveObjectStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <_x003C_AlternateKey_x003E_k__BackingField>String</_x003C_AlternateKey_x003E_k__BackingField>
  <_x003C_LicenseeId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_LicenseeId_x003E_k__BackingField>
  <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
  <_x003C_ObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ObjectId_x003E_k__BackingField>
  <_x003C_Reference_x003E_k__BackingField>String</_x003C_Reference_x003E_k__BackingField>
  <_x003C_SessionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_SessionId_x003E_k__BackingField>
  <_x003C_StructureDefinitionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_StructureDefinitionId_x003E_k__BackingField>
  <_x003C_StructureDefinitionXml_x003E_k__BackingField>String</_x003C_StructureDefinitionXml_x003E_k__BackingField>
  <_x003C_StructureTypeId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_StructureTypeId_x003E_k__BackingField>
  <_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>
</SaveObjectStructure>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>