Skip to main content

Microsoft Project Component

Make queries to reporting data from a Project Web App instance

Component key: ms-project

Description#

Microsoft Project is a project management software product, developed and sold by Microsoft. This component allows you to interact with your projects, tasks, and assignments by making queries to reporting data from a Project Web App instance.

Authorization Notes#

The Microsoft Project component authenticates requests through a Microsoft Sharepoint Site. To configure an OAuth 2.0 credential you must first create an application through Active Directory in the Microsoft Azure portal. Ensure that you assign the correct scopes for Microsoft Project to your Active Directory application. You will also need to make sure to configure user permissions for your Project Web App. Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

  • For Client ID and Client Secret enter the values that you got from Azure Active Directory.
  • For Scopes and permission choose from the options found on the Azure Active Directory API scope configuration page.
  • For Authorization URL enter https://login.microsoftonline.com/common/oauth2/authorize
  • For Access Token URL enter https://login.microsoftonline.com/common/oauth2/v2.0/token

Actions#

Check In Draft Project#

Mark the status of an existing project to 'Checked In' | key: checkInDraftProject

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Checkout Project#

Mark an existing project's status as 'Checked Out' | key: checkoutProject

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Draft Assignment#

Create a new assignment in a given draft product | key: createDraftAssignment

InputKeyNotesExample

Finish Date

string
assignmentFinishDateProvide a valid date time value for the finish date of the assignment2021-11-04T20:29:49.305Z

Assignment Start Date

string
assignmentStartDateProvide a valid date time value for the start date of the assignment2021-11-04T20:29:49.305Z

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

Notes

string
notesProvide a string value for notes.These are example notes.

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Resource Id

string
resourceIdProvide the unique identifier for the resource 9840c3b6-ac3d-ec11-bea0-00155d788e0a

Task Id

string
/ Required
taskIdProvide a unique identifier for the task.9840c3b6-ac3d-ec11-bea0-00155d788e0a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Draft Project Resources#

Create a new Resource in an existing draft project | key: createDraftProjectResources

InputKeyNotesExample

Account

string
accountProvide the unique identifier of the account.36923632865023

Email

string
emailProvide a valid email address.someone@example.com

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

Notes

string
notesProvide a string value for notes.These are example notes.

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Name

string
resourceNameProvide a string value for the name of the resource.MyExampleFile.txt

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Draft Task#

Create a new task in a draft project | key: createDraftTask

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

Notes

string
notesProvide a string value for notes.These are example notes.

Parent Id

string
parentIdProvide the unique identifier of the parent object.9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Finish Date

string
taskFinishDateProvide a valid datetime value for the finish date of the task.2021-11-04T20:29:49.305Z

Task Name

string
/ Required
taskNameProvide a string value for the name of the task.Example Name

Task Start Date

string
taskStartDateProvide a valid datetime value for the start date of a task.2021-11-04T20:29:49.305Z

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Project#

Create a new project | key: createProject

InputKeyNotesExample

Project Description

string
/ Required
projectDescriptionProvide a string value for the description of the project.This is an example description.

Project Name

string
/ Required
projectNameProvide a string value for the name of the project. The name can NOT contain any special characters.MyExampleProject

Project Start Date

string
/ Required
projectStartDateProvide a valid datetime value for the start date of the project.2021-11-04T20:29:49.305Z

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Draft Task#

Delete an existing task from a draft project | key: deleteDraftTask

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Task Id

string
/ Required
taskIdProvide a unique identifier for the task.9840c3b6-ac3d-ec11-bea0-00155d788e0a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Project#

Delete the contents and metadata of an existing project by Id | key: deleteProject

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Assignment#

Get the information and metadata of an assignment by Id | key: getAssignments

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Draft Task#

Get the information or metadata of a task inside a draft project | key: getDraftTask

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Task Id

string
/ Required
taskIdProvide a unique identifier for the task.9840c3b6-ac3d-ec11-bea0-00155d788e0a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Project#

Get the information and metadata of a project by Id | key: getProject

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Project Resource#

Get the information and metadata of an existing Project Resource by Id | key: getProjectResources

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Resource Id

string
resourceIdProvide the unique identifier for the resource 9840c3b6-ac3d-ec11-bea0-00155d788e0a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Task#

Get the information and metadata of a task by Id | key: getTask

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Task Id

string
/ Required
taskIdProvide a unique identifier for the task.9840c3b6-ac3d-ec11-bea0-00155d788e0a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Assignments#

List all the assignments in a given project | key: listAssignments

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

When making queries against the Assignments in your project, it may be helpful to filter out results based on a value. For example, if you provide $filter = ResourceName eq 'ExampleCustomerName' to the Query String input, you can filter results for a particular customer.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Draft Assignments#

List all the assignments in a given draft project | key: listDraftAssignments

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


list Draft Project Resources#

List all resources in a draft project | key: listDraftProjectResources

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Draft Tasks#

List all tasks in a draft project | key: listDraftTasks

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


list Project Resources#

List all resources in an existing project | key: listProjectResources

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Projects#

List all the projects in a given sharepoint site | key: listProjects

InputKeyNotesExample

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Query String

string
queryStringProvide a string value to query for a specific property.$select=ProjectId

For a Project Web App instance that contains a large number of entities, such as projects, assignments, or tasks, you should limit the data returned using the QueryString input. If you don't limit the data returned, the query can exceed the default limits and affect server performance, which may result in a failed execution. Unlike other Microsoft products, the Project Data service does not implement the $links query option or the $expand query option.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": [    {      "odata.type": "PS.PublishedProject"    }  ]}

List Tasks#

List all the tasks in a given project | key: listTasks

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Publish Draft Project#

Publish the draft of an existing project | key: publishDraftProject

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Remove Project#

Remove the contents and metadata of an existing project by Id | key: removeProject

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Submit Product To Workflow#

Submit an existing project to a given workflow | key: submitProject

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Draft#

Update the draft of an existing project | key: updateDraft

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Verify Draft#

Verify the draft of an existing project | key: verifyDraft

InputKeyNotesExample

Project GUID

string
/ Required
guIdProvide a string value for the GUID9840c3b6-ac3d-ec11-bea0-00155d788e0a

PWA Site

string
/ Required
pwaSiteProvide a valid Sharepoint URL.example.sharepoint.com/sites/pwa

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri