Back

PUT supervisoryscopes/{id}

Update a supervisory scope.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id globally unique identifier Required

Guid ID of the Supervisory Scope to be updated.

Body Parameters (ListItem)

This object takes all the parameters needed to update a supervisory scope.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID 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).
Rank 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)
Description 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.
Deleted 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.
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.
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.

Request Formats

application/xml, text/xml

Sample
<ListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>d9fc070c-2e39-41fa-b78a-72dbb4335505</ID>
  <AncestorID>7cbe3dd6-4bd7-4998-b19e-49d73cab1f3c</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</ListItem>

application/json, text/json

Sample
{
  "ID": "d9fc070c-2e39-41fa-b78a-72dbb4335505",
  "AncestorID": "7cbe3dd6-4bd7-4998-b19e-49d73cab1f3c",
  "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
ID 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).
Rank 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)
Description 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.
Deleted 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.
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.
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.

Response Formats

application/xml, text/xml

Sample
<ListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>8b03a431-9006-43f3-b770-1e355dee344f</ID>
  <AncestorID>f1b2dbb3-bbe3-4388-929e-a93a9f19d628</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>0706446e-b81e-4347-94d4-e718c8a41684</SiteID>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2024-10-24T08:24:21.5820355+00:00</Created>
  <CreatedBy>dd60a694-a0d7-4ed8-ba84-bf40831d7949</CreatedBy>
  <Updated>2024-10-24T08:24:21.5820355+00:00</Updated>
  <UpdatedBy>f7871c08-dcea-4c41-a149-abb9aa35e0df</UpdatedBy>
</ListItem>

application/json, text/json

Sample
{
  "ID": "8b03a431-9006-43f3-b770-1e355dee344f",
  "AncestorID": "f1b2dbb3-bbe3-4388-929e-a93a9f19d628",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "0706446e-b81e-4347-94d4-e718c8a41684",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2024-10-24T08:24:21.5820355+00:00",
  "CreatedBy": "dd60a694-a0d7-4ed8-ba84-bf40831d7949",
  "Updated": "2024-10-24T08:24:21.5820355+00:00",
  "UpdatedBy": "f7871c08-dcea-4c41-a149-abb9aa35e0df"
}