NovatusProject Object

  • The NovatusProject class contains information about Projects. 
  • The class itself does not contain project items, but rather the data for the project itself. To access the Project menu of Contracts, Companies, etc., the getProjectMenu and setProjectMenu methods are provided (see next section for more details).
  • Project Team Members are described by the NovatusProjectTeamMember class, and Project Menu Items are described by the NovatusProjectMenuItem class.

Field Name

Type

Description

Queryable

Required

id

String

A unique identifier of this Project

Yes

-

name

String

Project Name

Yes

Yes

description

String

Project Description

Yes

Yes

status

String

Project Status

Yes

Yes

group

String

Project Group

Yes

-

type

String

Project Type

Yes

Yes

startDate

XML Gregorian Calendar Date

Project Start Date

Yes

-

endDate

XML Gregorian Calendar Date

Project End Date

Yes

-

teamMembers

List<NovatusProjectTeamMember>

List of team members

-

Yes, if using team instead of group

dynamics

Map<String,Object>

A map of dynamic object type ID's to their values

-

-

NovatusProjectMenuItem

  • The NovatusProjectMenuItem class controls what contracts and companies certain projects are associated with.
  • Because the project has to be queried first there are no queries for the project menu itself.
  • This class can be used to associate contracts or companies with projects
  • This class uses the getProjectMenuItem and setProjectMenuItem to first get the project menu and then set companies / contracts / folders to the project menu.

Field Name

Type

Description

Required

objectId

String

The unique identifier of the company/contract referred to

Yes

objectType

Int

The type of object the project is to be associated with: 0 = automatic, 1 = Company, 2 = Contract, 3 = folder

-

orderIndex

Int

The order of this node in the tree under its parent

-

nodeId

String

A unique identifier for the menu item

-

parentId

String

The nodeId of this menu item's parent (empty if root)

Yes, if placing the company / contract / folder under an existing folder

folderName


The displayed name if this is a folder

Yes, if the menu item being created is a folder.

NovatusProject Object and NovatusProjectMenuItem Methods


NovatusProject NQL Statements

These are list of items that can be placed into an NQL statement to filter Project queries.  This is different from the above chart in that these are not methods that can return data but rather NQL statements that can allow you to filter query results.

Field Name

Description

id

A unique identifier of this Project

name

Project Name

description

Project Description

status

Project Status

group

Project Group

type

Project Type

startDate

Project Start Date

endDate

Project End Date

lastupdatedon

The last date in which the project was last updated

createdon

The date in which the project was created