Class ProjectEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for ProjectEntity. The Project Service. The service implements all services working with the Project object

public class ProjectEntity : Carrier

Inheritance

object ← Carrier ← ProjectEntity

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get ProjectEntity 123 using the WebApi client: <pre><code class=“lang-csharp”>var configuration = new WebApiConfiguration(url); var agent = new ProjectAgent(configuration); var projectEntity = agent.GetProjectEntity( 123 );</code></pre>

Remarks

Use <xref href=“SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent” data-throw-if-not-resolved=“false”></xref>: All ProjectEntity: <pre><code class=“lang-csharp”>“FindProject”</code></pre> Activities: <pre><code class=“lang-csharp”>“ProjectActivity”</code></pre> with restriction <pre><code class=“lang-csharp”>“projectId eq ” + id</code></pre>. Guide: <pre><code class=“lang-csharp”>“ProjectGuide”</code></pre> with restriction <pre><code class=“lang-csharp”>“projectId eq ” + id</code></pre>. Members: <pre><code class=“lang-csharp”>“ProjectMember”</code></pre> with restriction <pre><code class=“lang-csharp”>“projectId eq ” + id</code></pre>. Contacts: <pre><code class=“lang-csharp”>“ContactProjects”</code></pre> with restriction <pre><code class=“lang-csharp”>“projectId eq ” + id</code></pre>. Links: <pre><code class=“lang-csharp”>“Links”</code></pre> with restriction <pre><code class=“lang-csharp”>“sourceProjectRestrictionId eq ” + id</code></pre>.

Constructors

ProjectEntity()

Default constructor - defaults any enum props to 0.

public ProjectEntity()

Properties

ActiveErpLinks

The number of active erp links

public virtual int ActiveErpLinks { get; set; }

Property Value

int

ActiveLinks

Number of active links to documents, other appointments, and such

public virtual uint ActiveLinks { get; set; }

Property Value

uint

ActiveStatusMonitorId

Active status monitor identity with the lowest rank for project

public virtual int ActiveStatusMonitorId { get; set; }

Property Value

int

Associate

The person that created the project <p>Use MDO List name “associate” to get list items.</p>

public virtual Associate Associate { get; set; }

Property Value

Associate

Completed

Done (0=false, 1=true). Status implies changes in which fields are shown in GUI, as well as which fields can be updated

public virtual bool Completed { get; set; }

Property Value

bool

CreatedBy

The person that created the project

public virtual Associate CreatedBy { get; set; }

Property Value

Associate

CreatedDate

Registered date

public virtual DateTime CreatedDate { get; set; }

Property Value

DateTime

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual <xref href=“SuperOffice.WebApi.Data.ProjectEntity.ExtraFields” data-throw-if-not-resolved=“false”></xref> and <xref href=“SuperOffice.WebApi.Data.ProjectEntity.UserDefinedFields?text=UserDefinedFields” data-throw-if-not-resolved=“false”></xref> properties are deprecated in favor of this combined collection. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary CustomFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Extra field data</td><td class=“description”> [Extra field name]<p></p> Example: <pre><code class=“lang-csharp”>‘x_gorp’ = ‘[I:123]’</code></pre> </td></tr><tr><td class=“term”>User defined field data</td><td class=“description”> [Prog-id name]<p></p> Example: <pre><code class=“lang-csharp”>‘SuperOffice:1’ = ‘[I:123]’</code></pre><p></p> </td></tr></tbody></table>

Description

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

public virtual string Description { get; set; }

Property Value

string

EndDate

Planned end date for project, inhertied from type and later editable

public virtual DateTime EndDate { get; set; }

Property Value

DateTime

EventId

Reserved field for Lyyti event when project is linked to an event.

public virtual int EventId { get; set; }

Property Value

int

ExtraFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.ProjectEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary ExtraFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Plug-in data</td><td class=“description”> [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType </td></tr><tr><td class=“term”>Foreign key data</td><td class=“description”> The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry </td></tr><tr><td class=“term”>User defined table data</td><td class=“description”> [Table name].[Field name] Example: Phunneling.AggregatedSales </td></tr><tr><td class=“term”>Other</td><td class=“description”> Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys). </td></tr></tbody></table>

HasImage

True if the project has an image. (This is the image that is displayed in the CRM client)

public virtual bool HasImage { get; set; }

Property Value

bool

ImageDescription

Description of the project image if it exists. (This is the image that is displayed in the CRM client)

public virtual string ImageDescription { get; set; }

Property Value

string

IsPublished

Publication is published

public virtual bool IsPublished { get; set; }

Property Value

bool

Links

List of all elements linked to the project

public virtual Link[] Links { get; set; }

Property Value

Link[]

Name

Project name

public virtual string Name { get; set; }

Property Value

string

NextMilestoneDate

Calculated date, reflects date of closest non-complete future milestone activity

public virtual DateTime NextMilestoneDate { get; set; }

Property Value

DateTime

NmdAppointmentId

ID of appointment that “caused” the nextMilestoneDate, can be 0

public virtual int NmdAppointmentId { get; set; }

Property Value

int

Postit

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

public virtual string Postit { get; set; }

Property Value

string

ProjectId

Primary key

public virtual int ProjectId { get; set; }

Property Value

int

ProjectMembers

The persons which are members of the project

public virtual ProjectMember[] ProjectMembers { get; set; }

Property Value

ProjectMember[]

ProjectNumber

Automatically generated number

public virtual string ProjectNumber { get; set; }

Property Value

string

ProjectStatus

Project status is a list defined by the database administrator. Different statuses of a project may be: “In planning”, “Started”, “Finished” and so on <p>Use MDO List name “projectstatus” to get list items.</p>

public virtual ProjectStatus ProjectStatus { get; set; }

Property Value

ProjectStatus

ProjectType

Project type is a list defined by the database admin. for example: ‘Large’, ‘Small’, ‘Party’… <p>Use MDO List name “projecttype” to get list items.</p>

public virtual ProjectType ProjectType { get; set; }

Property Value

ProjectType

PublishEventDate

Publish event date

public virtual DateTime PublishEventDate { get; set; }

Property Value

DateTime

PublishFrom

Publication valid from (inclusive)

public virtual DateTime PublishFrom { get; set; }

Property Value

DateTime

PublishTo

Publication valid to (inclusive)

public virtual DateTime PublishTo { get; set; }

Property Value

DateTime

StartDate

Reserved field for Lyyti event when project is linked to an event, is the event start date.

public virtual DateTime StartDate { get; set; }

Property Value

DateTime

UpdatedBy

The person that last updated the project

public virtual Associate UpdatedBy { get; set; }

Property Value

Associate

UpdatedDate

Last updated date

public virtual DateTime UpdatedDate { get; set; }

Property Value

DateTime

Urls

The project’s internet adresses

public virtual EntityElement[] Urls { get; set; }

Property Value

EntityElement[]

UserDefinedFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.ProjectEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format “SuperOffice:[UdefFieldIdentity]”, e.g. “SuperOffice:1234” The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary UserDefinedFields { get; set; }

Property Value

StringDictionary

​Class ProjectEntity

​Inheritance

​Inherited Members

​Examples

​Remarks

​Constructors

​ProjectEntity()

​Properties

​ActiveErpLinks

​Property Value

​ActiveLinks

​Property Value

​ActiveStatusMonitorId

​Property Value

​Associate

​Property Value

​Completed

​Property Value

​CreatedBy

​Property Value

​CreatedDate

​Property Value

​CustomFields

​Property Value

​Remarks

​Description

​Property Value

​EndDate

​Property Value

​EventId

​Property Value

​ExtraFields

​Property Value

​Remarks

​HasImage

​Property Value

​ImageDescription

​Property Value

​IsPublished

​Property Value

​Links

​Property Value

​Name

​Property Value

​NextMilestoneDate

​Property Value

​NmdAppointmentId

​Property Value

​Postit

​Property Value

​ProjectId

​Property Value

​ProjectMembers

​Property Value

​ProjectNumber

​Property Value

​ProjectStatus

​Property Value

​ProjectType

​Property Value

​PublishEventDate

​Property Value

​PublishFrom

​Property Value

​PublishTo

​Property Value

​StartDate

​Property Value

​UpdatedBy

​Property Value

​UpdatedDate

​Property Value

​Urls

​Property Value

​UserDefinedFields

​Property Value

​See Also

Class ProjectEntity

Inheritance

Inherited Members

Examples

Remarks

Constructors

ProjectEntity()

Properties

ActiveErpLinks

Property Value

ActiveLinks

Property Value

ActiveStatusMonitorId

Property Value

Associate

Property Value

Completed

Property Value

CreatedBy

Property Value

CreatedDate

Property Value

CustomFields

Property Value

Remarks

Description

Property Value

EndDate

Property Value

EventId

Property Value

ExtraFields

Property Value

Remarks

HasImage

Property Value

ImageDescription

Property Value

IsPublished

Property Value

Links

Property Value

Name

Property Value

NextMilestoneDate

Property Value

NmdAppointmentId

Property Value

Postit

Property Value

ProjectId

Property Value

ProjectMembers

Property Value

ProjectNumber

Property Value

ProjectStatus

Property Value

ProjectType

Property Value

PublishEventDate

Property Value

PublishFrom

Property Value

PublishTo

Property Value

StartDate

Property Value

UpdatedBy

Property Value

UpdatedDate

Property Value

Urls

Property Value

UserDefinedFields

Property Value

See Also