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>b265e02e-fafd-46f6-97e8-3b03f515acec</ID> <IndividualID>01381218-a680-4522-8b01-3dc99b4bac69</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> </BasicRole>
{ "ID": "b265e02e-fafd-46f6-97e8-3b03f515acec", "IndividualID": "01381218-a680-4522-8b01-3dc99b4bac69", "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>452b3804-9d9a-4d28-9872-da189c4fa724</ID> <IndividualID>dca475f9-7cdc-44f4-8e2b-59d973dd3255</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2025-07-15T16:49:08.9714055+00:00</Created> <CreatedBy>f1bb47f1-b830-41be-b19d-ec90ce621b62</CreatedBy> <Updated>2025-07-15T16:49:08.9714055+00:00</Updated> <UpdatedBy>3d41f40b-c80d-499b-8f0e-962ac6bca011</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "452b3804-9d9a-4d28-9872-da189c4fa724", "IndividualID": "dca475f9-7cdc-44f4-8e2b-59d973dd3255", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2025-07-15T16:49:08.9714055+00:00", "CreatedBy": "f1bb47f1-b830-41be-b19d-ec90ce621b62", "Updated": "2025-07-15T16:49:08.9714055+00:00", "UpdatedBy": "3d41f40b-c80d-499b-8f0e-962ac6bca011", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }