PUT projectScopes/{id}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
id `globally unique identifier` Required Guid ID of the project scope to be updated.	`globally unique identifier` Required Guid ID of the project scope to be updated.

Body Parameters (ListItem)

This object takes all the parameters needed to update an project scope.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `globally unique identifier` Required on Update ID of the accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` Required on Update ID of the accountability, evaluation criteria, project scope, or supervisory scope.
AncestorID `globally unique identifier` Required on Create ID of the ancestor given accountability, evaluation criteria, project scope, or supervisory scope (individual or project).	`globally unique identifier` Required on Create ID of the ancestor given accountability, evaluation criteria, project scope, or supervisory scope (individual or project).
Rank `integer` Required Rank of the given accountability, evaluation criteria, project scope, or supervisory scope.	`integer` Required Rank of the given accountability, evaluation criteria, project scope, or supervisory scope.
Name `string` Required Name of the given accountability, evaluation criteria, project scope, or supervisory scope. (Max length 255 characters)	`string` Required Name of the given accountability, evaluation criteria, project scope, or supervisory scope. (Max length 255 characters)
Description `string` Required Description of the given accountability, evaluation criteria, project scope, or supervisory scope.	`string` Required Description of the given accountability, evaluation criteria, project scope, or supervisory scope.
SiteID `globally unique identifier` ReadOnly ID of the site for the given accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` ReadOnly ID of the site for the given accountability, evaluation criteria, project scope, or supervisory scope.
Deleted `boolean` ReadOnly Deleted status of the given accountability, evaluation criteria, project scope, or supervisory scope.	`boolean` ReadOnly Deleted status of the given accountability, evaluation criteria, project scope, or supervisory scope.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the given accountability, evaluation criteria, project scope, or supervisory scope.	`boolean` ReadOnly Deleted by reference status of the given accountability, evaluation criteria, project scope, or supervisory scope.
Created `date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was created.	`date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was created.
CreatedBy `globally unique identifier` ReadOnly ID of the individual who created the given accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` ReadOnly ID of the individual who created the given accountability, evaluation criteria, project scope, or supervisory scope.
Updated `date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was updated.	`date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the individual who updated the given accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` ReadOnly ID of the individual who updated the given accountability, evaluation criteria, project scope, or supervisory scope.

Request Formats

application/xml, text/xml

Sample

<ListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>b9e640bd-778e-4237-891a-25c02407f15a</ID>
  <AncestorID>9a158120-ca52-44a3-81c6-2c379ed707a3</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</ListItem>

application/json, text/json

Sample

{
  "ID": "b9e640bd-778e-4237-891a-25c02407f15a",
  "AncestorID": "9a158120-ca52-44a3-81c6-2c379ed707a3",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2"
}

Response Information

Resource Description (ListItem)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `globally unique identifier` Required on Update ID of the accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` Required on Update ID of the accountability, evaluation criteria, project scope, or supervisory scope.
AncestorID `globally unique identifier` Required on Create ID of the ancestor given accountability, evaluation criteria, project scope, or supervisory scope (individual or project).	`globally unique identifier` Required on Create ID of the ancestor given accountability, evaluation criteria, project scope, or supervisory scope (individual or project).
Rank `integer` Required Rank of the given accountability, evaluation criteria, project scope, or supervisory scope.	`integer` Required Rank of the given accountability, evaluation criteria, project scope, or supervisory scope.
Name `string` Required Name of the given accountability, evaluation criteria, project scope, or supervisory scope. (Max length 255 characters)	`string` Required Name of the given accountability, evaluation criteria, project scope, or supervisory scope. (Max length 255 characters)
Description `string` Required Description of the given accountability, evaluation criteria, project scope, or supervisory scope.	`string` Required Description of the given accountability, evaluation criteria, project scope, or supervisory scope.
SiteID `globally unique identifier` ReadOnly ID of the site for the given accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` ReadOnly ID of the site for the given accountability, evaluation criteria, project scope, or supervisory scope.
Deleted `boolean` ReadOnly Deleted status of the given accountability, evaluation criteria, project scope, or supervisory scope.	`boolean` ReadOnly Deleted status of the given accountability, evaluation criteria, project scope, or supervisory scope.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the given accountability, evaluation criteria, project scope, or supervisory scope.	`boolean` ReadOnly Deleted by reference status of the given accountability, evaluation criteria, project scope, or supervisory scope.
Created `date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was created.	`date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was created.
CreatedBy `globally unique identifier` ReadOnly ID of the individual who created the given accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` ReadOnly ID of the individual who created the given accountability, evaluation criteria, project scope, or supervisory scope.
Updated `date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was updated.	`date` ReadOnly The date that the given accountability, evaluation criteria, project scope, or supervisory scope was updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the individual who updated the given accountability, evaluation criteria, project scope, or supervisory scope.	`globally unique identifier` ReadOnly ID of the individual who updated the given accountability, evaluation criteria, project scope, or supervisory scope.

Response Formats

application/xml, text/xml

Sample

<ListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>35897201-4b5d-42cc-a4b1-c7a3e09f1be4</ID>
  <AncestorID>d4c59bcb-c8af-4840-90b0-8c9a7a2cd70c</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>9a4a85e5-a764-4e1b-ae82-87c1aaf55ba6</SiteID>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2025-06-20T07:01:12.628027+00:00</Created>
  <CreatedBy>13a6f4d4-1f76-4513-8e2b-7807f7cad3ea</CreatedBy>
  <Updated>2025-06-20T07:01:12.628027+00:00</Updated>
  <UpdatedBy>35fefdb0-3a4a-4a42-a589-effcf31f7516</UpdatedBy>
</ListItem>

application/json, text/json

Sample

{
  "ID": "35897201-4b5d-42cc-a4b1-c7a3e09f1be4",
  "AncestorID": "d4c59bcb-c8af-4840-90b0-8c9a7a2cd70c",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "9a4a85e5-a764-4e1b-ae82-87c1aaf55ba6",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2025-06-20T07:01:12.628027+00:00",
  "CreatedBy": "13a6f4d4-1f76-4513-8e2b-7807f7cad3ea",
  "Updated": "2025-06-20T07:01:12.628027+00:00",
  "UpdatedBy": "35fefdb0-3a4a-4a42-a589-effcf31f7516"
}