Platform API

<back to all web services

SaveObjectConnection

Creates or Updates a new connection between two objects.

import Foundation
import ServiceStack

/**
* Creates or Updates a new connection between two objects.
*/
// @Api(Description="Creates or Updates a new connection between two objects.")
public class SaveObjectConnection : Codable
{
    /**
    * 'From' object ID in the connection.
    */
    // @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
    public var fromObjectId:String

    /**
    * 'To' object ID in the connection.
    */
    // @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
    public var toObjectId:String

    /**
    * 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", ParameterType="query")
    public var rmsTableCtxIdConnectionMethod:String

    required public init(){}
}

// @ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
public class SaveObjectConnectionResponse : Codable
{
    public var objectConnectionId:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift SaveObjectConnection DTOs

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

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}