| POST | /api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod} |
|---|
// @ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
export class SaveObjectConnectionResponse
{
public ObjectConnectionId: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<SaveObjectConnectionResponse>) { (Object as any).assign(this, init); }
}
/** @description Creates or Updates a new connection between two objects. */
// @Api(Description="Creates or Updates a new connection between two objects.")
export class SaveObjectConnection
{
/** @description 'From' object ID in the connection. */
// @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
public FromObjectId: string;
/** @description 'To' object ID in the connection. */
// @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
public ToObjectId: string;
/** @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", ParameterType="query")
public RmsTableCtxIdConnectionMethod: string;
public constructor(init?: Partial<SaveObjectConnection>) { (Object as any).assign(this, init); }
}
TypeScript SaveObjectConnection DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/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
}
}
}