GET projects/{projectid}/projectscopes?deleted={deleted}

Request Information

URI Parameters

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

Name	Description
projectid `globally unique identifier` Required Guid ID of the project for which the project scope is to be read.	`globally unique identifier` Required Guid ID of the project for which the project scope is to be read.
deleted `byte` Add ?deleted=0, 1, or 2 for not deleted, deleted, or all.	`byte` Add ?deleted=0, 1, or 2 for not deleted, deleted, or all.

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>c588b1e7-bda4-4b9b-8b23-358fe9716871</ID>
  <AncestorID>1a897cb7-c180-4a5e-bace-2ec64645bbb1</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>89fdd5ec-9807-4a0e-8ada-bd52c47c33a6</SiteID>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2022-06-05T00:42:16.7965121+00:00</Created>
  <CreatedBy>2f93827c-04c3-4a7c-916e-50486520d566</CreatedBy>
  <Updated>2022-06-05T00:42:16.7965121+00:00</Updated>
  <UpdatedBy>95a895f5-1b9f-4d85-92ee-138039ecf5d8</UpdatedBy>
</ListItem>

application/json, text/json

Sample

{
  "ID": "c588b1e7-bda4-4b9b-8b23-358fe9716871",
  "AncestorID": "1a897cb7-c180-4a5e-bace-2ec64645bbb1",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "89fdd5ec-9807-4a0e-8ada-bd52c47c33a6",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2022-06-05T00:42:16.7965121+00:00",
  "CreatedBy": "2f93827c-04c3-4a7c-916e-50486520d566",
  "Updated": "2022-06-05T00:42:16.7965121+00:00",
  "UpdatedBy": "95a895f5-1b9f-4d85-92ee-138039ecf5d8"
}