Connectors Reference

Project Online

Project Online is a flexible online solution for project portfolio management (PPM) and everyday work from Microsoft. Delivered through Office 365, Project Online enables organizations to get started quickly with powerful project management capabilities to plan, prioritize, and manage projects and project portfolio investments-from almost anywhere on almost any device.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListProjects (string siteUrl)

List projects

CreateProject (string siteUrl, NewProject proj)

Creates new project

CreateTask (string siteUrl, string project_id, NewTask task)

Creates new task

CreateResource (string siteUrl, NewResource resource)

Create new resource

ListTasks (string siteUrl, string project_id)

Lists tasks

CheckoutProject (string siteUrl, string project_id)

Checkout project

PublishProject (string siteUrl, string project_id)

Checkin and publish project

 

Triggers:

Name

Summary

OnNewProject (string siteUrl)

When a new project is created

OnProjectPublished (string siteUrl)

When a project is published

OnNewResource (string siteUrl)

When a new resource is created

OnNewTask (string siteUrl)

When a new task is created

 

Objects:

Name

Summary

EnterpriseResource

 

NewProject

 

NewResource

 

NewTask

 

Object

 

Project

 

ProjectsWrapper

 

Task

 

TaskParameters

 

TasksWrapper

 

TriggerProject

 

TriggerProjectsWrapper

 

TriggerResource

 

TriggerResourcesWrapper

 

TriggerTask

 

TriggerTasksWrapper

 

 

Actions:

ListProjects

Summary: List projects

Description: Lists the projects in your project online site.

 

Syntax:

ProjectOnline.ListProjects (string siteUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

 

Returns:

          Type:ProjectsWrapper

          Description: Project online list projects response model

 

CreateProject

Summary: Creates new project

Description: Creates a new project in your project online site.

 

Syntax:

ProjectOnline.CreateProject (string siteUrl, NewProject proj)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

proj

NewProject

 

New project online server project

True

 

Returns:

          Type:Project

          Description: Project Online Project Model

 

CreateTask

Summary: Creates new task

Description: Creates a new task in you project.

 

Syntax:

ProjectOnline.CreateTask (string siteUrl, string project_id, NewTask task)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

project_id

string

(Project Id)

The unique id of the project to add the task to.

True

task

NewTask

 

New project online server task

True

 

Returns:

          Type:NewTask

          Description: New project online server task

 

CreateResource

Summary: Create new resource

Description: Creates an Enterprise Resource in your Project Online site.

 

Syntax:

ProjectOnline.CreateResource (string siteUrl, NewResource resource)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

resource

NewResource

 

A new project online server resource

True

 

Returns:

          Type:EnterpriseResource

          Description: Project Online Enterprise Resource Model

 

ListTasks

Summary: Lists tasks

Description: Lists the published tasks in a project.

 

Syntax:

ProjectOnline.ListTasks (string siteUrl, string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

project_id

string

(Project Id)

The unique id of the project to fetch tasks.

True

 

Returns:

          Type:TasksWrapper

          Description: Project online list tasks response model

 

CheckoutProject

Summary: Checkout project

Description: Checks out an existing project in your site.

 

Syntax:

ProjectOnline.CheckoutProject (string siteUrl, string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

project_id

string

(Project Id)

The unique id of the project to checkout.

True

 

Returns:

          Type:Object

 

PublishProject

Summary: Checkin and publish project

Description: Check in and publish an existing project in your site.

 

Syntax:

ProjectOnline.PublishProject (string siteUrl, string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

project_id

string

(Project Id)

The unique id of the project to checkin.

True

 

Returns:

          Type:Object

 

Triggers:

Trigger OnNewProject

Summary: When a new project is created

Description: Triggers a flow whenever a new project is created.

 

Syntax:

ProjectOnline.OnNewProject (string siteUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

 

Returns:

          Type:TriggerProjectsWrapper

          Description: Project Online on new project response model.

 

Trigger OnProjectPublished

Summary: When a project is published

Description: Triggers a flow whenever a project is published.

 

Syntax:

ProjectOnline.OnProjectPublished (string siteUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

 

Returns:

          Type:TriggerProjectsWrapper

          Description: Project Online on new project response model.

 

Trigger OnNewResource

Summary: When a new resource is created

Description: Triggers a new flow when a new resource is created.

 

Syntax:

ProjectOnline.OnNewResource (string siteUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

 

Returns:

          Type:TriggerResourcesWrapper

          Description: Project Online on new resource response model.

 

Trigger OnNewTask

Summary: When a new task is created

Description: Triggers a flow when a new task is created.

 

Syntax:

ProjectOnline.OnNewTask (string siteUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

siteUrl

string(uri)

(Root Site URL)

Root site url of your project site (Example: https://sampletenant.sharepoint.com/teams/sampleteam ).

True

 

Returns:

          Type:TriggerTasksWrapper

          Description: Project online on new task response model

 


 

EnterpriseResource

Summary:

Description: Project Online Enterprise Resource Model

 

          Properties:

Name

Type

Summary

CanLevel

boolean

Can resource level

Can resource level

Code

string

Resource code

Resource code

CostAccrual

integer(int32)

Resource cost accrual

Resource cost accrual

CostCenter

string

Resource cost center

Resource cost center

Created

string(date-time)

Resource created time

Resource created time

DefaultBookingType

integer(int32)

Default booking type

Resource default booking type

Email

string

Email

Resource email address

ExternalId

string

External id

Resource external id

Group

string

Resource group

Group which resource belongs in

HireDate

string(date-time)

Hire date

Hired date of the resource

Id

string

Resource id

Resource id

Initials

string

Resouce initials

Resource initials

IsActive

boolean

Is resource active

Is resource active

IsBudget

boolean

Is budget

Is resource cost budgeted

IsCheckedOut

boolean

Is checked out

Is resource checked out

IsGeneric

boolean

Is generic

Is resource generic

IsTeam

boolean

Is team

Is resource part of the team

MaterialLabel

string

Material label

Resource material label

Modified

string(date-time)

Last modified

Time which the resource is last modified

Name

string

Resource name

Resource name

Phonetics

string

Resource phonetics

Phonetic pronunciation of the resource

ResourceType

integer(int32)

Resource type

Resource type

TerminationDate

string(date-time)

Termination date

Resource termination date


 

NewProject

Summary:

Description: New project online server project

 

          Properties:

Name

Type

Summary

Name

string

Project name

Name of the new project to create

Description

string

Project description

Description of the new project to create

Start

string(date-time)

Project start date

Start date of the new project


 

NewResource

Summary:

Description: A new project online server resource

 

          Properties:

Name

Type

Summary

Name

string

Resource name

The name of the new resource to create

IsBudget

boolean

Is resource in budget

Is resource accounted for in the budget

IsGeneric

boolean

Is resource generic

Is resource generic

IsInactive

boolean

Is resource inactive

Is resource inactive


 

NewTask

Summary:

Description: New project online server task

 

          Properties:

Name

Type

Summary

parameters

TaskParameters

 

New project online server task


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Project

Summary:

Description: Project Online Project Model

 

          Properties:

Name

Type

Summary

ApprovedStart

string(date-time)

Approved start date

Approved project start time

ApprovedEnd

string(date-time)

Approved end date

Approved project end time

CheckedOutDate

string(date-time)

Checked out date

Time which the project is checked out

CheckOutDescription

string

Checkout description

Description which the project is checked out with

CheckOutId

string

Checkout id

Id of the project checkout

CreatedDate

string(date-time)

Created date

Created date of the project

Id

string

Project id

Id of the project

IsCheckedOut

boolean

Is checked out

True if the project is currently checked out

ProjectLastPublishedDate

string(date-time)

Last published date

Last published date of the project

LastSavedDate

string(date-time)

Last saved date

Last date the project is saved

OptimizerDecision

integer(int32)

Optimizer decision

Project optimizer decision number

PlannerDecision

integer(int32)

Planner decision

Project planner decision number

ProjectType

integer(int32)

Project type

The type of the project

Name

string

Project name

The name of the project

ProjectIdentifier

string

Project identifier

Project identifier

WinprojVersion

string

Win proj version

Project version


 

ProjectsWrapper

Summary:

Description: Project online list projects response model

 

          Properties:

Name

Type

Summary

value

array of (Project)

Returned projects

The list of projects returned


 

Task

Summary:

Description: Project online server task

 

          Properties:

Name

Type

Summary

Created

string(date-time)

Task created date

The created date of the task

Modified

string(date-time)

Task last modified date

The last modified date of the task

Start

string(date-time)

Task start date

The start date of the task

Finish

string(date-time)

Task finish date

The finished date of the task

Name

string

Task name

The name of the task

Id

string

Task id

The id of the task

Priority

integer(int32)

Task priority

The priority level of the task

PercentComplete

integer(int32)

Task percent complete

Percent of task complete

Notes

string

Task notes

Description notes about the task

Contact

string

Task contact

Contact address for the task


 

TaskParameters

Summary:

Description: New project online server task

 

          Properties:

Name

Type

Summary

Name

string

Task name

Name of the new task to create

Notes

string

Task notes

Notes to put on the new task

Start

string(date-time)

Task start date

Start date of the task

Duration

string

Task duration

Duration of the task. For example (1h, 2d, or 3w)


 

TasksWrapper

Summary:

Description: Project online list tasks response model

 

          Properties:

Name

Type

Summary

value

array of (Task)

Returned projects

The list of tasks returned


 

TriggerProject

Summary:

Description: Project Online Project Model

 

          Properties:

Name

Type

Summary

ProjectStartDate

string(date-time)

Project Start Date

The datetime the approved project started.

ProjectFinishDate

string(date-time)

Project End Date

The datetime the approved project finished.

ProjectCreatedDate

string(date-time)

Created Date

The datetime the project was created.

ProjectId

string

Project Id

The unique Id of the project.

ProjectModifiedDate

string(date-time)

Last Modified Date

The datetime the project was last saved.

ProjectType

integer(int32)

Project Type

The type of the project.

ProjectName

string

Project Name

The name of the project.

ProjectLastPublishedDate

string(date-time)

Last Published Date

The datetime the project was last published.

ProjectOwnerName

string

Project Owner

The owner of the project.

ProjectPercentCompleted

integer(int32)

Project Percent Completed

The percentage completed of the project.

ProjectPercentWorkCompleted

integer(int32)

Project Percent Work Completed

The percentage of work completed of the project.

ProjectOvertimeCost

string

Project Overtime Cost

The overtime cost of the project.

ProjectOvertimeWork

string

Project Overtime Work

The overtime work of the project.


 

TriggerProjectsWrapper

Summary:

Description: Project Online on new project response model.

 

          Properties:

Name

Type

Summary

value

array of (TriggerProject)

Returned projects

The list of trigger projects returned.


 

TriggerResource

Summary:

Description: Resource Online resource model.

 

          Properties:

Name

Type

Summary

ResourceId

string

Resource Id

The unique Id of the resource.

ResourceBaseCalendar

string

Base Calendar

The base calendar type of the resource.

ResourceBookingType

integer(int32)

Resource booking type

Booking type of the resource

ResourceCanLevel

boolean

Can resource level

Can the resource level

ResourceCostPerUse

number(double)

Resource cost per use

Cost per use of the resource

ResourceCreatedDate

string(date-time)

Resource create date

Create date of the resource

ResourceEarliestAvailableFrom

string(date-time)

Resource earliest available from

Earliest availability date of the resource

ResourceEmail

string

Resource email

Email address of the resource

ResourceInitials

string

Resource initials

Initals of the resource

ResourceIsActive

boolean

Is resource activew

Is the new resource active

ResourceIsGeneric

boolean

Is resource generic

Is the new resource generic

ResourceLatestAvailableTo

string(date-time)

Resource latest available to

Lastest date for which the resource is available

ResourceModifiedDate

string(date-time)

Resource last modified date

Last modification date of the resource

ResourceName

string

Resource name

Name of the resource

ResourceStatsuName

string

Resource status name

Status name of the resource

ResourceType

integer(int32)

Resource type

Type of resource

TypeDescription

string

Resource type description

Description for the type of resource

TypeName

string

Resource type name

Type name of the resource


 

TriggerResourcesWrapper

Summary:

Description: Project Online on new resource response model.

 

          Properties:

Name

Type

Summary

value

array of (TriggerResource)

Returned resources

The list of trigger resources returned.


 

TriggerTask

Summary:

Description: Task Online Task Model

 

          Properties:

Name

Type

Summary

ProjectId

string

Project id

Id of the project which the task is created in

TaskId

string

Task id

Id of the new task

ProjectName

string

Project name

Name of the project which the task is created in

TaskName

string

Task name

Name of the new task

TaskCreatedDate

string(date-time)

Task created date

Created date of the new task

TaskModifieddate

string(date-time)

Task last modified date

Last modified date of the new task

TaskStartDate

string(date-time)

Task start date

Starting date of the new task

TaskFinishDate

string(date-time)

Task finish date

Finishing date of the new task

TaskPriority

integer(int32)

Task summary

Priority of the new task

TaskIsActive

boolean

Task is active

Whether the task is still active


 

TriggerTasksWrapper

Summary:

Description: Project online on new task response model

 

          Properties:

Name

Type

Summary

value

array of (TriggerTask)

Returned tasks

The list of trigger tasks returned