GET 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 read.	`globally unique identifier` Required Guid ID of the project scope to be read.

Body Parameters

None.

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>f8d0c23a-2f0c-4923-b8e8-d0db3306039d</ID>
  <AncestorID>e2e407bd-57b7-4b4a-8e89-5fff1d324344</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>69f1a70c-6234-4590-a597-856f95329d6f</SiteID>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2022-06-05T07:34:36.4909586+00:00</Created>
  <CreatedBy>023dd79e-1df8-40f1-ab90-23f9bd42aa2c</CreatedBy>
  <Updated>2022-06-05T07:34:36.4909586+00:00</Updated>
  <UpdatedBy>a7125ec0-2e33-47b6-b8c5-1c465f7839a0</UpdatedBy>
</ListItem>

application/json, text/json

Sample

{
  "ID": "f8d0c23a-2f0c-4923-b8e8-d0db3306039d",
  "AncestorID": "e2e407bd-57b7-4b4a-8e89-5fff1d324344",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "69f1a70c-6234-4590-a597-856f95329d6f",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2022-06-05T07:34:36.4909586+00:00",
  "CreatedBy": "023dd79e-1df8-40f1-ab90-23f9bd42aa2c",
  "Updated": "2022-06-05T07:34:36.4909586+00:00",
  "UpdatedBy": "a7125ec0-2e33-47b6-b8c5-1c465f7839a0"
}