Projjex API

Projjex™ Basics

It is necessary to understand the basic data structure in order to use the API. Projjex™ users will be familiar with their project setups, but it is still important to understand the API terminology in order to maximize the usefulness of the API. This section will give you a brief introduction to the different types of data the API offers. You will note that the data structure is quite simple – we have worked hard to present the data in the least complex way possible.

User

Briefly defined, a user has the following attributes:

  • Each user represents a unique Projjex™ account, and has its own login based on an email address and password.
  • A user can be a member of any number of projects.
  • Users can be assigned tasks and milestones, can be note authors, meeting organizers or attendees, and can enter time records.
  • Users can view, add and edit information within the projects they are involved in, based on the security levels setup by each project owner.

The API contains a method to login, and this is required before making any other API call. All API calls made during the login session are done using the security permissions of that user.

Project

A project is the collaborative environment for managing work within Projjex™. Each project has a unique list of users assigned to it, so even users within the same organization can have different project lists, or have different security levels within their shared projects.

Each project has a project owner, who has full privileges to all project information. Other users in the project can be assigned as administrators, part of the organization, or outside the organization.

Project owners and administrators have full privileges to all project information, including adding and removing other users, accessing billing and costing information, and can enter time for other users.

Users within the organization cannot add or remove users or access billing and costing information, but can view, add, edit and delete all project items unless they are marked as Personal.

Users outside the organization can add items to the project items, and can only view, edit or delete items marked as Public. Items marked as Private or Personal cannot be accessed by these users.

Item

An item is an individual piece of a project that represents a specific activity. Items are arranged in a hierarchical manner, and each item can have any number of sub-items placed under it. There is no limit to the number of levels in a project hierarchy.

All types of items have a name and an optional memo. All items can have tags assigned to it, and items can be filtered by their tags. As well, documents can be attached to any item or even to a project itself.

There are 5 types of items that can be added to a project:

  • Task: A task defines a specific activity that needs to take place. Every task can have start, due and completed dates, expected duration, and can be assigned to any of the users within the project. All fields except for the name are optional.
  • Milestone: A milestone represents a key date within a project. In addition to the name and memo, milestones can optionally also have a due date, completed date, and assigned user.
  • Meeting: A meeting allows you to schedule your meetings within Projjex™. Each meeting has objectives, date/time, expected duration, a status of Upcoming, In Progress or Completed, and a list of invitees.
  • Note: Notes allow you to add comments or discussions within your project.
  • Time: A time entry tracks the work done against any other item within your project. Time can be assigned at any task, milestone, meeting or note. A time entry is the only item type that cannot have other sub-items added underneath it.
Document

A document is a file that is attached to a project. Documents can be attached to a project or to any item within a project.

Additionally, Projjex™ supports document versioning so new versions of a document can be uploaded and Projjex™ will maintain a full version history.

Tag

Tagging can be a very powerful way to manage your project data. Each item within your projects can be tagged with any number of tags. The Projects tab in the Projjex™ application allows you to easily filter project data by tags to quickly organize and manage your content.

Quick Links
Support

.NET developers can download our .NET API Wrapper. The wrapper simplifies using the Projjex™ API by returning .NET objects.

API Methods