Update a department.
|
id
globally unique identifier
Required
Guid ID of the organization or department to be updated. |
This object takes all the parameters needed to update a department.
System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList|
ID
globally unique identifier
Required on Update
ID of the given organization/department. |
|
SiteID
globally unique identifier
ID of the site for the given organization/department. |
|
ParentID
globally unique identifier
ID of the parent for the given organization/department. This will be a site ID for a given organization or an organization ID for a given department. |
|
Rank
integer
Required
Rank of the given organization/department. |
|
Name
string
Required
Name of the given organization/department. (Max length 100 characters) |
|
EmotionalGoal
string
Emotional Goal of the given organization/department. (Max length 1000 characters) |
|
Focus
string
Focus of the given organization/department. |
|
Picture
Collection of byte
Picture of the given organization/department. |
|
RowType
integer
ReadOnly
RowType of the given organization(4) or department(56). |
|
RankPath
Collection of byte
ReadOnly
Current rank of the given Organization/Department in a byte array. |
|
RankOrder
string
ReadOnly
Rank in string format, (0001.0001.0001) for the given organization/department. |
|
DisplayRank
string
ReadOnly
Rank that is actually displayed. |
|
Level
integer
ReadOnly
Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3 |
|
Values
string
ReadOnly
Value of the given organization/department. |
|
Deleted
boolean
ReadOnly
Deleted status of the given organization/department. |
|
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the given organization/department. |
|
Created
date
ReadOnly
Date the given organization/department was created. |
|
CreatedBy
globally unique identifier
ReadOnly
ID of the individual who created the given organization/department. |
|
Updated
date
ReadOnly
The date that the given organization/department was last updated. |
|
UpdatedBy
globally unique identifier
ReadOnly
The ID of the individual that updated the given organization/department. |
|
LastComment
string
ReadOnly
Body of the most recent comment. |
|
LastCommentDate
date
ReadOnly
Date the most recent comment was posted. |
|
LastCommentByID
globally unique identifier
ReadOnly
ID of the user who posted the most recent comment. |
|
LastCommentBy
string
ReadOnly
Name of the user who posted the most recent comment. |
|
ParentName
string
ReadOnly
Name of the parent for the given Organization/Department. This will be a site for a given organization or an organization for a given department. |
|
CanRead
boolean
ReadOnly
Read security setting for the object based on the current logged in user. |
|
CanUpdate
boolean
ReadOnly
Update security setting for the object based on the current logged in user. |
|
CanDelete
boolean
ReadOnly
Delete security setting for the object based on the current logged in user. |
|
CanDelegate
boolean
ReadOnly
Delegate security setting for the object based on the current logged in user. |
<Organization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>4a5e6971-e984-4ddd-8c08-5b479d980df7</ID> <SiteID>454df862-7068-4331-b248-32f18f86cc28</SiteID> <ParentID>ad33b785-b1ed-4074-a759-eb2eb9ce120c</ParentID> <Rank>1</Rank> <Name>sample string 1</Name> <EmotionalGoal>sample string 2</EmotionalGoal> <Focus>sample string 3</Focus> <Picture>QEA=</Picture> </Organization>
{
"ID": "4a5e6971-e984-4ddd-8c08-5b479d980df7",
"SiteID": "454df862-7068-4331-b248-32f18f86cc28",
"ParentID": "ad33b785-b1ed-4074-a759-eb2eb9ce120c",
"Rank": 1,
"Name": "sample string 1",
"EmotionalGoal": "sample string 2",
"Focus": "sample string 3",
"Picture": "QEA="
}
|
ID
globally unique identifier
Required on Update
ID of the given organization/department. |
|
SiteID
globally unique identifier
ID of the site for the given organization/department. |
|
ParentID
globally unique identifier
ID of the parent for the given organization/department. This will be a site ID for a given organization or an organization ID for a given department. |
|
Rank
integer
Required
Rank of the given organization/department. |
|
Name
string
Required
Name of the given organization/department. (Max length 100 characters) |
|
EmotionalGoal
string
Emotional Goal of the given organization/department. (Max length 1000 characters) |
|
Focus
string
Focus of the given organization/department. |
|
Picture
Collection of byte
Picture of the given organization/department. |
|
RowType
integer
ReadOnly
RowType of the given organization(4) or department(56). |
|
RankPath
Collection of byte
ReadOnly
Current rank of the given Organization/Department in a byte array. |
|
RankOrder
string
ReadOnly
Rank in string format, (0001.0001.0001) for the given organization/department. |
|
DisplayRank
string
ReadOnly
Rank that is actually displayed. |
|
Level
integer
ReadOnly
Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3 |
|
Values
string
ReadOnly
Value of the given organization/department. |
|
Deleted
boolean
ReadOnly
Deleted status of the given organization/department. |
|
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the given organization/department. |
|
Created
date
ReadOnly
Date the given organization/department was created. |
|
CreatedBy
globally unique identifier
ReadOnly
ID of the individual who created the given organization/department. |
|
Updated
date
ReadOnly
The date that the given organization/department was last updated. |
|
UpdatedBy
globally unique identifier
ReadOnly
The ID of the individual that updated the given organization/department. |
|
LastComment
string
ReadOnly
Body of the most recent comment. |
|
LastCommentDate
date
ReadOnly
Date the most recent comment was posted. |
|
LastCommentByID
globally unique identifier
ReadOnly
ID of the user who posted the most recent comment. |
|
LastCommentBy
string
ReadOnly
Name of the user who posted the most recent comment. |
|
ParentName
string
ReadOnly
Name of the parent for the given Organization/Department. This will be a site for a given organization or an organization for a given department. |
|
CanRead
boolean
ReadOnly
Read security setting for the object based on the current logged in user. |
|
CanUpdate
boolean
ReadOnly
Update security setting for the object based on the current logged in user. |
|
CanDelete
boolean
ReadOnly
Delete security setting for the object based on the current logged in user. |
|
CanDelegate
boolean
ReadOnly
Delegate security setting for the object based on the current logged in user. |
<Organization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
<ID>080e5ef6-9918-47a3-9041-e96c5776518c</ID>
<SiteID>d30410c5-128d-4d87-9ebf-2890158f756d</SiteID>
<ParentID>3827e8c5-7ac5-43a6-9a29-db0dd3b9bf14</ParentID>
<Rank>1</Rank>
<Name>sample string 1</Name>
<EmotionalGoal>sample string 2</EmotionalGoal>
<Focus>sample string 3</Focus>
<Picture>QEA=</Picture>
<RowType>1</RowType>
<RankPath>QEA=</RankPath>
<RankOrder>sample string 4</RankOrder>
<DisplayRank>sample string 5</DisplayRank>
<Level>1</Level>
<Values>sample string 6</Values>
<Deleted>true</Deleted>
<DeletedByRef>true</DeletedByRef>
<Created>2026-08-10T04:17:27.5907875+00:00</Created>
<CreatedBy>1b5688e9-597e-45ab-a544-7b741fb921f7</CreatedBy>
<Updated>2026-08-10T04:17:27.5907875+00:00</Updated>
<UpdatedBy>dbd2ab34-67cb-49b4-ad2c-a2320f5deacf</UpdatedBy>
<LastComment>sample string 7</LastComment>
<LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-08-10T04:17:27.5907875Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</LastCommentDate>
<LastCommentByID>0a900c6a-fb43-4e9e-a74f-ad50edc411ed</LastCommentByID>
<LastCommentBy>sample string 8</LastCommentBy>
<ParentName>sample string 9</ParentName>
<CanRead>true</CanRead>
<CanUpdate>true</CanUpdate>
<CanDelete>true</CanDelete>
<CanDelegate>true</CanDelegate>
</Organization>
{
"ID": "080e5ef6-9918-47a3-9041-e96c5776518c",
"SiteID": "d30410c5-128d-4d87-9ebf-2890158f756d",
"ParentID": "3827e8c5-7ac5-43a6-9a29-db0dd3b9bf14",
"Rank": 1,
"Name": "sample string 1",
"EmotionalGoal": "sample string 2",
"Focus": "sample string 3",
"Picture": "QEA=",
"RowType": 1,
"RankPath": "QEA=",
"RankOrder": "sample string 4",
"DisplayRank": "sample string 5",
"Level": 1,
"Values": "sample string 6",
"Deleted": true,
"DeletedByRef": true,
"Created": "2026-08-10T04:17:27.5907875+00:00",
"CreatedBy": "1b5688e9-597e-45ab-a544-7b741fb921f7",
"Updated": "2026-08-10T04:17:27.5907875+00:00",
"UpdatedBy": "dbd2ab34-67cb-49b4-ad2c-a2320f5deacf",
"LastComment": "sample string 7",
"LastCommentDate": "2026-08-10T04:17:27.5907875+00:00",
"LastCommentByID": "0a900c6a-fb43-4e9e-a74f-ad50edc411ed",
"LastCommentBy": "sample string 8",
"ParentName": "sample string 9",
"CanRead": true,
"CanUpdate": true,
"CanDelete": true,
"CanDelegate": true
}