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>3fdec19a-4eb4-4767-ab14-e6cb3864fac5</ID> <IndividualID>9b171e8f-9ddd-4418-a8da-3c5af168e06f</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> </BasicRole>
{ "ID": "3fdec19a-4eb4-4767-ab14-e6cb3864fac5", "IndividualID": "9b171e8f-9ddd-4418-a8da-3c5af168e06f", "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>dfdd2002-866e-44f9-9ec2-6b0ce6bb1d08</ID> <IndividualID>ff7c48ce-3343-41d9-bf4a-afed8ece4dd3</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2025-08-29T07:05:25.7893912+00:00</Created> <CreatedBy>6a83e801-894c-4a6b-aad0-0879a23f05bd</CreatedBy> <Updated>2025-08-29T07:05:25.7893912+00:00</Updated> <UpdatedBy>6649d88a-27ca-4754-82c7-63a225e57945</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "dfdd2002-866e-44f9-9ec2-6b0ce6bb1d08", "IndividualID": "ff7c48ce-3343-41d9-bf4a-afed8ece4dd3", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2025-08-29T07:05:25.7893912+00:00", "CreatedBy": "6a83e801-894c-4a6b-aad0-0879a23f05bd", "Updated": "2025-08-29T07:05:25.7893912+00:00", "UpdatedBy": "6649d88a-27ca-4754-82c7-63a225e57945", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }