Class CreateCustomObjectRequest

The message sent to create a custom object, with associated custom metadata.

Inheritance

object

PlatinaMessageBase

CustomRequestHeaderMessageBase

WorkingDocumentMessageBase

CreateCustomObjectRequest

Implements

IDisposable

Inherited Members

WorkingDocumentMessageBase.WorkingDocumentTitle

WorkingDocumentMessageBase.WorkingDocumentDescription

WorkingDocumentMessageBase.WorkingDocumentTypeID

WorkingDocumentMessageBase.WorkingDocumentTemplateID

WorkingDocumentMessageBase.WorkingDocumentExtension

WorkingDocumentMessageBase.WorkingDocumentFileContentLength

WorkingDocumentMessageBase.WorkingDocumentContent

WorkingDocumentMessageBase.Dispose()

CustomRequestHeaderMessageBase.CustomParameters

PlatinaMessageBase.UserName

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Integration.MessageContracts.CustomObjectManagement

Syntax

[MessageContract]
public class CreateCustomObjectRequest : WorkingDocumentMessageBase, IDisposable

Remarks

The custom object definition must exists.

Properties

BkFields

The collection of custom metadada assocaited with object.

Declaration

[MessageHeader]
public BkFieldsDictionary BkFields { get; set; }

Property Value

Type	Description
BkFieldsDictionary	The collection of custom metadada assocaited with object.

Remarks

The custom object definition must exists.

Description

The description of object.

Declaration

[MessageHeader]
public string Description { get; set; }

Property Value

Type	Description
string	The description of object.

Remarks

The custom object definition must exists.

Title

The title of object.

Declaration

[MessageHeader]
public string Title { get; set; }

Property Value

Type	Description
string	[required] The title of object.

Remarks

The custom object definition must exists.

TypeID

The identifier of the object type.

Declaration

[MessageHeader]
public int TypeID { get; set; }

Property Value

Type	Description
int	[required] The identifier of the object type.

Remarks

The type must have a definition in Platina.

Methods

IsValid()

Check if message request is valid.

Declaration

public override IsValidResult IsValid()

Returns

Type	Description
IsValidResult	IsValidResult containing an error message if invalid.

Overrides

WorkingDocumentMessageBase.IsValid()

Remarks

Only applicable on server code. This method is not exposed at client.

Implements

IDisposable