Update an individual's basic role.
id
globally unique identifier
Required
Guid ID of the basic role to be updated. |
This object takes all the parameters needed to update a basic role.
System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID
globally unique identifier
Required on Update
ID of the given basic role. |
IndividualID
globally unique identifier
ID of the individual who is linked to the given basic role. (If null on create this will default to the currently logged in user.) |
Name
string
Required
Name of the given basic role. (Max length 255 characters) |
Rank
integer
Rank of the given basic role. |
Description
string
Description of the given basic role. |
PercentTime
byte
Percent of time that should be devoted to the given basic role. |
Created
date
ReadOnly
Date the given basic role was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the individual that created the given basic role. |
Updated
date
ReadOnly
Date the given basic role was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the individual that last updated the given basic role. |
PerformanceIndicators
string
ReadOnly
Performance indicators that are linked to the given basic role. |
Deleted
boolean
ReadOnly
Deleted status of the given basic role. |
DeletedByRef
boolean
ReadOnly
Deleted by Reference status of the given basic role. |
<BasicRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>d0238931-b7b4-41f6-8fcc-6dc56f11ae69</ID> <IndividualID>0138e8e0-78b1-4a1e-9290-3299d0738332</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> </BasicRole>
{ "ID": "d0238931-b7b4-41f6-8fcc-6dc56f11ae69", "IndividualID": "0138e8e0-78b1-4a1e-9290-3299d0738332", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64 }
ID
globally unique identifier
Required on Update
ID of the given basic role. |
IndividualID
globally unique identifier
ID of the individual who is linked to the given basic role. (If null on create this will default to the currently logged in user.) |
Name
string
Required
Name of the given basic role. (Max length 255 characters) |
Rank
integer
Rank of the given basic role. |
Description
string
Description of the given basic role. |
PercentTime
byte
Percent of time that should be devoted to the given basic role. |
Created
date
ReadOnly
Date the given basic role was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the individual that created the given basic role. |
Updated
date
ReadOnly
Date the given basic role was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the individual that last updated the given basic role. |
PerformanceIndicators
string
ReadOnly
Performance indicators that are linked to the given basic role. |
Deleted
boolean
ReadOnly
Deleted status of the given basic role. |
DeletedByRef
boolean
ReadOnly
Deleted by Reference status of the given basic role. |
<BasicRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>25769aed-dee2-46e6-a38b-40f4e568a9eb</ID> <IndividualID>66e97164-3a63-4f5e-9df7-d37004b7ad3d</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2025-10-01T11:30:02.3047303+00:00</Created> <CreatedBy>ebc679b2-f89a-48cd-b529-bb4a86b8d763</CreatedBy> <Updated>2025-10-01T11:30:02.3047303+00:00</Updated> <UpdatedBy>d225f41a-c036-4bf7-b94a-42077a4389e6</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "25769aed-dee2-46e6-a38b-40f4e568a9eb", "IndividualID": "66e97164-3a63-4f5e-9df7-d37004b7ad3d", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2025-10-01T11:30:02.3047303+00:00", "CreatedBy": "ebc679b2-f89a-48cd-b529-bb4a86b8d763", "Updated": "2025-10-01T11:30:02.3047303+00:00", "UpdatedBy": "d225f41a-c036-4bf7-b94a-42077a4389e6", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }