Create an individual's basic role.
None.
This object takes all the parameters needed to create a new 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>9e3a3185-0ec3-42e8-86e3-6db332310cb3</ID> <IndividualID>e747f56d-77e5-4982-a509-676880cc72fd</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> </BasicRole>
{ "ID": "9e3a3185-0ec3-42e8-86e3-6db332310cb3", "IndividualID": "e747f56d-77e5-4982-a509-676880cc72fd", "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>51d97478-4048-41ee-a184-9c4409b72f26</ID> <IndividualID>b8101a6a-531b-44c3-b909-4e85b1b274b4</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2025-10-21T08:43:38.4021483+00:00</Created> <CreatedBy>25ff4b63-120e-4ad4-83bc-2223a25738e3</CreatedBy> <Updated>2025-10-21T08:43:38.4021483+00:00</Updated> <UpdatedBy>07b40861-35a1-407d-8a9a-72f66078a8fc</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "51d97478-4048-41ee-a184-9c4409b72f26", "IndividualID": "b8101a6a-531b-44c3-b909-4e85b1b274b4", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2025-10-21T08:43:38.4021483+00:00", "CreatedBy": "25ff4b63-120e-4ad4-83bc-2223a25738e3", "Updated": "2025-10-21T08:43:38.4021483+00:00", "UpdatedBy": "07b40861-35a1-407d-8a9a-72f66078a8fc", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }