Platform API

<back to all web services

SaveObjectConnection

Creates or Updates a new connection between two objects.

Requires Authentication
The following routes are available for this service:
POST/api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Saguna.Common.WebAPIModel.ServiceModels;

namespace Eros.Saguna.Common.WebAPIModel.ServiceModels
{
    ///<summary>
    ///Creates or Updates a new connection between two objects.
    ///</summary>
    [Api(Description="Creates or Updates a new connection between two objects.")]
    public partial class SaveObjectConnection
    {
        ///<summary>
        ///'From' object ID in the connection.
        ///</summary>
        [ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")]
        public virtual Guid FromObjectId { get; set; }

        ///<summary>
        ///'To' object ID in the connection.
        ///</summary>
        [ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")]
        public virtual Guid ToObjectId { get; set; }

        ///<summary>
        ///Guid representing the Connection Method to use to connect the objects with.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod", ParameterType="query")]
        public virtual Guid RmsTableCtxIdConnectionMethod { get; set; }
    }

    [ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")]
    public partial class SaveObjectConnectionResponse
    {
        public virtual Guid ObjectConnectionId { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# SaveObjectConnection DTOs

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

HTTP + CSV

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

POST /api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FromObjectId":"00000000-0000-0000-0000-000000000000","ToObjectId":"00000000-0000-0000-0000-000000000000","RmsTableCtxIdConnectionMethod":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ObjectConnectionId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}