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>ffe60a9a-fc65-490a-912f-7b9995ee0b45</ID>
  <AncestorID>66e3b86c-0dbd-4fdb-9ec2-66e51c2451a7</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</ListItem>

application/json, text/json

Sample

{
  "ID": "ffe60a9a-fc65-490a-912f-7b9995ee0b45",
  "AncestorID": "66e3b86c-0dbd-4fdb-9ec2-66e51c2451a7",
  "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>f628f4ac-682c-4679-a3f1-faf6f766cfca</ID>
  <AncestorID>e433df58-eb95-49c3-9f2e-307890692048</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>bd24d14c-39e6-4160-96f3-d961767831ae</SiteID>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2021-11-03T19:04:19.4313637+00:00</Created>
  <CreatedBy>4f1d8af7-f25a-44b5-8a26-323169bf5079</CreatedBy>
  <Updated>2021-11-03T19:04:19.4313637+00:00</Updated>
  <UpdatedBy>3556dd91-cabd-49cb-8826-2729ec538eb2</UpdatedBy>
</ListItem>

application/json, text/json

Sample

{
  "ID": "f628f4ac-682c-4679-a3f1-faf6f766cfca",
  "AncestorID": "e433df58-eb95-49c3-9f2e-307890692048",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "bd24d14c-39e6-4160-96f3-d961767831ae",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2021-11-03T19:04:19.4313637+00:00",
  "CreatedBy": "4f1d8af7-f25a-44b5-8a26-323169bf5079",
  "Updated": "2021-11-03T19:04:19.4313637+00:00",
  "UpdatedBy": "3556dd91-cabd-49cb-8826-2729ec538eb2"
}