Skip to main content

Microsoft Project Connector

Microsoft Project Make queries to reporting data from a Project Web App instance

Connections

OAuth 2.0

OAuth 2.0 Connectivity for Microsoft Project

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for Microsoft Projecthttps://login.microsoftonline.com/common/oauth2/authorize
Token URLThe OAuth 2.0 Token URL for Microsoft Project; replace <pwaSite> with the protocol and domain of the PWA Site. Example: https://example.sharepoint.com
Client IDThis value is obtained by creating a new app in Active Directory with the same tenant as your user with a Microsoft Project license
Client SecretThis value can be generated inside your Active Directory application.
PWA SiteThe Project Web App Sharepoint Site domain. This is the same value that is supplied for the resource argument of the Token URL.

Actions

Check In Draft Project

Mark the status of an existing project to 'Checked In'

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Checkout Project

Mark an existing project's status as 'Checked Out'

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Create Draft Assignment

Create a new assignment in a given draft product

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Task IdProvide a unique identifier for the task.
Resource IdProvide the unique identifier for the resource
Assignment Start DateProvide a valid date time value for the start date of the assignment
Finish DateProvide a valid date time value for the finish date of the assignment
NotesProvide a string value for notes.

Create Draft Project Resources

Create a new Resource in an existing draft project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
NotesProvide a string value for notes.
EmailProvide a valid email address.
AccountProvide the unique identifier of the account.
NameProvide a string value for the name of the resource.

Create Draft Task

Create a new task in a draft project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Task NameProvide a string value for the name of the task.
NotesProvide a string value for notes.
Task Start DateProvide a valid datetime value for the start date of a task.
Parent IdProvide the unique identifier of the parent object.
Finish DateProvide a valid datetime value for the finish date of the task.

Create Project

Create a new project

InputCommentsDefault
Connection
Project NameProvide a string value for the name of the project. The name can NOT contain any special characters.
Project DescriptionProvide a string value for the description of the project.
Project Start DateProvide a valid datetime value for the start date of the project.

Delete Draft Task

Delete an existing task from a draft project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Task IdProvide a unique identifier for the task.

Delete Project

Delete the contents and metadata of an existing project by Id

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Get Assignment

Get the information and metadata of an assignment by Id

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Get Draft Task

Get the information or metadata of a task inside a draft project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Task IdProvide a unique identifier for the task.

Get Project

Get the information and metadata of a project by Id

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Get Project Resource

Get the information and metadata of an existing Project Resource by Id

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Resource IdProvide the unique identifier for the resource

Get Task

Get the information and metadata of a task by Id

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Task IdProvide a unique identifier for the task.

List Assignments

List all the assignments in a given project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Page SizeProvide an integer value for the maximum results returned per page when paginating results.
Page NumberProvide an integer value for which page to return when paginating results.

List Draft Assignments

List all the assignments in a given draft project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

list Draft Project Resources

List all resources in a draft project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Page SizeProvide an integer value for the maximum results returned per page when paginating results.
Page NumberProvide an integer value for which page to return when paginating results.

List Draft Tasks

List all tasks in a draft project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Page SizeProvide an integer value for the maximum results returned per page when paginating results.
Page NumberProvide an integer value for which page to return when paginating results.

list Project Resources

List all resources in an existing project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

List Projects

List all the projects in a given sharepoint site

InputCommentsDefault
Connection
Query StringProvide a string value to query for a specific property.
Page SizeProvide an integer value for the maximum results returned per page when paginating results.
Page NumberProvide an integer value for which page to return when paginating results.

List Tasks

List all the tasks in a given project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID
Page SizeProvide an integer value for the maximum results returned per page when paginating results.
Page NumberProvide an integer value for which page to return when paginating results.

Publish Draft Project

Publish the draft of an existing project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Raw Request

Send raw HTTP request to Microsoft Project

InputCommentsDefault
Connection
URLInput the path only (/ProjectServer/Projects(guid'9840c3b6-ac3d-ec11-bea0-00155d788e0a')), The base URL is already included ({pwaSite}/sites/pwa/_api). For example, to connect to {pwaSite}/sites/pwa/_api/ProjectServer/Projects(guid'9840c3b6-ac3d-ec11-bea0-00155d788e0a'), only /ProjectServer/Projects(guid'9840c3b6-ac3d-ec11-bea0-00155d788e0a') is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Remove Project

Remove the contents and metadata of an existing project by Id

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Submit Product To Workflow

Submit an existing project to a given workflow

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Update Draft

Update the draft of an existing project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID

Verify Draft

Verify the draft of an existing project

InputCommentsDefault
Connection
Project GUIDProvide a string value for the GUID