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>13a3f168-700e-46ce-acd7-c8ed1bb4f140</ID>
  <AncestorID>f85e9d97-5fa4-417d-a50a-2a15de0fd3f4</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>2dcaa600-1746-4af6-bcad-12316db4f874</SiteID>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2025-02-04T13:44:02.6223459+00:00</Created>
  <CreatedBy>dc677c1a-82fe-40b6-9581-82c5659b67f2</CreatedBy>
  <Updated>2025-02-04T13:44:02.6223459+00:00</Updated>
  <UpdatedBy>715ab6f1-8e37-484c-8892-ce60917cde12</UpdatedBy>
</ListItem>

application/json, text/json

Sample

{
  "ID": "13a3f168-700e-46ce-acd7-c8ed1bb4f140",
  "AncestorID": "f85e9d97-5fa4-417d-a50a-2a15de0fd3f4",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "2dcaa600-1746-4af6-bcad-12316db4f874",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2025-02-04T13:44:02.6223459+00:00",
  "CreatedBy": "dc677c1a-82fe-40b6-9581-82c5659b67f2",
  "Updated": "2025-02-04T13:44:02.6223459+00:00",
  "UpdatedBy": "715ab6f1-8e37-484c-8892-ce60917cde12"
}