POST supervisoryscopes

Request Information

URI Parameters

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

None.

Body Parameters (ListItem)

This object takes all the parameters needed to create a new supervisory 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>cc90dc83-e32e-44ad-b323-fff865b9ce1c</ID>
  <AncestorID>1532dbe7-9933-4c51-9f3c-3d03e60d4e5d</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</ListItem>

application/json, text/json

Sample

{
  "ID": "cc90dc83-e32e-44ad-b323-fff865b9ce1c",
  "AncestorID": "1532dbe7-9933-4c51-9f3c-3d03e60d4e5d",
  "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>99039740-a34b-4006-b66b-9166fa17fb79</ID>
  <AncestorID>0a01f8a5-bc0f-4dc8-93a1-0b7a47469a47</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>e2651887-ebef-4268-8a60-6e8e5629fe61</SiteID>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2026-10-02T16:08:50.1146135+00:00</Created>
  <CreatedBy>83e42566-4c41-47a3-ad20-afbf71ef327a</CreatedBy>
  <Updated>2026-10-02T16:08:50.1146135+00:00</Updated>
  <UpdatedBy>bba88e28-9ee2-4c08-9a70-ec4ed324fd1c</UpdatedBy>
</ListItem>

application/json, text/json

Sample

{
  "ID": "99039740-a34b-4006-b66b-9166fa17fb79",
  "AncestorID": "0a01f8a5-bc0f-4dc8-93a1-0b7a47469a47",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "e2651887-ebef-4268-8a60-6e8e5629fe61",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2026-10-02T16:08:50.1146135+00:00",
  "CreatedBy": "83e42566-4c41-47a3-ad20-afbf71ef327a",
  "Updated": "2026-10-02T16:08:50.1146135+00:00",
  "UpdatedBy": "bba88e28-9ee2-4c08-9a70-ec4ed324fd1c"
}