Set-Project

Prev Next

Summary

Updates an existing project.

Set-Project
    -Entry

Returns a project object.

Parameters

Parameter

Type

Required?

Notes

Entry

Project Object

Yes


Examples

Update an existing project

Change a project type to Draft

# Retrieve an existing project
$project = Get-Project -Id 2023110000001

# Change the type to 2 ("Draft")
# Project types:
# --------------------------
#   1 = Normal
#   2 = Draft
#   3 = Template
# --------------------------
$project.ProjectTypeId = 2

# Save changes
$project = Set-Project -Entry $project

# Output some information to help indicate that the project was created
Write-Output "Updated project '$($project.Description)' (Id: #$($project.ProjectId), Type: $($project.ProjectTypeName), Status: $($project.Status))"

# For debug purposes, convert the project to output as JSON so we can see the available fields
$jsonOutput = $project | ConvertTo-Json -Depth 10

Write-Output ""
Write-Output "JSON Results:"

# Output the JSON results
Write-Output $jsonOutput

Execution results:

Updated project 'Process Data' (Id: #2023110000001, Type: Draft, Status: Closed)

JSON Results:
{
  "ProjectId": 2023110000001,
  "ProjectTypeId": 2,
  "ProjectTypeName": "Draft",
  "ProjectTypeDescription": "A special type of project that facilitates editing projects and tasks outside of the normal project pool. Can be converted to a normal project.",
  "ProjectSourceTypeId": 2,
  "ProjectSourceTypeName": "Agility Blue",
  "MatterId": 39,
  "Matter": null,
  "MatterName": "AGM Widget Corp. vs. MGM Manufacturing Inc.",
  "MatterReference": "1024-0002",
  "ClientId": 29,
  "Client": null,
  "ClientName": "AGM Widget Corporation",
  "ClientReference": "1024",
  "ContactId": null,
  "Contact": null,
  "ContactFullName": null,
  "PricingAgreementOptionId": 1,
  "PricingAgreementOptionName": "Standard Pricing",
  "OwnedById": "25a34a2f-e3d8-4690-88f5-6b399cf88c4c",
  "OwnedBy": null,
  "OwnedByFullName": "Sarah Cooper",
  "Priority": "Normal",
  "DateReceived": "2023-11-02T12:04:29.81+00:00",
  "DateDue": null,
  "DateInvoiced": null,
  "NumberOfTasks": 2,
  "NumberOfUnassignedTasks": 0,
  "NumberOfBillingEntries": 0,
  "NumberOfVolumes": 0,
  "NumberOfMediaLogEntries": 0,
  "TotalWeight": 10,
  "CurrentWeight": 10,
  "Status": "Closed",
  "Description": "Process Data",
  "Assignees": "Sarah Cooper, Max Miller",
  "IsApproved": false,
  "IsLate": false,
  "IsCompleted": true,
  "IsCanceled": false,
  "EmailNotificationsEnabled": true,
  "CompletedOn": "2023-11-02T12:06:23.4471242+00:00",
  "Tags": [],
  "ComputedTags": "Processing",
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2023-11-02T12:04:51.0083228+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2026-01-19T16:11:41.3864775+00:00",
  "LastUpdatedBy": null,
  "Settings": null
}